Skip to content
This repository has been archived by the owner on Mar 25, 2022. It is now read-only.

Latest commit

 

History

History
60 lines (38 loc) · 2.1 KB

src-exo-controls_ExoControlBase.md

File metadata and controls

60 lines (38 loc) · 2.1 KB

Module exo/controls/ExoControlBase

category:other

Source file

Class ExoControlBase

Abstract base class for XO form controls

Methods

updateSchema()

modifier: private

Rerenders the control with the given field schema and returns a reference to the updated control.


mapAcceptedProperties()

modifier: private

Applies the accepted field schema values to properties Use acceptProperties() to define which properties to map.


showHelp(msg, options)

modifier: private

Displays a help text to the user. Pass with empty @msg to hide.

Parameters Type Description
msg String The message to display
options Object *The options (type: "info

Members

Name Type Description
jsonSchema undefined Gets the control properties as a JSON schema
cssVariables undefined Returns a reference to the CSS variables included
hasValue undefined Returns true if the control manipulates/returns a value
htmlElement undefined Sets the HTML element
useContainer undefined *Specifies whether XO form should use a containing DIV element to render the control.
By default for instance, the button and the page control don't use a container.*
caption undefined The control's caption/label
schema undefined Gets the current field schema
caption undefined The control's caption/label
dataBinding undefined Returns a reference to the data binding context. Can be the parent control's databinding context.
rulesEngine undefined Gets the attached rules engine
parentControl undefined Returns the parent control, when rendered as a single field in a context of another control, such as a group.