Extends | |
---|---|
JSComponent |
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 | className The bean class name. |
Boolean | enabled The enable state of the component, default true. |
Number | formIndex The Z index of this component. |
String | groupID A String representing a group ID for this component. |
Number | height The height in pixels of the component. |
String | name The name of the component. |
Boolean | printable Flag that tells if the component should be printed or not when the form is printed. |
Boolean | visible The visible property of the component, default true. |
Number | width The width in pixels of the component. |
Number | x The x coordinate of the component on the form. |
Number | y The y coordinate of the component on the form. |
Method Summary | |
---|---|
Object | getDesignTimeProperty() Get a design-time property of an element. |
String[] | getDesignTimePropertyNames() Get the design-time properties of an element. |
UUID | getUUID() Returns the UUID of this component. |
Object | putDesignTimeProperty() Set a design-time property of an element. |
Object | removeDesignTimeProperty() Clear a design-time property of an element. |
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 |
|
Sample var form = solutionModel.newForm('mediaForm', 'db:/example_data/parent_table', null, false, 400, 300); var strechAllDirectionsLabel = form.newLabel('Strech all directions', 10, 10, 380, 280); strechAllDirectionsLabel.background = 'red'; strechAllDirectionsLabel.anchors = SM_ANCHOR.ALL; var strechVerticallyLabel = form.newLabel('Strech vertically', 10, 10, 190, 280); strechVerticallyLabel.background = 'green'; strechVerticallyLabel.anchors = SM_ANCHOR.WEST | SM_ANCHOR.NORTH | SM_ANCHOR.SOUTH; var strechHorizontallyLabel = form.newLabel('Strech horizontally', 10, 10, 380, 140); strechHorizontallyLabel.background = 'blue'; strechHorizontallyLabel.anchors = SM_ANCHOR.NORTH | SM_ANCHOR.WEST | SM_ANCHOR.EAST; var stickToTopLeftCornerLabel = form.newLabel('Stick to top-left corner', 10, 10, 200, 100); stickToTopLeftCornerLabel.background = 'orange'; stickToTopLeftCornerLabel.anchors = SM_ANCHOR.NORTH | SM_ANCHOR.WEST; // This is equivalent to SM_ANCHOR.DEFAULT var stickToBottomRightCornerLabel = form.newLabel('Stick to bottom-right corner', 190, 190, 200, 100); stickToBottomRightCornerLabel.background = 'pink'; stickToBottomRightCornerLabel.anchors = SM_ANCHOR.SOUTH | SM_ANCHOR.EAST; |
|
className |
|
The bean class name.
|
|
Returns |
|
Sample var bean = form.getBean('mybean'); application.output(bean.className); |
|
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; |
|
formIndex |
|
The Z index of this component. If two components overlap,
then the component with higher Z index is displayed above the component with lower Z index. |
|
Returns |
|
Sample var labelBelow = form.newLabel('Green', 10, 10, 100, 50); labelBelow.background = 'green'; labelBelow.formIndex = 10; var fieldAbove = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 30); fieldAbove.background = '#FF0000'; fieldAbove.formIndex = 20; |
|
groupID |
|
A String representing a group ID for this component. If several
components have the same group ID then they belong to the same group of components. Using the group itself, all components can be disabled/enabled or made invisible/visible. The group id should be a javascript compatible identifier to allow access of the group in scripting. |
|
Returns |
|
Sample var form = solutionModel.newForm('someForm', 'db:/example_data/parent_table', null, false, 400, 300); var label = form.newLabel('Green', 10, 10, 100, 20); var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 40, 100, 20); label.groupID = 'someGroup'; field.groupID = 'someGroup'; forms['someForm'].elements.someGroup.enabled = false; |
|
height |
|
The height in pixels of the component.
|
|
Returns |
|
Sample var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20); application.output('original width: ' + field.width); application.output('original height: ' + field.height); field.width = 200; field.height = 100; application.output('modified width: ' + field.width); application.output('modified height: ' + field.height); |
|
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'; |
|
printable |
|
Flag that tells if the component should be printed or not when the form is printed. By default components are printable. |
|
Returns |
|
Sample var form = solutionModel.newForm('printForm', 'db:/example_data/parent_table', null, false, 400, 300); var printedField = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20); var notPrintedField = form.newField('parent_table_id', JSField.TEXT_FIELD, 10, 40, 100, 20); notPrintedField.printable = false; // This field won't show up in print preview and won't be printed. forms['printForm'].controller.showPrintPreview() |
|
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; |
|
width |
|
The width in pixels of the component.
|
|
Returns |
|
Sample var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20); application.output('original width: ' + field.width); application.output('original height: ' + field.height); field.width = 200; field.height = 100; application.output('modified width: ' + field.width); application.output('modified height: ' + field.height); |
|
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); |
|
Method Details | |
---|---|
getDesignTimeProperty |
|
Object getDesignTimeProperty () | |
Get a design-time property of an element.
|
|
Returns |
|
Sample var frm = solutionModel.getForm('orders') var fld = frm.getField('fld') var prop = fld.getDesignTimeProperty('myprop') |
|
getDesignTimePropertyNames |
|
String[] getDesignTimePropertyNames () | |
Get the design-time properties of an element.
|
|
Returns String[]
|
|
Sample var frm = solutionModel.getForm('orders') var fld = frm.getField('fld') var propNames = fld.getDesignTimePropertyNames() |
|
getUUID |
|
UUID getUUID () | |
Returns the UUID of this component.
|
|
Returns |
|
Sample var button_uuid = solutionModel.getForm("my_form").getButton("my_button").getUUID(); application.output(button_uuid.toString()); |
|
putDesignTimeProperty |
|
Object putDesignTimeProperty () | |
Set a design-time property of an element.
|
|
Returns |
|
Sample var frm = solutionModel.getForm('orders') var fld = frm.getField('fld') fld.putDesignTimeProperty('myprop', 'strawberry') |
|
removeDesignTimeProperty |
|
Object removeDesignTimeProperty () | |
Clear a design-time property of an element.
|
|
Returns |
|
Sample var frm = solutionModel.getForm('orders') var fld = frm.getField('fld') fld.removeDesignTimeProperty('myprop') |
|