Event Summery | |
---|---|
#onAction The method that is executed when the component is clicked. |
|
Boolean | #onDataChange Method that is executed when the data in the component is successfully changed. |
Boolean | #onFocusGained The method that is executed when the component gains focus. |
Boolean | #onFocusLost The method that is executed when the component looses focus. |
#onRightClick The method that is executed when the component is right clicked. |
Property Summery | |
---|---|
Number | #anchors Enables a component to stick to a specific side of form and/or to grow or shrink when a window is resized. |
String | #background The background color of the component. |
String | #borderType The type, color and style of border of the component. |
String | #dataProvider The dataprovider of the component. |
Number | #displayType The type of display used by the field. |
Boolean | #displaysTags Flag that enables or disables merging of data inside components using tags (placeholders). |
Boolean | #editable Flag that tells if the content of the field can be edited or not. |
String | #fontType The font type of the component. |
String | #foreground The foreground color of the component. |
String | #format The format that should be applied when displaying the data in the component. |
Number | #horizontalAlignment Horizontal alignment of the text inside the component. |
String | #location The x and y position of the component, in pixels, separated by a comma. |
String | #margin The margins of the component. |
String | #name The name of the component. |
Number | #printSliding Enables an element to resize based on its content and/or move when printing. |
Boolean | #printable Flag that tells if the component should be printed or not when the form is printed. |
Number | #scrollbars Scrollbar options for the vertical and horizontal scrollbars. |
Boolean | #selectOnEnter Flag that tells if the content of the field should be automatically selected when the field receives focus. |
String | #size The width and height (in pixels), separated by a comma. |
String | #styleClass The name of the style class that should be applied to this component. |
Number | #tabSeq An index that specifies the position of the component in the tab sequence. |
String | #text The text that is displayed in the column header associated with the component when the form is in table view. |
String | #toolTipText The text displayed when hovering over the component with a mouse cursor. |
Boolean | #transparent Flag that tells if the component is transparent or not. |
Number | #valuelist The valuelist that is used by this field when displaying data. |
Event Details |
---|
onAction |
The method that is executed when the component is clicked. |
onDataChange |
Method that is executed when the data in the component is successfully changed. |
Parameters {JSEvent} event – the event that triggered the action |
Returns Boolean |
onFocusGained |
The method that is executed when the component gains focus. NOTE: Do not call methods that will influence the focus itself. |
Parameters {JSEvent} event – the event that triggered the action |
Returns Boolean |
onFocusLost |
The method that is executed when the component looses focus. |
Parameters {JSEvent} event – the event that triggered the action |
Returns Boolean |
onRightClick |
The method that is executed when the component is right clicked. |
Property Details |
---|
anchors |
Enables a component to stick to a specific side of form and/or to If opposite anchors are activated then the component with grow or If opposite anchors are not activated, then the component will |
Returns Number |
background |
The background color of the component. |
Returns String |
borderType |
The type, color and style of border of the component. |
Returns String |
dataProvider |
The dataprovider of the component. |
Returns String |
displayType |
The type of display used by the field. Can be one of CALENDAR, CHECKS, COMBOBOX, HTML_AREA, IMAGE_MEDIA, PASSWORD, RADIOS, RTF_AREA, TEXT_AREA, TEXT_FIELD or TYPE_AHEAD. |
Returns Number |
displaysTags |
Flag that enables or disables merging of data inside components using tags (placeholders). See the "Merging data" section for more details about tags. The default value of this flag is "false", that is merging of data is disabled by default. |
Returns Boolean |
editable |
Flag that tells if the content of the field can be edited or not. The default value of this flag is "true", that is the content can be edited. |
Returns Boolean |
fontType |
The font type of the component. |
Returns String |
foreground |
The foreground color of the component. |
Returns String |
format |
The format that should be applied when displaying the data in the component. Some examples are "#%", "dd-MM-yyyy", "MM-dd-yyyy", etc. |
Returns String |
horizontalAlignment |
Horizontal alignment of the text inside the component. Can be one of Note that this property does not refer to the horizontal alignment |
Returns Number |
location |
The x and y position of the component, in pixels, separated by a comma. |
Returns String |
margin |
The margins of the component. They are specified in this order, separated by commas: top, right, bottom, left. |
Returns String |
name |
The name of the component. Through this name it can also accessed in methods. |
Returns String |
printSliding |
Enables an element to resize based on its content and/or move when printing. The component can move horizontally or vertically and can grow or shrink in height and width, based on its content and the content of neighboring components. |
Returns Number |
printable |
Flag that tells if the component should be printed or not when the form is printed. By default components are printable. |
Returns Boolean |
scrollbars |
Scrollbar options for the vertical and horizontal scrollbars. Each of the vertical and horizontal scrollbars can be configured to display all the time, to display only when needed or to never display. |
Returns Number |
selectOnEnter |
Flag that tells if the content of the field should be automatically selected when the field receives focus. The default value of this field is "false". |
Returns Boolean |
size |
The width and height (in pixels), separated by a comma. |
Returns String |
styleClass |
The name of the style class that should be applied to this component. When defining style classes for specific component types, their names |
Returns String |
tabSeq |
An index that specifies the position of the component in the tab sequence. The components are put into the tab sequence in increasing order of this property. A value of 0 means to use the default mechanism of building the tab sequence (based on their location on the form). A value of -2 means to remove the component from the tab sequence. |
Returns Number |
text |
The text that is displayed in the column header associated with the component when the form is in table view. |
Returns String |
toolTipText |
The text displayed when hovering over the component with a mouse cursor. NOTE: |
Returns String |
transparent |
Flag that tells if the component is transparent or not. The default value is "false", that is the components |
Returns Boolean |
valuelist |
The valuelist that is used by this field when displaying data. Can be used with fields of type CHECKS, COMBOBOX, RADIOS and TYPE_AHEAD. |
Returns Number |