Extends | |
---|---|
JSComponent |
Constants Summary | |
---|---|
String | ICON_ALERT Constant for specifying a predefined icon type for a button. |
String | ICON_BACK Constant for specifying a predefined icon type for a button. |
String | ICON_BARS Constant for specifying a predefined icon type for a button. |
String | ICON_CHECK Constant for specifying a predefined icon type for a button. |
String | ICON_DELETE Constant for specifying a predefined icon type for a button. |
String | ICON_DOWN Constant for specifying a predefined icon type for a button. |
String | ICON_EDIT Constant for specifying a predefined icon type for a button. |
String | ICON_FORWARD Constant for specifying a predefined icon type for a button. |
String | ICON_GEAR Constant for specifying a predefined icon type for a button. |
String | ICON_GRID Constant for specifying a predefined icon type for a button. |
String | ICON_HOME Constant for specifying a predefined icon type for a button. |
String | ICON_INFO Constant for specifying a predefined icon type for a button. |
String | ICON_LEFT Constant for specifying a predefined icon type for a button. |
String | ICON_MINUS Constant for specifying a predefined icon type for a button. |
String | ICON_PLUS Constant for specifying a predefined icon type for a button. |
String | ICON_REFRESH Constant for specifying a predefined icon type for a button. |
String | ICON_RIGHT Constant for specifying a predefined icon type for a button. |
String | ICON_SEARCH Constant for specifying a predefined icon type for a button. |
String | ICON_STAR Constant for specifying a predefined icon type for a button. |
String | ICON_UP Constant for specifying a predefined icon type for a button. |
Property Summary | |
---|---|
String | dataProviderID 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 | format The format that should be applied when displaying data(using dataProviderID) in the label/button. |
String | iconType Icon shown on a button. |
String | name The name of the component. |
JSMethod | onAction The method that is executed when the component is clicked. |
String | styleClass The name of the style class that should be applied to this component. |
String | text The text that is displayed inside the component. |
Boolean | visible The visible property of the component, default true. |
Number | x The x coordinate of the component on the form. |
Number | y The y coordinate of the component on the form. |
Constants Details | |
---|---|
ICON_ALERT |
|
Constant for specifying a predefined icon type for a button.
|
|
Returns |
|
Sample myButton.iconType = JSButton.ICON_...; |
|
ICON_BACK |
|
Constant for specifying a predefined icon type for a button.
|
|
Returns |
|
Sample myButton.iconType = JSButton.ICON_...; |
|
ICON_BARS |
|
Constant for specifying a predefined icon type for a button.
|
|
Returns |
|
Sample myButton.iconType = JSButton.ICON_...; |
|
ICON_CHECK |
|
Constant for specifying a predefined icon type for a button.
|
|
Returns |
|
Sample myButton.iconType = JSButton.ICON_...; |
|
ICON_DELETE |
|
Constant for specifying a predefined icon type for a button.
|
|
Returns |
|
Sample myButton.iconType = JSButton.ICON_...; |
|
ICON_DOWN |
|
Constant for specifying a predefined icon type for a button.
|
|
Returns |
|
Sample myButton.iconType = JSButton.ICON_...; |
|
ICON_EDIT |
|
Constant for specifying a predefined icon type for a button.
|
|
Returns |
|
Sample myButton.iconType = JSButton.ICON_...; |
|
ICON_FORWARD |
|
Constant for specifying a predefined icon type for a button.
|
|
Returns |
|
Sample myButton.iconType = JSButton.ICON_...; |
|
ICON_GEAR |
|
Constant for specifying a predefined icon type for a button.
|
|
Returns |
|
Sample myButton.iconType = JSButton.ICON_...; |
|
ICON_GRID |
|
Constant for specifying a predefined icon type for a button.
|
|
Returns |
|
Sample myButton.iconType = JSButton.ICON_...; |
|
ICON_HOME |
|
Constant for specifying a predefined icon type for a button.
|
|
Returns |
|
Sample myButton.iconType = JSButton.ICON_...; |
|
ICON_INFO |
|
Constant for specifying a predefined icon type for a button.
|
|
Returns |
|
Sample myButton.iconType = JSButton.ICON_...; |
|
ICON_LEFT |
|
Constant for specifying a predefined icon type for a button.
|
|
Returns |
|
Sample myButton.iconType = JSButton.ICON_...; |
|
ICON_MINUS |
|
Constant for specifying a predefined icon type for a button.
|
|
Returns |
|
Sample myButton.iconType = JSButton.ICON_...; |
|
ICON_PLUS |
|
Constant for specifying a predefined icon type for a button.
|
|
Returns |
|
Sample myButton.iconType = JSButton.ICON_...; |
|
ICON_REFRESH |
|
Constant for specifying a predefined icon type for a button.
|
|
Returns |
|
Sample myButton.iconType = JSButton.ICON_...; |
|
ICON_RIGHT |
|
Constant for specifying a predefined icon type for a button.
|
|
Returns |
|
Sample myButton.iconType = JSButton.ICON_...; |
|
ICON_SEARCH |
|
Constant for specifying a predefined icon type for a button.
|
|
Returns |
|
Sample myButton.iconType = JSButton.ICON_...; |
|
ICON_STAR |
|
Constant for specifying a predefined icon type for a button.
|
|
Returns |
|
Sample myButton.iconType = JSButton.ICON_...; |
|
ICON_UP |
|
Constant for specifying a predefined icon type for a button.
|
|
Returns |
|
Sample myButton.iconType = JSButton.ICON_...; |
|
Property Details | |
---|---|
dataProviderID |
|
The dataprovider of the component.
|
|
Returns |
|
Sample // Normally the dataprovider is specified when a component is created. var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 40, 100, 20); // But it can be modified later if needed. field.dataProviderID = 'parent_table_id'; |
|
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 |
|
Sample var label = form.newLabel('You are viewing record no. %%parent_table_id%%. You are running on server %%serverURL%%.', 10, 10, 600, 100); label.displaysTags = true; |
|
enabled |
|
The enable state of the component, default true.
|
|
Returns |
|
Sample var form = solutionModel.newForm('printForm', 'db:/example_data/parent_table', null, false, 400, 300); var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20); field.enabled = false; |
|
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 |
|
Sample var label = form.newLabel('', 10, 10, 100, 100); label.format = '$#.00'; |
|
iconType |
|
Icon shown on a button.
|
|
Returns |
|
Sample var btn = form.newButton('I am a button', 1, null); btn.iconType = JSButton.ICON_STAR |
|
name |
|
The name of the component. Through this name it can also accessed in methods.
|
|
Returns |
|
Sample var form = solutionModel.newForm('someForm', 'db:/example_data/parent_table', null, false, 620, 300); var label = form.newLabel('Label', 10, 10, 150, 150); label.name = 'myLabel'; // Give a name to the component. forms['someForm'].controller.show() // Now use the name to access the component. forms['someForm'].elements['myLabel'].text = 'Updated text'; |
|
onAction |
|
The method that is executed when the component is clicked.
|
|
Returns |
|
Sample var doNothingMethod = form.newMethod('function doNothing() { application.output("Doing nothing."); }'); var onClickMethod = form.newMethod('function onClick(event) { application.output("I was clicked at " + event.getTimestamp()); }'); var onDoubleClickMethod = form.newMethod('function onDoubleClick(event) { application.output("I was double-clicked at " + event.getTimestamp()); }'); var onRightClickMethod = form.newMethod('function onRightClick(event) { application.output("I was right-clicked at " + event.getTimestamp()); }'); // At creation the button has the 'doNothing' method as onClick handler, but we'll change that later. var btn = form.newButton('I am a button', 10, 40, 200, 20, doNothingMethod); btn.onAction = onClickMethod; btn.onDoubleClick = onDoubleClickMethod; btn.onRightClick = onRightClickMethod; |
|
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 |
|
Sample var form = solutionModel.newForm('printForm', 'db:/example_data/parent_table', null, false, 400, 300); var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20); var style = solutionModel.newStyle('myStyle','field.fancy { background-color: yellow; }'); form.styleName = 'myStyle'; // First set the style on the form. field.styleClass = 'fancy'; // Then set the style class on the field. |
|
text |
|
The text that is displayed inside the component.
|
|
Returns |
|
Sample // In general the text is specified when creating the component. var label = form.newLabel('Initial text', 10, 10, 100, 20); // But it can be changed later if needed. label.text = 'Changed text'; |
|
visible |
|
The visible property of the component, default true.
|
|
Returns |
|
Sample var form = solutionModel.newForm('printForm', 'db:/example_data/parent_table', null, false, 400, 300); var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20); field.visible = false; |
|
x |
|
The x coordinate of the component on the form.
|
|
Returns |
|
Sample var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20); application.output('original location: ' + field.x + ', ' + field.y); field.x = 90; field.y = 90; application.output('changed location: ' + field.x + ', ' + field.y); |
|
y |
|
The y coordinate of the component on the form.
|
|
Returns |
|
Sample var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20); application.output('original location: ' + field.x + ', ' + field.y); field.x = 90; field.y = 90; application.output('changed location: ' + field.x + ', ' + field.y); |
|