Skip to content

Class: BaseControl

BaseControl is the parent container control.

Hierarchy

Summary

Constructors

Properties

Class Properties

Inherited Properties

Accessors

Class Accessors

Inherited Accessors

Methods

Class Methods

Inherited Methods

Constructors

Constructor

+ new BaseControl(): BaseControl

Inherited from IControl.constructor

Returns: BaseControl

Properties

Protected _observable

• _observable: BaseObservable


Protected _parent

• _parent: IControl

Accessors

binding

Get Signature

▸ getter

Returns

any


isBindable

Get Signature

▸ getter

Returns

boolean


name

Get Signature

▸ getter

Returns

string


parent

Get Signature

▸ getter

Returns

IControl

Set Signature

▸ setter

Parameters
parent

IControl

Returns

void

Methods

bind

▸ bind(): Promise<any>

Returns: Promise<any>


Protected createObservable

▸ createObservable(): BaseObservable

Returns: BaseObservable


getContainer

▸ getContainer(): IControl

Returns: IControl


getNativeViewToAnchorToast

▸ getNativeViewToAnchorToast(): any

Returns: any


initialize

▸ initialize(controlData: IControlData): void

Called to initialize view. props object passed in containing all relevant properties and view's context.

Overrides IControl.initialize

Parameters:

Name Type
controlData IControlData

Returns: void


observable

▸ observable(): BaseObservable

Called by control factory to ask for a specific Observable implementation.

Overrides IControl.observable

Returns: BaseObservable

  • IObservable implementation.

onPageUnloaded

▸ onPageUnloaded(pageExists: boolean): void

Called when the parent page is unloaded.

Overrides IControl.onPageUnloaded

Parameters:

Name Type Description
pageExists boolean Whether or not the page still exists on the stack after unload

Returns: void


setContainer

▸ setContainer(container: IControl): void

Overrides IControl.setContainer

Parameters:

Name Type
container IControl

Returns: void


setValue

▸ setValue(value: any, notify: boolean, isTextValue?: boolean): Promise<any>

Sets the controls value. Abstract because each control must validate or throw the incoming value.

Parameters:

Name Type
value any
notify boolean
isTextValue? boolean

Returns: Promise<any>

Throws

if the value supplied doesn't work out!

Overrides IControl.setValue


setView

▸ setView(view: any): void

Parameters:

Name Type
view any

Returns: void


view

▸ view(): any

Called to retrieve the view to display.

Overrides IControl.view

Returns: any

  • View to display