Class: IControl

Hierarchy

• IView

• IControl

• BaseControl

Summary

Properties

Class Properties

Currently none in this class.

Inherited Properties

• _props

• context

Accessors

Class Accessors

• builder
• controlProxy
• isControl
• isFormCell
• type

Inherited Accessors

Currently none inherited from the parent class(es).

Methods

Class Methods

• container
• formatRule
• getValue
• observable
• onDataChanged
• page
• pageFrameId
• redraw
• setContainer
• setStyle
• setValidationProperty
• setValue
• viewIsNative

Inherited Methods

• androidContext

• definition

• destroy

• executeAction

• executeActionOrRule

• initialize

• onDismissingModal

• onDisplayingModal

• onNavigatedFrom

• onNavigatedTo

• onNavigatingFrom

• onNavigatingTo

• onPageLoaded

• onPageUnloaded

• onPress

• valueResolver

• view

Accessors

builder

• getter

Returns: IBuilder

---

controlProxy

• getter

Get the ControlProxy associated with this control.

Returns: IControlProxy

---

isControl

• getter

Returns: boolean

---

isFormCell

• getter

Returns: boolean

---

type

• getter

Returns: string

Methods

container

▸ container(): ContainerDefinition

Getter for the container.

Returns: ContainerDefinition

The control's container.

---

formatRule

▸ formatRule(): any

Getter for the control format rule, if any.

Returns: any

The control's format rule path.

---

getValue

▸ getValue(): any

Called to get the control value from the observable.

Returns: any

The control's value.

---

Abstract observable

▸ observable(): IObservable

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

Returns: IObservable

• IObservable implementation.

---

onDataChanged

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

Parameters:

Name	Type
action	any
result	any

Returns: void

---

page

▸ page(): any

Getter for the Page the control resides on.

Returns: any

The control's page.

---

pageFrameId

▸ pageFrameId(): any

Getter for the Page the control resides on.

Returns: any

The control's page.

---

redraw

▸ redraw(): void

Called to refresh the control

Returns: void

---

Abstract setContainer

▸ setContainer(container: IControl): any

Parameters:

Name	Type
container	IControl

Returns: any

---

setStyle

▸ setStyle(cssClassName?: string): void

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

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

---

Abstract 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.

throws if the value supplied doesn't work out!

Parameters:

Name	Type
value	any
notify	boolean
isTextValue?	boolean

Returns: Promise‹any›

---

viewIsNative

▸ viewIsNative(): boolean

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.