Class: BaseControl

Hierarchy

• IControl

• BaseControl

Summary

Properties

• _observable
• _parent
• _props
• context

Accessors

• binding
• builder
• controlProxy
• isBindable
• isControl
• isFormCell
• parent
• type

Methods

• androidContext
• bind
• container
• createObservable
• definition
• executeAction
• executeActionOrRule
• formatRule
• getContainer
• getValue
• initialize
• observable
• onDataChanged
• onDismissingModal
• onDisplayingModal
• onNavigatedFrom
• onNavigatedTo
• onNavigatingFrom
• onNavigatingTo
• onPageLoaded
• onPageUnloaded
• onPress
• page
• pageFrameId
• redraw
• setContainer
• setStyle
• setValidationProperty
• setValue
• setView
• valueResolver
• view
• viewIsNative

Properties

Protected _observable

• _observable: BaseObservable

---

Protected _parent

• _parent: IControl

The parent container control

---

Protected _props

• _props: any

Inherited from IView._props

---

context

• context: IContext

Inherited from IView.context

Accessors

binding

• get binding(): any

Returns: any

---

builder

• get builder(): IBuilder

Inherited from IControl.builder

Returns: IBuilder

---

controlProxy

• get controlProxy(): IControlProxy

Inherited from IControl.controlProxy

Get the ControlProxy associated with this control.

Returns: IControlProxy

---

isBindable

• get isBindable(): boolean

Returns: boolean

---

isControl

• get isControl(): boolean

Inherited from IControl.isControl

Returns: boolean

---

isFormCell

• get isFormCell(): boolean

Inherited from IControl.isFormCell

Returns: boolean

---

parent

• get parent(): IControl

Returns: IControl

• set parent(parent: IControl): void

Parameters:

Name	Type
parent	IControl

Returns: void

---

type

• get type(): string

Inherited from IControl.type

Returns: string

Methods

androidContext

▸ androidContext(): any

Inherited from IView.androidContext

Called to get the android.content.Context object necessary to create view objects.

Returns: any

---

bind

▸ bind(): Promise‹any›

Returns: Promise‹any›

---

container

▸ container(): ContainerDefinition

Inherited from IControl.container

Getter for the container.

Returns: ContainerDefinition

The control's container.

---

Protected createObservable

▸ createObservable(): BaseObservable

Returns: BaseObservable

---

definition

▸ definition(): any

Inherited from IView.definition

Getter for the view's definition.

Returns: any

The view's definition.

---

Protected executeAction

▸ executeAction(actionOrRulePath: any): Promise‹any›

Inherited from IView.executeAction

deprecated - use executeActionOrRule

Parameters:

Name	Type
actionOrRulePath	any

Returns: Promise‹any›

---

Protected executeActionOrRule

▸ executeActionOrRule(actionOrRulePath: any): Promise‹any›

Inherited from IView.executeActionOrRule

Called to excecute action or rule from control.

Parameters:

Name	Type
actionOrRulePath	any

Returns: Promise‹any›

action or rule reference

---

formatRule

▸ formatRule(): any

Inherited from IControl.formatRule

Getter for the control format rule, if any.

Returns: any

The control's format rule path.

---

getContainer

▸ getContainer(): IControl

Returns: IControl

---

getValue

▸ getValue(): any

Inherited from IControl.getValue

Called to get the control value from the observable.

Returns: any

The control's value.

---

initialize

▸ initialize(controlData: IControlData): void

Overrides IView.initialize

Parameters:

Name	Type
controlData	IControlData

Returns: void

---

observable

▸ observable(): BaseObservable

Overrides IControl.observable

Returns: BaseObservable

---

onDataChanged

▸ onDataChanged(action: any, result: any): void

Inherited from IControl.onDataChanged

Parameters:

Name	Type
action	any
result	any

Returns: void

---

onDismissingModal

▸ onDismissingModal(): void

Inherited from IView.onDismissingModal

Returns: void

---

onDisplayingModal

▸ onDisplayingModal(isFullPage: boolean): void

Inherited from IView.onDisplayingModal

Parameters:

Name	Type
isFullPage	boolean

Returns: void

---

onNavigatedFrom

▸ onNavigatedFrom(pageExists: boolean): void

Inherited from IView.onNavigatedFrom

Parameters:

Name	Type
pageExists	boolean

Returns: void

---

onNavigatedTo

▸ onNavigatedTo(initialLoading: boolean): void

Inherited from IView.onNavigatedTo

Parameters:

Name	Type
initialLoading	boolean

Returns: void

---

onNavigatingFrom

▸ onNavigatingFrom(pageExists: boolean): void

Inherited from IView.onNavigatingFrom

Parameters:

Name	Type
pageExists	boolean

Returns: void

---

onNavigatingTo

▸ onNavigatingTo(initialLoading: boolean): void

Inherited from IView.onNavigatingTo

Parameters:

Name	Type
initialLoading	boolean

Returns: void

---

onPageLoaded

▸ onPageLoaded(initialLoading: boolean): void

Inherited from IView.onPageLoaded

Called when parent page is being loaded.

Parameters:

Name	Type	Description
initialLoading	boolean	Whether or not it is being loaded for the first time

Returns: void

---

onPageUnloaded

▸ onPageUnloaded(pageExists: boolean): void

Overrides IView.onPageUnloaded

Parameters:

Name	Type
pageExists	boolean

Returns: void

---

onPress

▸ onPress(...args: any[]): void

Inherited from IView.onPress

Parameters:

Name	Type
...args	any[]

Returns: void

---

page

▸ page(): any

Inherited from IControl.page

Getter for the Page the control resides on.

Returns: any

The control's page.

---

pageFrameId

▸ pageFrameId(): any

Inherited from IControl.pageFrameId

Getter for the Page the control resides on.

Returns: any

The control's page.

---

redraw

▸ redraw(): void

Inherited from IControl.redraw

Called to refresh the control

Returns: void

---

setContainer

▸ setContainer(container: IControl): void

Overrides IControl.setContainer

Parameters:

Name	Type
container	IControl

Returns: void

---

setStyle

▸ setStyle(cssClassName?: string): void

Inherited from IControl.setStyle

Overrides IView.setStyle

Called to tell the control to set its styles.

Parameters:

Name	Type
cssClassName?	string

Returns: void

---

setValidationProperty

▸ setValidationProperty(key: string, value: any): void

Inherited from IControl.setValidationProperty

Called to set the propertis of the validation view

Parameters:

Name	Type	Description
key	string	The validation property's key
value	any	The value

Returns: void

---

setValue

▸ setValue(value: any, notify: boolean, isTextValue?: boolean): Promise‹any›

Overrides IControl.setValue

Parameters:

Name	Type
value	any
notify	boolean
isTextValue?	boolean

Returns: Promise‹any›

---

setView

▸ setView(view: any): void

Parameters:

Name	Type
view	any

Returns: void

---

valueResolver

▸ valueResolver(): ValueResolver

Inherited from IView.valueResolver

Getter for the value resolver.

Returns: ValueResolver

The value resolver.

---

view

▸ view(): any

Overrides IView.view

Returns: any

---

viewIsNative

▸ viewIsNative(): boolean

Inherited from IControl.viewIsNative

Overrides IView.viewIsNative

Called to find out if the view is implemented in a native plugin. If the view is a custom native view, this needs to be overriden and set to true so it can be correctly added to our layout.

Returns: boolean

• true if it is a custom native view, false if not.