DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.
Enter additional information related to this 'class' inside the {div} macro with 'id=description'
Extends
{column:width=80px|padding=0px}{column}{column}{column}
Property Summary
background
The background color of the component.
borderType
The type, color and style of border of the component.
foreground
The foreground color of the component.
initialSort
The default sort order for the rows displayed in the portal.
onDragOver
The method that is triggered when (non Design Mode) dragging over a component occurs.
printSliding
Enables an element to resize based on its content and/or move when printing.
relationName
The name of the relationship between the table related to the currently active
form and the table you want to show data from in the portal.
reorderable
When set, the portal rows can be re-ordered by dragging the column headers.
scrollbars
Scrollbar options for the vertical and horizontal scrollbars.
showHorizontalLines
When set, the portal displays horizontal lines between the rows.
showVerticalLines
When set the portal displays vertical lines between the columns.
styleClass
The name of the style class that should be applied to this component.
transparent
Flag that tells if the component is transparent or not.
{column:width=80px|padding=0px}{column}{column}{column}
Method Summary
JSButton[]
getButtons()
Retrieves an array with all buttons in the portal.
getDesignTimeProperty()
Get a design-time property of an element.
getIntercellSpacing()
The additional spacing between cell rows.
newCalendar(dataprovider, x, width, height)
Creates a new calendar field in the portal.
newComboBox(dataprovider, x, width, height)
Creates a new combobox field in the portal.
newHtmlArea(dataprovider, x, width, height)
Creates a new HTML Area field in the portal.
newImageMedia(dataprovider, x, width, height)
Creates a new Image Media field in the portal.
newPassword(dataprovider, x, width, height)
Creates a new password field in the portal.
newRtfArea(dataprovider, x, width, height)
Creates a new RTF Area field in the portal.
newTextArea(dataprovider, x, width, height)
Creates a new text area field in the portal.
newTextField(dataprovider, x, width, height)
Creates a new text field in the portal.
newTypeAhead(dataprovider, x, width, height)
Creates a new type ahead field in the portal.
putDesignTimeProperty()
Set a design-time property of an element.
removeDesignTimeProperty()
Clear a design-time property of an element.
void
setIntercellSpacing(width, height)
The additional spacing between cell rows.
{column:width=100%|padding=0px}{column}
Property Details
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;
Sample
// This property can be used on all types of components. // Here it is illustrated only for labels and fields. var greenLabel = form.newLabel('Green',10,10,100,50); greenLabel.background = 'green'; // Use generic names for colors. var redField = form.newField('parent_table_text',JSField.TEXT_FIELD,10,110,100,30); redField.background = '#FF0000'; // Use RGB codes for colors.
Sample
//HINT: To know exactly the notation of this property set it in the designer and then read it once out through the solution model. var field = form.newField('my_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20); field.borderType = solutionModel.createLineBorder(1,'#ff0000');
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;
Sample
var label = form.newLabel('Text here', 10, 50, 100, 20); label.fontType = solutionModel.createFont('Times New Roman',1,14);
Sample
// This property can be used on all types of components. // Here it is illustrated only for labels and fields. var labelWithBlueText = form.newLabel('Blue text', 10, 10, 100, 30); labelWithBlueText.foreground = 'blue'; // Use generic names for colors. var fieldWithYellowText = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 50, 100, 20); fieldWithYellowText.foreground = '#FFFF00'; // Use RGB codes for colors.
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;
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;
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);
Sample
var childrenPortal = form.newPortal('pp',rel,10,10,620,460); childrenPortal.newTextField('child_table_id', 0, 100, 20); childrenPortal.newTextField('child_table_text',100,100,20); childrenPortal.newTextField('child_table_parent_id', 200, 100, 20); childrenPortal.initialSort = 'child_table_text desc';
Sample
var childrenPortal = form.newPortal('pp',rel,10,10,620,460); // Set the fields some distance apart horizontally. By default this distance // is ignored and the components are put in a grid. var idField = childrenPortal.newTextField('child_table_id', 0, 100, 20); idField.background = 'yellow'; var textField = childrenPortal.newTextField('child_table_text',150,100,20); textField.background = 'green'; var parentIdField = childrenPortal.newTextField('child_table_parent_id', 300, 100, 20); parentIdField.background = 'orange'; // Disable the grid placing of components, and make the distance between components // become active. childrenPortal.multiLine = true;
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';
Sample
form.onDrag = form.newMethod('function onDrag(event) { application.output("onDrag intercepted from " + event.getSource()); }'); form.onDragEnd = form.newMethod('function onDragEnd(event) { application.output("onDragEnd intercepted from " + event.getSource()); }'); form.onDragOver = form.newMethod('function onDragOver(event) { application.output("onDragOver intercepted from " + event.getSource()); }'); form.onDrop = form.newMethod('function onDrop(event) { application.output("onDrop intercepted from " + event.getSource()); }');
Sample
form.onDrag = form.newMethod('function onDrag(event) { application.output("onDrag intercepted from " + event.getSource()); }'); form.onDragEnd = form.newMethod('function onDragEnd(event) { application.output("onDragEnd intercepted from " + event.getSource()); }'); form.onDragOver = form.newMethod('function onDragOver(event) { application.output("onDragOver intercepted from " + event.getSource()); }'); form.onDrop = form.newMethod('function onDrop(event) { application.output("onDrop intercepted from " + event.getSource()); }');
Sample
form.onDrag = form.newMethod('function onDrag(event) { application.output("onDrag intercepted from " + event.getSource()); }'); form.onDragEnd = form.newMethod('function onDragEnd(event) { application.output("onDragEnd intercepted from " + event.getSource()); }'); form.onDragOver = form.newMethod('function onDragOver(event) { application.output("onDragOver intercepted from " + event.getSource()); }'); form.onDrop = form.newMethod('function onDrop(event) { application.output("onDrop intercepted from " + event.getSource()); }');
Sample
form.onDrag = form.newMethod('function onDrag(event) { application.output("onDrag intercepted from " + event.getSource()); }'); form.onDragEnd = form.newMethod('function onDragEnd(event) { application.output("onDragEnd intercepted from " + event.getSource()); }'); form.onDragOver = form.newMethod('function onDragOver(event) { application.output("onDragOver intercepted from " + event.getSource()); }'); form.onDrop = form.newMethod('function onDrop(event) { application.output("onDrop intercepted from " + event.getSource()); }');
Sample
portal.onRender = form.newMethod('function onRender(event) { event.getElement().bgcolor = \'#00ff00\' }');
Sample
var form = solutionModel.newForm('printForm', 'db:/example_data/parent_table', null, false, 400, 300); var slidingLabel = form.newLabel('Some long text here', 10, 10, 5, 5); slidingLabel.printSliding = SM_PRINT_SLIDING.GROW_HEIGHT | SM_PRINT_SLIDING.GROW_WIDTH; slidingLabel.background = 'gray'; forms['printForm'].controller.showPrintPreview();
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()
Sample
// Create the portal based on one relation. var childrenPortal = form.newPortal('pp', 'parent_to_child', 10, 10, 620, 460); var idField = childrenPortal.newTextField('child_table_id', 0, 100, 20); var textField = childrenPortal.newTextField('child_table_text',150,100,20); var parentIdField = childrenPortal.newTextField('child_table_parent_id', 300, 100, 20); // Now make the portal be based on another relation. childrenPortal.relationName = 'parent_to_smaller_children';
Sample
var childrenPortal = form.newPortal('pp', 'parent_to_child', 10, 10, 620, 460); childrenPortal.newTextField('child_table_id', 0, 100, 20); childrenPortal.newTextField('child_table_text',150,100,20); childrenPortal.newTextField('child_table_parent_id', 300, 100, 20); childrenPortal.reorderable = true;
Sample
var childrenPortal = form.newPortal('pp', 'parent_to_child', 10, 10, 620, 460); childrenPortal.newTextField('child_table_id', 0, 100, 20); childrenPortal.newTextField('child_table_text',150,100,20); childrenPortal.newTextField('child_table_parent_id', 300, 100, 20); // Make the columns resizable. By default they are not resizable. childrenPortal.resizable = true;
Sample
var childrenPortal = form.newPortal('pp', 'parent_to_child', 10, 10, 620, 460); childrenPortal.newTextField('child_table_id', 0, 100, 20); childrenPortal.newTextField('child_table_text',150,100,20); childrenPortal.newTextField('child_table_parent_id', 300, 100, 20); childrenPortal.rowHeight = 30;
Sample
var noScrollbars = form.newField('my_table_text', JSField.TEXT_AREA, 10, 10, 100, 100); noScrollbars.scrollbars = SM_SCROLLBAR.HORIZONTAL_SCROLLBAR_NEVER | SM_SCROLLBAR.VERTICAL_SCROLLBAR_NEVER; var neededScrollbars = form.newField('my_table_text', JSField.TEXT_AREA, 120, 10, 100, 100); neededScrollbars.scrollbars = SM_SCROLLBAR.HORIZONTAL_SCROLLBAR_AS_NEEDED | SM_SCROLLBAR.VERTICAL_SCROLLBAR_AS_NEEDED; var alwaysScrollbars = form.newField('my_table_text', JSField.TEXT_AREA, 230, 10, 100, 100); alwaysScrollbars.scrollbars = SM_SCROLLBAR.HORIZONTAL_SCROLLBAR_ALWAYS | SM_SCROLLBAR.VERTICAL_SCROLLBAR_ALWAYS;
Sample
var childrenPortal = form.newPortal('pp', 'parent_to_child', 10, 10, 620, 460); childrenPortal.newTextField('child_table_id', 0, 100, 20); childrenPortal.newTextField('child_table_text',150,100,20); childrenPortal.newTextField('child_table_parent_id', 300, 100, 20); childrenPortal.showHorizontalLines = true; childrenPortal.showVerticalLines = true;
Sample
var childrenPortal = form.newPortal('pp', 'parent_to_child', 10, 10, 620, 460); childrenPortal.newTextField('child_table_id', 0, 100, 20); childrenPortal.newTextField('child_table_text',150,100,20); childrenPortal.newTextField('child_table_parent_id', 300, 100, 20); childrenPortal.showHorizontalLines = true; childrenPortal.showVerticalLines = true;
Sample
var childrenPortal = form.newPortal('pp', 'parent_to_child', 10, 10, 620, 460); childrenPortal.newTextField('child_table_id', 0, 100, 20); childrenPortal.newTextField('child_table_text',150,100,20); childrenPortal.newTextField('child_table_parent_id', 300, 100, 20); childrenPortal.sortable = true;
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.
Sample
// Create three fields. Based on how they are placed, by default they will come one // after another in the tab sequence. var fieldOne = form.newField('parent_table_id', JSField.TEXT_FIELD, 10, 10, 100, 20); var fieldTwo = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 40, 100, 20); var fieldThree = form.newField('parent_table_id', JSField.TEXT_FIELD, 10, 70, 100, 20); // Set the third field come before the first in the tab sequence, and remove the // second field from the tab sequence. fieldOne.tabSeq = 2; fieldTwo.tabSeq = SM_DEFAULTS.IGNORE; fieldThree.tabSeq = 1;
Sample
// Load an image from disk an create a Media object based on it. var imageBytes = plugins.file.readFile('d:/ball.jpg'); var media = solutionModel.newMedia('ball.jpg', imageBytes); // Put on the form a label with the image. var image = form.newLabel('', 10, 10, 100, 100); image.imageMedia = media; // Put two fields over the image. The second one will be transparent and the // image will shine through. var nonTransparentField = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 20, 100, 20); var transparentField = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 50, 100, 20); transparentField.transparent = true;
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;
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);
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);
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);
{column:width=100%|padding=0px}{column}
Method Details
getButton
(name)
Parameters
{String} name – The name of the button to retrieve.
Returns
JSButton – A JSButton instance that corresponds to the button with the specified name.
Sample
var clickMethod = form.newMethod('function clickMe() { application.output("I was clicked!"); }'); var childrenPortal = form.newPortal('pp', 'parent_to_child', 10, 10, 620, 460); var btn = childrenPortal.newButton('Click me!', 400, 100, 20, clickMethod); btn.name = 'clickMeBtn'; // Give a name to the button, so we can retrieve it by name later. // Retrieve the button by name and do something with it. var btnBack = childrenPortal.getButton('clickMeBtn'); btnBack.background = 'yellow'; // Retrieve the button through the array of all buttons and do something with it. var allButtons = childrenPortal.getButtons(); var btnBackAgain = allButtons[0]; btnBackAgain.foreground = 'red';
JSButton[]
getButtons
()
Returns
JSButton[] – An array with all buttons in the portal.
Sample
var clickMethod = form.newMethod('function clickMe() { application.output("I was clicked!"); }'); var childrenPortal = form.newPortal('pp', 'parent_to_child', 10, 10, 620, 460); var btn = childrenPortal.newButton('Click me!', 400, 100, 20, clickMethod); btn.name = 'clickMeBtn'; // Give a name to the button, so we can retrieve it by name later. // Retrieve the button by name and do something with it. var btnBack = childrenPortal.getButton('clickMeBtn'); btnBack.background = 'yellow'; // Retrieve the button through the array of all buttons and do something with it. var allButtons = childrenPortal.getButtons(); var btnBackAgain = allButtons[0]; btnBackAgain.foreground = 'red';
getDesignTimeProperty
()
Sample
var frm = solutionModel.getForm('orders') var fld = frm.getField('fld') var prop = fld.getDesignTimeProperty('myprop')
getField
(name)
Parameters
{String} name – The name of the field to retrieve.
Returns
JSField – A JSField instance corresponding to the field with the specified name.
Sample
var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780); var cal = childrenPortal.newField('my_table_date', JSField.CALENDAR, 0, 60, 20); var tfield = childrenPortal.newField('my_table_text', JSField.TEXT_FIELD, 60, 60, 20); tfield.name = 'textField'; // Give a name to the field so we can retrieve it later by name. // Retrieve the text field by its name and do something with it. var textFieldBack = childrenPortal.getField('textField'); textFieldBack.background = 'yellow'; // Retrieve the calendar field through the array of all fields and do something with it. var allFields = childrenPortal.getFields(); var calFieldBack = allFields[0]; calFieldBack.foreground = 'red';
JSField[]
getFields
()
Returns
JSField[] – An array with JSField instances corresponding to all fields in the portal.
Sample
var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780); var cal = childrenPortal.newField('my_table_date', JSField.CALENDAR, 0, 60, 20); var tfield = childrenPortal.newField('my_table_text', JSField.TEXT_FIELD, 60, 60, 20); tfield.name = 'textField'; // Give a name to the field so we can retrieve it later by name. // Retrieve the text field by its name and do something with it. var textFieldBack = childrenPortal.getField('textField'); textFieldBack.background = 'yellow'; // Retrieve the calendar field through the array of all fields and do something with it. var allFields = childrenPortal.getFields(); var calFieldBack = allFields[0]; calFieldBack.foreground = 'red';
getIntercellSpacing
()
Returns
String – A java.awt.Dimension object holding the horizontal and vertical intercell spacing.
Sample
var spacing = childrenPortal.getIntercellSpacing(); application.output("horizontal spacing: " + spacing.width); application.output("vertical spacing: " + spacing.height);
getLabel
(name)
Parameters
{String} name – The name of the label to retrieve.
Returns
JSLabel – A JSLabel instance corresponding to the label with the specified name.
Sample
var calLabel = childrenPortal.newLabel('Date', 120, 60, 20); var textLabel = childrenPortal.newLabel('Text', 180, 60, 20); textLabel.name = 'textLabel'; // Give a name to this label, so we can retrieve it by name. // Retrieve the second label by name. var textLabelBack = childrenPortal.getLabel('textLabel'); textLabelBack.background = 'yellow'; // Retrieve the first label through the array of all labels. var allLabels = childrenPortal.getLabels(); var calLabelBack = allLabels[0]; calLabelBack.foreground = 'red';
JSLabel[]
getLabels
()
Returns
JSLabel[] – An array of JSLabel instances corresponding to all labels in the portal.
Sample
var calLabel = childrenPortal.newLabel('Date', 120, 60, 20); var textLabel = childrenPortal.newLabel('Text', 180, 60, 20); textLabel.name = 'textLabel'; // Give a name to this label, so we can retrieve it by name. // Retrieve the second label by name. var textLabelBack = childrenPortal.getLabel('textLabel'); textLabelBack.background = 'yellow'; // Retrieve the first label through the array of all labels. var allLabels = childrenPortal.getLabels(); var calLabelBack = allLabels[0]; calLabelBack.foreground = 'red';
Sample
var button_uuid = solutionModel.getForm("my_form").getButton("my_button").getUUID(); application.output(button_uuid.toString());
newButton
(text, x, width, height, action)
Parameters
{String} text – The text to be displayed on the button.
{Number} x – The x coordinate of the button. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width – The width of the button.
{Number} height – The height of the button. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.
{Object} action – The JSMethod object that should be executed when the button is clicked.
Returns
JSButton – A JSButton instance representing the newly created button.
Sample
var clickMethod = form.newMethod('function clickMe() { application.output("I was clicked!"); }'); var childrenPortal = form.newPortal('pp', 'parent_to_child', 10, 10, 620, 460); childrenPortal.newButton('Click me!', 400, 100, 20, clickMethod);
newCalendar
(dataprovider, x, width, height)
Parameters
{Object} dataprovider – The data provider for this field. Can be either a column name, or an instance of JSVariable.
{Number} x – The x coordinate of the field. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width – The width of the field.
{Number} height – The height of the field. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.
Returns
JSField – A JSField instance that corresponds to the newly created calendar.
Sample
var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780); var cal = childrenPortal.newCalendar('my_table_date', 0, 60, 20);
newCheck
(dataprovider, x, width, height)
Parameters
{Object} dataprovider – The data provider for this field. Can be either a column name, or an instance of JSVariable.
{Number} x – The x coordinate of the field. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width – The width of the field.
{Number} height – The height of the field. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.
Returns
JSField – A JSField instance that corresponds to the newly created checkbox field.
Sample
var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780); var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES); vlist.customValues = "one\ntwo\nthree\nfour"; var chk = childrenPortal.newCheck('my_table_options', 60, 60, 50); chk.valuelist = vlist;
newComboBox
(dataprovider, x, width, height)
Parameters
{Object} dataprovider – The data provider for this field. Can be either a column name, or an instance of JSVariable.
{Number} x – The x coordinate of the field. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width – The width of the field.
{Number} height – The height of the field. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.
Returns
JSField – A JSField instance that corresponds to the newly created combobox field.
Sample
var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780); var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES); vlist.customValues = "one\ntwo\nthree\nfour"; var cmb = childrenPortal.newComboBox('my_table_options', 120, 160, 20); cmb.valuelist = vlist;
newField
(dataprovider, displaytype, x, width, height)
Parameters
{Object} dataprovider – The data provider for this field. Can be either a column name, or an instance of JSVariable.
{Number} displaytype – The display type of the field. Use constants from JSField for this parameter.
{Number} x – The x coordinate of the field. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width – The width of the field.
{Number} height – The height of the field. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.
Returns
JSField – A JSField instance that corresponds to the newly created field.
Sample
var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780); var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES); vlist.customValues = "one\ntwo\nthree\nfour"; var cal = childrenPortal.newField('my_table_date', JSField.CALENDAR, 0, 60, 20); var chk = childrenPortal.newField('my_table_options', JSField.CHECKS, 60, 60, 50); chk.valuelist = vlist; var cmb = childrenPortal.newField('my_table_options', JSField.COMBOBOX, 120, 160, 20); cmb.valuelist = vlist; var html = childrenPortal.newField('my_table_html', JSField.HTML_AREA, 180, 60, 50); var img = childrenPortal.newField('my_table_image', JSField.IMAGE_MEDIA, 240, 60, 50); var pwd = childrenPortal.newField('my_table_text', JSField.PASSWORD, 300, 60, 20); var radio = childrenPortal.newField('my_table_options', JSField.RADIOS, 360, 60, 50); radio.valuelist = vlist; var rtf = childrenPortal.newField('my_table_rtf', JSField.RTF_AREA, 420, 60, 50); var tarea = childrenPortal.newField('my_table_text', JSField.TEXT_AREA, 480, 60, 50); var tfield = childrenPortal.newField('my_table_text', JSField.TEXT_FIELD, 540, 60, 20); var tahead = childrenPortal.newField('my_table_text', JSField.TYPE_AHEAD, 600, 60, 20); tahead.valuelist = vlist;
newHtmlArea
(dataprovider, x, width, height)
Parameters
{Object} dataprovider – The data provider for this field. Can be either a column name, or an instance of JSVariable.
{Number} x – The x coordinate of the field. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width – The width of the field.
{Number} height – The height of the field. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.
Returns
JSField – A JSField instance that corresponds to the newly created HTML Area field.
Sample
var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780); var html = childrenPortal.newHtmlArea('my_table_html', 180, 60, 50);
newImageMedia
(dataprovider, x, width, height)
Parameters
{Object} dataprovider – The data provider for this field. Can be either a column name, or an instance of JSVariable.
{Number} x – The x coordinate of the field. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width – The width of the field.
{Number} height – The height of the field. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.
Returns
JSField – A JSField instance that corresponds to the newly created Image Media field.
Sample
var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780); var img = childrenPortal.newImageMedia('my_table_image', 240, 60, 50);
newLabel
(txt, x, width, height)
Parameters
{String} txt – The text that will be displayed in the label.
{Number} x – The x coordinate of the label. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width – The width of the label.
{Number} height – The height of the label. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.
Returns
JSLabel – A JSLabel instance that represents the newly created label.
Sample
var clickMethod = form.newMethod('function clickMe() { application.output("I was clicked!"); }'); var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780); var calLabel = childrenPortal.newLabel('Date', 120, 60, 20); // This will result in a button being actually created, because we specify an action. var textLabel = childrenPortal.newLabel('Text', 180, 60, 20, clickMethod);
newLabel
(text, x, width, height, action)
Parameters
{String} text – The text that will be displayed in the label.
{Number} x – The x coordinate of the label. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width – The width of the label.
{Number} height – The height of the label. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.
{Object} action – The JSMethod object that should be executed when the label is clicked.
Returns
JSLabel – A JSLabel instance that represents the newly created label.
Sample
var clickMethod = form.newMethod('function clickMe() { application.output("I was clicked!"); }'); var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780); var calLabel = childrenPortal.newLabel('Date', 120, 60, 20); // This will result in a button being actually created, because we specify an action. var textLabel = childrenPortal.newLabel('Text', 180, 60, 20, clickMethod);
newPassword
(dataprovider, x, width, height)
Parameters
{Object} dataprovider – The data provider for this field. Can be either a column name, or an instance of JSVariable.
{Number} x – The x coordinate of the field. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width – The width of the field.
{Number} height – The height of the field. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.
Returns
JSField – A JSField instance that corresponds to the newly created password field.
Sample
var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780); var pwd = childrenPortal.newPassword('my_table_text', 300, 60, 20);
newRadios
(dataprovider, x, width, height)
Parameters
{Object} dataprovider – The data provider for this field. Can be either a column name, or an instance of JSVariable.
{Number} x – The x coordinate of the field. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width – The width of the field.
{Number} height – The height of the field. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.
Returns
JSField – A JSField instance that corresponds to the newly created radio buttons.
Sample
var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780); var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES); vlist.customValues = "one\ntwo\nthree\nfour"; var radio = childrenPortal.newRadios('my_table_options', 360, 60, 50); radio.valuelist = vlist;
newRtfArea
(dataprovider, x, width, height)
Parameters
{Object} dataprovider – The data provider for this field. Can be either a column name, or an instance of JSVariable.
{Number} x – The x coordinate of the field. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width – The width of the field.
{Number} height – The height of the field. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.
Returns
JSField – A JSField instance that corresponds to the newly created RTF Area field.
Sample
var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780); var rtf = childrenPortal.newRtfArea('my_table_rtf', 420, 60, 50);
newTextArea
(dataprovider, x, width, height)
Parameters
{Object} dataprovider – The data provider for this field. Can be either a column name, or an instance of JSVariable.
{Number} x – The x coordinate of the field. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width – The width of the field.
{Number} height – The height of the field. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.
Returns
JSField – A JSField instance that corresponds to the newly created text area field.
Sample
var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780); var tarea = childrenPortal.newTextArea('my_table_text', 480, 60, 50);
newTextField
(dataprovider, x, width, height)
Parameters
{Object} dataprovider – The data provider for this field. Can be either a column name, or an instance of JSVariable.
{Number} x – The x coordinate of the field. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width – The width of the field.
{Number} height – The height of the field. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.
Returns
JSField – A JSField instance that corresponds to the newly created text field.
Sample
var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780); var tfield = childrenPortal.newTextField('my_table_text', 540, 60, 20);
newTypeAhead
(dataprovider, x, width, height)
Parameters
{Object} dataprovider – The data provider for this field. Can be either a column name, or an instance of JSVariable.
{Number} x – The x coordinate of the field. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width – The width of the field.
{Number} height – The height of the field. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.
Returns
JSField – A JSField instance that corresponds to the newly created type ahead field.
Sample
var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780); var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES); vlist.customValues = "one\ntwo\nthree\nfour"; var tahead = childrenPortal.newTypeAhead('my_table_text', 600, 60, 20); tahead.valuelist = vlist;
putDesignTimeProperty
()
Sample
var frm = solutionModel.getForm('orders') var fld = frm.getField('fld') fld.putDesignTimeProperty('myprop', 'strawberry')
removeDesignTimeProperty
()
Sample
var frm = solutionModel.getForm('orders') var fld = frm.getField('fld') fld.removeDesignTimeProperty('myprop')
void
setIntercellSpacing
(width, height)
Returns
void
Sample
var childrenPortal = form.newPortal('pp',rel,10,10,620,460); childrenPortal.newTextField('child_table_id', 0, 100, 20); childrenPortal.newTextField('child_table_text',100,100,20); childrenPortal.newTextField('child_table_parent_id', 200, 100, 20); childrenPortal.setIntercellSpacing(5,10);