Event Summary | |
---|---|
#onAction The method that is executed when the component is clicked. |
|
#onDoubleClick The method that is executed when the component is double clicked. |
|
#onRender The method that is executed when the component is rendered. |
|
#onRightClick The method that is executed when the component is right clicked. |
Property Summary | |
---|---|
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. |
Boolean | #displaysTags Flag that enables or disables merging of data inside components using tags (placeholders). |
Boolean | #enabled The enable state of the component, default true. |
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 data(using dataProviderID) in the label/button. |
Number | #horizontalAlignment Horizontal alignment of the text inside the component. |
Number | #imageMedia The image Media object that should be displayed inside the component. |
String | #labelFor Some components can be set to be labels of other components. |
String | #location The x and y position of the component, in pixels, separated by a comma. |
String | #margin The margins of the component. |
Number | #mediaOptions Options to scale the image Media object that is displayed inside the component. |
String | #mnemonic The keyboard shortcut that activates this 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 | #rolloverCursor The cursor that is shown as the mouse is rolled over the component. |
Number | #rolloverImageMedia The roll over image Media object used. |
Boolean | #showClick When set, the element will show the clicked state when selected. |
Boolean | #showFocus When set the text of an element will showfocus when selected. |
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 inside the component. |
Number | #textRotation The rotation of the element. |
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 | #verticalAlignment The vertical alignment of the text inside the component. |
Boolean | #visible The visible property of the component, default true. |
Event Details |
---|
onAction |
The method that is executed when the component is clicked.
|
onDoubleClick |
The method that is executed when the component is double clicked.
|
Parameters {JSEvent} event – the event that triggered the action
|
onRender |
The method that is executed when the component is rendered.
|
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 |
background |
The background color of the component.
|
Returns |
borderType |
The type, color and style of border of the component.
|
Returns |
dataProvider |
The dataprovider of the component.
|
Returns |
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 |
enabled |
The enable state of the component, default true.
|
Returns Boolean – enabled state
|
fontType |
The font type of the component.
|
Returns |
foreground |
The foreground color of the component.
|
Returns |
format |
The format that should be applied when displaying data(using dataProviderID) in the label/button.
Some examples are "#%", "dd-MM-yyyy", "MM-dd-yyyy", etc. |
Returns |
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 |
imageMedia |
The image Media object that should be displayed inside the component.
|
Returns |
labelFor |
Some components can be set to be labels of other components. This is useful in
two situations. In table view mode it is used for constructing the header of the table. In record view mode, by setting mnemonics on the label, keyboard shortcuts can be used to set the focus to fields. |
Returns |
location |
The x and y position of the component, in pixels, separated by a comma.
|
Returns |
margin |
The margins of the component. They are specified in this order,
separated by commas: top, left, bottom, right. |
Returns |
mediaOptions |
Options to scale the image Media object that is displayed inside the component. REDUCE will scale down the image if the component is smaller than the image. ENLARGE will scale up the image if the component is larger than the image. CROP will leave the image at its original size. If the component is smaller than |
Returns |
mnemonic |
The keyboard shortcut that activates this component. A letter must be specified, This property can be used in two ways. Normally the keyboard shortcut activates |
Returns |
name |
The name of the component. Through this name it can also accessed in methods.
|
Returns |
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 |
printable |
Flag that tells if the component should be printed or not when the form is printed. By default components are printable. |
Returns |
rolloverCursor |
The cursor that is shown as the mouse is rolled over the component.
Possible options are DEFAULT and HAND. Note that roll over cursor is not supported in Smart client for list view and tableview forms. |
Returns |
rolloverImageMedia |
The roll over image Media object used. It will only work if a property image is also used.
When the mouse is moved over the component, this image Media will be displayed. When the mouse is moved out of the component, whatever text or image was being initially displayed will be restored. Note that roll over image is not supported in Smart client for list view and tableview forms. |
Returns |
showClick |
When set, the element will show the clicked state when selected.
Applies to labels and buttons and images only. |
Returns |
showFocus |
When set the text of an element will showfocus when selected. NOTE: The TAB key may also be used to select the element, depending |
Returns |
size |
The width and height (in pixels), separated by a comma.
|
Returns |
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 |
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 |
text |
The text that is displayed inside the component.
|
Returns |
textRotation |
The rotation of the element. You can choose 0, 90, 180, or 270 and the label is rotated accordingly.
This property also applies to buttons and images. |
Returns |
toolTipText |
The text displayed when hovering over the component with a mouse cursor. NOTE: |
Returns |
transparent |
Flag that tells if the component is transparent or not. The default value is "false", that is the components |
Returns |
verticalAlignment |
The vertical alignment of the text inside the component. Can be one of Note that this property does not refer to the vertical alignment of the |
Returns |
visible |
The visible property of the component, default true.
|
Returns Boolean – visible property
|