May 15, 2024 03:26 Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Supported Clients Sample Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients SampleSupported Clients
SmartClient
WebClient
NGClient
MobileClient
Property Summary
String
cssClasses
The css classes to be output for html tag.
String
elementId
The id to be output for html tag.
Number
height
Get/set container height.
String
name
The name of the component.
String
packageName
returns the layouts package name
String
specName
returns the layouts spec name
String
style
The style definition to be output in html tag.
String
tagType
The tag type for html output.
Number
x
Get/set x location.
Number
y
Get/set Y location.
Methods Summary
JSLayoutContainer
findLayoutContainer(name)
Returns a JSLayoutContainer that has the given name throughout the whole form hierarchy.
JSComponent
findWebComponent(name)
Returns a JSWebComponent that has the given name through the whole hierarchy of JSLayoutContainers
String
getAttribute(name)
JSComponent
getBean(name)
Returns a JSBean that has the given name.
Array
getBeans()
Returns all JSBeans of this form.
Array
getBeans(returnInheritedElements)
Returns all JSBeans of this form.
JSComponent
getButton(name)
Returns a JSButton that has the given name.
Array
getButtons()
Returns all JSButtons of this form, including the ones without a name.
Array
getButtons(returnInheritedElements)
Returns all JSButtons of this form, including the ones without a name.
JSComponent
getComponent(name)
Returns a JSComponent that has the given name; if found it will be a JSField, JSLabel, JSButton, JSPortal, JSBean, JSWebComponent or JSTabPanel.
Array
getComponents()
Returns a array of all the JSComponents that a form has; they are of type JSField,JSLabel,JSButton,JSPortal,JSBean, JSWebComponents or JSTabPanel.
Array
getComponents(returnInheritedElements)
Returns a array of all the JSComponents that a form has; they are of type JSField,JSLabel,JSButton,JSPortal,JSBean, JSWebComponent or JSTabPanel.
JSField
getField(name)
The field with the specified name.
Array
getFields()
Returns all JSField objects of this form, including the ones without a name.
Array
getFields(returnInheritedElements)
Returns all JSField objects of this form, including the ones without a name.
JSComponent
getLabel(name)
Returns a JSLabel that has the given name.
Array
getLabels()
Returns all JSLabels of this form (not including its super form), including the ones without a name.
Array
getLabels(returnInheritedElements)
Returns all JSLabels of this form (optionally including it super forms labels), including the ones without a name.
JSLayoutContainer
getLayoutContainer(name)
Returns a JSLayoutContainer that has the given name of this container.
Array
getLayoutContainers()
Returns all JSLayoutContainers objects of this container
JSComponent
getPortal(name)
Returns a JSPortal that has the given name.
Array
getPortals()
Returns all JSPortal objects of this form (not including the ones from the parent form), including the ones without a name.
Array
getPortals(returnInheritedElements)
Returns all JSPortal objects of this form (optionally also the ones from the parent form), including the ones without a name.
JSComponent
getTabPanel(name)
Returns a JSTabPanel that has the given name.
Array
getTabPanels()
Returns all JSTabPanels of this form (not including the ones from the parent form), including the ones without a name.
Array
getTabPanels(returnInheritedElements)
Returns all JSTabPanels of this form (optionally the ones from the parent form), including the ones without a name.
JSComponent
getWebComponent(name)
Returns a JSWebComponent that has the given name that is a child of this layout container.
Array
getWebComponents()
Returns all JSWebComponents of this form/container.
Array
getWebComponents(returnInheritedElements)
Returns all JSWebComponents of this form/container.
JSComponent
newBean(name, className, x, y, width, height)
Creates a new JSBean object on the form - including the name of the JSBean object; the classname the JSBean object is based on, the "x" and "y" position of the JSBean object in pixels, as well as the width and height of the JSBean object in pixels.
JSComponent
newButton(txt, x, y, width, height, action)
Creates a new button on the form with the given text, place, size and JSMethod as the onAction event triggered action.
JSField
newCalendar(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of CALENDAR - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
JSField
newCheck(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of CHECK (checkbox) - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
JSField
newComboBox(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of COMBOBOX - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
JSField
newField(dataprovider, type, x, y, width, height)
Creates a new JSField object on the form - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
JSField
newHtmlArea(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of HTML_AREA - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
JSField
newImageMedia(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of IMAGE_MEDIA - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
JSComponent
newLabel(txt, x, y, width, height)
Creates a new JSLabel object on the form - including the text of the label, the "x" and "y" position of the label object in pixels, the width and height of the label object in pixels.
JSComponent
newLabel(txt, x, y, width, height, action)
Creates a new JSLabel object on the form - including the text of the label, the "x" and "y" position of the label object in pixels, the width and height of the label object in pixels and a JSMethod action such as the method for an onAction event.
JSLayoutContainer
newLayoutContainer(position)
Create a new layout container.
JSLayoutContainer
newLayoutContainer(position, spec)
Create a new layout container.
JSField
newListBox(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of LISTBOX - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
JSField
newMultiSelectListBox(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of MULTISELECT_LISTBOX - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
JSField
newPassword(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of PASSWORD - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
JSComponent
newPortal(name, relation, x, y, width, height)
Creates a new JSPortal object on the form - including the name of the JSPortal object; the relation the JSPortal object is based on, the "x" and "y" position of the JSPortal object in pixels, as well as the width and height of the JSPortal object in pixels.
JSField
newRadios(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of RADIOS (radio buttons) - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
JSField
newRtfArea(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of RTF_AREA (enables more than one line of text to be displayed in a field) - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
JSField
newSpinner(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of SPINNER - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
JSComponent
newTabPanel(name, x, y, width, height)
Creates a new JSTabPanel object on the form - including the name of the JSTabPanel object, the "x" and "y" position of the JSTabPanel object in pixels, as well as the width and height of the JSTabPanel object in pixels.
JSField
newTextArea(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of TEXT_AREA - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
JSField
newTextField(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of TEXT_FIELD - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
JSField
newTypeAhead(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of TYPE_AHEAD - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
JSComponent
newWebComponent(name, type, position)
Creates a new JSWebComponent (spec based component) object on the RESPONSIVE form.
JSComponent
newWebComponent(name, type, x, y, width, height)
Creates a new JSWebComponent (spec based component) object on the form.
void
putAttribute(key, value)
void
remove()
Remove a layout container (with all its children) from hierarchy.
Boolean
removeBean(name)
Removes a JSBean that has the specified name.
Boolean
removeButton(name)
Removes a JSButton that has the specified name.
Boolean
removeComponent(name)
Removes a component (JSLabel, JSButton, JSField, JSPortal, JSBean, JSTabpanel, JSWebComponent) that has the given name.
Boolean
removeField(name)
Removes a JSField that has the given name.
Boolean
removeLabel(name)
Removes a JSLabel that has the given name.
Boolean
removePortal(name)
Removes a JSPortal that has the given name.
Boolean
removeTabPanel(name)
Removes a JSTabPanel that has the given name.
Boolean
removeWebComponent(name)
Removes a JSWebComponent that has the specified name.
Property Details
cssClasses
The css classes to be output for html tag.
layoutContainer.cssClasses = 'myContainer';
elementId
The id to be output for html tag.
layoutContainer.elementId = 'rowCol';
height
Get/set container height. This is only used for CSS Position Container.
layoutContainer.height = 300;
name
The name of the component. Through this name it can also accessed in methods.
Must be a valid javascript name. (no - in the name or start with number)
layoutContainer.name = 'col1';
packageName
returns the layouts package name
specName
returns the layouts spec name
style
The style definition to be output in html tag.
layoutContainer.style = "background-color:'red'";
tagType
The tag type for html output. Default value is 'div'.
layoutContainer.tagType = 'span';
x
Get/set x location. Location is used for ordering in html output.
layoutContainer.x = 100;;
y
Get/set Y location. Location is used for ordering in html output.
layoutContainer.y = 100;;
Methods Details
findLayoutContainer(name)
Returns a JSLayoutContainer that has the given name throughout the whole form hierarchy.
String
name
the specified name of the container
var container = myForm.findLayoutContainer("row1");
application.output(container.name);
findWebComponent(name)
Returns a JSWebComponent that has the given name through the whole hierarchy of JSLayoutContainers
String
name
the specified name of the web component
var btn = myForm.findWebComponent("mycomponent");
application.output(mybean.typeName);
getAttribute(name)
String
name
the attributes name
layoutContainer.getAttribute('class');
getBean(name)
Returns a JSBean that has the given name.
String
name
the specified name of the bean
var btn = myForm.getBean("mybean");
application.output(mybean.className);
getBeans()
Returns all JSBeans of this form.
var beans = myForm.getBeans();
for (var b in beans)
{
if (beans[b].name != null)
application.output(beans[b].name);
}
getBeans(returnInheritedElements)
Returns all JSBeans of this form.
Boolean
returnInheritedElements
true to also return the elements from parent form
var beans = myForm.getBeans();
for (var b in beans)
{
if (beans[b].name != null)
application.output(beans[b].name);
}
getButton(name)
Returns a JSButton that has the given name.
String
name
the specified name of the button
var btn = myForm.getButton("hello");
application.output(btn.text);
getButtons()
Returns all JSButtons of this form, including the ones without a name.
var buttons = myForm.getButtons();
for (var b in buttons)
{
if (buttons[b].name != null)
application.output(buttons[b].name);
else
application.output(buttons[b].text + " has no name ");
}
getButtons(returnInheritedElements)
Returns all JSButtons of this form, including the ones without a name.
Boolean
returnInheritedElements
true to also return the elements from parent form
var buttons = myForm.getButtons();
for (var b in buttons)
{
if (buttons[b].name != null)
application.output(buttons[b].name);
else
application.output(buttons[b].text + " has no name ");
}
getComponent(name)
Returns a JSComponent that has the given name; if found it will be a JSField, JSLabel, JSButton, JSPortal, JSBean, JSWebComponent or JSTabPanel.
String
name
the specified name of the component
var frm = solutionModel.getForm("myForm");
var cmp = frm.getComponent("componentName");
application.output("Component type and name: " + cmp);
getComponents()
Returns a array of all the JSComponents that a form has; they are of type JSField,JSLabel,JSButton,JSPortal,JSBean, JSWebComponents or JSTabPanel.
var form = solutionModel.getForm("myForm");
var components = form.getComponents();
for (var i in components)
application.output("Component type and name: " + components[i]);
getComponents(returnInheritedElements)
Returns a array of all the JSComponents that a form has; they are of type JSField,JSLabel,JSButton,JSPortal,JSBean, JSWebComponent or JSTabPanel.
Boolean
returnInheritedElements
true to also return the elements from the parent form
var form = solutionModel.getForm("myForm");
var components = form.getComponents();
for (var i in components)
application.output("Component type and name: " + components[i]);
getField(name)
The field with the specified name.
String
name
the specified name of the field
var form = solutionModel.getForm("myForm");
var field = form.getField("myField");
application.output(field.dataProviderID);
getFields()
Returns all JSField objects of this form, including the ones without a name.
var frm = solutionModel.getForm("myForm");
var fields = frm.getFields();
for (var f in fields)
{
var fname = fields[f].name;
if (fname != null)
application.output(fname);
}
getFields(returnInheritedElements)
Returns all JSField objects of this form, including the ones without a name.
Boolean
returnInheritedElements
true to also return the elements from the parent form
var frm = solutionModel.getForm("myForm");
var fields = frm.getFields();
for (var f in fields)
{
var fname = fields[f].name;
if (fname != null)
application.output(fname);
}
getLabel(name)
Returns a JSLabel that has the given name.
String
name
the specified name of the label
var frm = solutionModel.getForm("myForm");
var label = frm.getLabel("myLabel");
application.output(label.text);
getLabels()
Returns all JSLabels of this form (not including its super form), including the ones without a name.
var frm = solutionModel.getForm("myForm");
var labels = frm.getLabels();
for (var i in labels)
{
var lname = labels[i].name;
if (lname != null)
application.output(lname);
}
getLabels(returnInheritedElements)
Returns all JSLabels of this form (optionally including it super forms labels), including the ones without a name.
Boolean
returnInheritedElements
true to also return the elements from parent form
var frm = solutionModel.getForm("myForm");
var labels = frm.getLabels();
for (var i in labels)
{
var lname = labels[i].name;
if (lname != null)
application.output(lname);
}
getLayoutContainer(name)
Returns a JSLayoutContainer that has the given name of this container.
Use findLayoutContainer() method to find a JSLayoutContainter through the hierarchy
String
name
the specified name of the container
var container = myForm.getLayoutContainer("row1");
application.output(container.name);
getLayoutContainers()
Returns all JSLayoutContainers objects of this container
var frm = solutionModel.getForm("myForm");
var containers = frm.getLayoutContainers();
for (var c in containers)
{
var fname = containers[c].name;
application.output(fname);
}
getPortal(name)
Returns a JSPortal that has the given name.
String
name
the specified name of the portal
var frm = solutionModel.getForm("myForm");
var portal = frm.getPortal("myPortal");
portal.initialSort = 'my_table_text desc';
getPortals()
Returns all JSPortal objects of this form (not including the ones from the parent form), including the ones without a name.
var frm = solutionModel.getForm("myForm");
var portals = frm.getPortals();
for (var i in portals)
{
var p = portals[i];
if (p.name != null)
application.output(p.name);
else
application.output("unnamed portal detected");
}
getPortals(returnInheritedElements)
Returns all JSPortal objects of this form (optionally also the ones from the parent form), including the ones without a name.
Boolean
returnInheritedElements
true to also return the elements from parent form
var frm = solutionModel.getForm("myForm");
var portals = frm.getPortals();
for (var i in portals)
{
var p = portals[i];
if (p.name != null)
application.output(p.name);
else
application.output("unnamed portal detected");
}
getTabPanel(name)
Returns a JSTabPanel that has the given name.
String
name
the specified name of the tabpanel
var frm = solutionModel.getForm("myForm");
var tabPanel = frm.getTabPanel("myTabPanel");
var tabs = tabPanel.getTabs();
for (var i=0; i<tabs.length; i++)
application.output("Tab " + i + " has text " + tabs[i].text);
getTabPanels()
Returns all JSTabPanels of this form (not including the ones from the parent form), including the ones without a name.
var frm = solutionModel.getForm("myForm");
var tabPanels = frm.getTabPanels();
for (var i in tabPanels)
{
var tp = tabPanels[i];
if (tp.name != null)
application.output("Tab " + tp.name + " has text " + tp.text);
else
application.output("Tab with text " + tp.text + " has no name");
}
getTabPanels(returnInheritedElements)
Returns all JSTabPanels of this form (optionally the ones from the parent form), including the ones without a name.
Boolean
returnInheritedElements
true to also return the elements from parent form
var frm = solutionModel.getForm("myForm");
var tabPanels = frm.getTabPanels();
for (var i in tabPanels)
{
var tp = tabPanels[i];
if (tp.name != null)
application.output("Tab " + tp.name + " has text " + tp.text);
else
application.output("Tab with text " + tp.text + " has no name");
}
getWebComponent(name)
Returns a JSWebComponent that has the given name that is a child of this layout container.
Use findWebComponent() to find a webcomponent through the hierarchy
String
name
the specified name of the web component
var btn = myForm.getWebComponent("mycomponent");
application.output(mybean.typeName);
getWebComponents()
Returns all JSWebComponents of this form/container.
If this method is called on a form, then it will return all web components on that form.
If the form is responsive, it will return the web components from all the containers.
var webComponents = myForm.getWebComponents();
for (var i in webComponents)
{
if (webComponents[i].name != null)
application.output(webComponents[i].name);
}
getWebComponents(returnInheritedElements)
Returns all JSWebComponents of this form/container.
If this method is called on a form, then it will return all web components on that form.
If the form is responsive, it will return the web components from all the containers.
Boolean
returnInheritedElements
true to also return the elements from parent form
var webComponents = myForm.getWebComponents(false);
for (var i in webComponents)
{
if (webComponents[i].name != null)
application.output(webComponents[i].name);
}
newBean(name, className, x, y, width, height)
Creates a new JSBean object on the form - including the name of the JSBean object; the classname the JSBean object is based on, the "x" and "y" position of the JSBean object in pixels, as well as the width and height of the JSBean object in pixels.
String
name
the specified name of the JSBean object
String
className
the class name of the JSBean object
Number
x
the horizontal "x" position of the JSBean object in pixels
Number
y
the vertical "y" position of the JSBean object in pixels
Number
width
the width of the JSBean object in pixels
Number
height
the height of the JSBean object in pixels
var form = solutionModel.newForm('newForm1', 'db:/server1/table1', null, true, 800, 600);
var bean = form.newBean('bean','com.servoy.extensions.beans.dbtreeview.DBTreeView',200,200,300,300);
forms['newForm1'].controller.show();
newButton(txt, x, y, width, height, action)
Creates a new button on the form with the given text, place, size and JSMethod as the onAction event triggered action.
String
txt
the text on the button
Number
x
the x coordinate of the button location on the form
Number
y
the y coordinate of the button location on the form
Number
width
the width of the button
Number
height
the height of the button
Object
action
the method assigned to handle an onAction event
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var method = form.newMethod('function onAction(event) { application.output("onAction intercepted on " + event.getFormName()); }');
var button = form.newButton('myButton', 10, 10, 100, 30, method);
application.output("The new button: " + button.name + " has the following onAction event handling method assigned " + button.onAction.getName());
newCalendar(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of CALENDAR - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Object
dataprovider
the specified dataprovider name/JSVariable of the JSField object
Number
x
the horizontal "x" position of the JSfield object in pixels
Number
y
the vertical "y" position of the JSField object in pixels
Number
width
the width of the JSField object in pixels
Number
height
the height of the JSField object in pixels
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var calendar = form.newCalendar(myDataProvider, 100, 100, 200, 200);
forms['newForm1'].controller.show();
newCheck(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of CHECK (checkbox) - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Object
dataprovider
the specified dataprovider name/JSVariable of the JSField object
Number
x
the horizontal "x" position of the JSfield object in pixels
Number
y
the vertical "y" position of the JSField object in pixels
Number
width
the width of the JSField object in pixels
Number
height
the height of the JSField object in pixels
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var calendar = form.newCheck(myDataProvider, 100, 100, 200, 200);
forms['newForm1'].controller.show();
newComboBox(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of COMBOBOX - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Object
dataprovider
the specified dataprovider name/JSVariable of the JSField object
Number
x
the horizontal "x" position of the JSfield object in pixels
Number
y
the vertical "y" position of the JSField object in pixels
Number
width
the width of the JSField object in pixels
Number
height
the height of the JSField object in pixels
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var calendar = form.newComboBox(myDataProvider, 100, 100, 200, 200);
forms['newForm1'].controller.show();
newField(dataprovider, type, x, y, width, height)
Creates a new JSField object on the form - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Object
dataprovider
the specified dataprovider name/JSVariable of the JSField object
Number
type
the display type of the JSField object (see the Solution Model -> JSField node for display types)
Number
x
the horizontal "x" position of the JSField object in pixels
Number
y
the vertical "y" position of the JSField object in pixels
Number
width
the width of the JSField object in pixels
Number
height
the height of the JSField object in pixels
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var variable = form.newVariable('myVar', JSVariable.TEXT);
variable.defaultValue = "'This is a default value (with triple quotes)!'";
var field = form.newField(variable, JSField.TEXT_FIELD, 100, 100, 200, 200);
forms['newForm1'].controller.show();
newHtmlArea(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of HTML_AREA - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Object
dataprovider
the specified dataprovider name/JSVariable of the JSField object
Number
x
the horizontal "x" position of the JSfield object in pixels
Number
y
the vertical "y" position of the JSField object in pixels
Number
width
the width of the JSField object in pixels
Number
height
the height of the JSField object in pixels
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var textProvider = form.newVariable('myVar',JSVariable.TEXT);
textProvider.defaultValue = "'This is a triple quoted text!'";
var htmlArea = myListViewForm.newHtmlArea(textProvider,100,100,100,100);
forms['newForm1'].controller.show();
newImageMedia(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of IMAGE_MEDIA - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Object
dataprovider
the specified dataprovider name/JSVariable of the JSField object
Number
x
the horizontal "x" position of the JSfield object in pixels
Number
y
the vertical "y" position of the JSField object in pixels
Number
width
the width of the JSField object in pixels
Number
height
the height of the JSField object in pixels
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var myMediaVar = form.newVariable("media", JSVariable.MEDIA);
var imageMedia = form.newImageMedia(myMediaVar,100,100,200,200)
forms['newForm1'].controller.show();
newLabel(txt, x, y, width, height)
Creates a new JSLabel object on the form - including the text of the label, the "x" and "y" position of the label object in pixels, the width and height of the label object in pixels.
String
txt
the specified text of the label object
Number
x
the horizontal "x" position of the label object in pixels
Number
y
the vertical "y" position of the label object in pixels
Number
width
the width of the label object in pixels
Number
height
the height of the label object in pixels
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var label = form.newLabel('The text on the label', 140, 140, 50, 20);
forms['newForm1'].controller.show();
newLabel(txt, x, y, width, height, action)
Creates a new JSLabel object on the form - including the text of the label, the "x" and "y" position of the label object in pixels, the width and height of the label object in pixels and a JSMethod action such as the method for an onAction event.
String
txt
the specified text of the label object
Number
x
the horizontal "x" position of the label object in pixels
Number
y
the vertical "y" position of the label object in pixels
Number
width
the width of the label object in pixels
Number
height
the height of the label object in pixels
Object
action
the event action JSMethod of the label object
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var label = form.newLabel('The text on the label', 140, 140, 50, 20);
forms['newForm1'].controller.show();
newLayoutContainer(position)
Create a new layout container. The position is used to determine the generated order in html markup.
This method can only be used in responsive forms.
If you want to use default values and so on from a layout package (like 12grid) or if you use the solution model
to create a form that is saved back into the workspace (servoyDeveloper.save(form)) then you have to set the
packageName and specName properties. So that it works later on in the designer.
If the packageName and specName are not provided, then:
the packageName is the same as for the parent container
the specName is the first allowed child defined in the specification of the parent container
If the specification of the parent container does not defined allowed children, then if it is not empty
the packageName and the specName are copied from the first child layout container.
Number
position
the position of JSWebComponent object in its parent container
var container = form.newLayoutContainer(1);
container.packageName = "12grid";
container.specName = "row";
newLayoutContainer(position, spec)
Create a new layout container. The position is used to determine the generated order in html markup.
This method can only be used in responsive forms.
Number
position
the position of JSWebComponent object in its parent container
String
spec
a string of the form 'packageName-layoutName', or 'layoutName'
var container = form.newLayoutContainer(1, "12grid-row");
container.newLayoutContainer(1, "column");
newListBox(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of LISTBOX - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Object
dataprovider
the specified dataprovider name/JSVariable of the JSField object
Number
x
the horizontal "x" position of the JSfield object in pixels
Number
y
the vertical "y" position of the JSField object in pixels
Number
width
the width of the JSField object in pixels
Number
height
the height of the JSField object in pixels
var form = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
var list = form.newListBox(myDataProvider, 100, 100, 200, 200);
forms['newForm1'].controller.show();
newMultiSelectListBox(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of MULTISELECT_LISTBOX - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Object
dataprovider
the specified dataprovider name/JSVariable of the JSField object
Number
x
the horizontal "x" position of the JSfield object in pixels
Number
y
the vertical "y" position of the JSField object in pixels
Number
width
the width of the JSField object in pixels
Number
height
the height of the JSField object in pixels
var form = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
var calendar = form.newMultiSelectListBox(myDataProvider, 100, 100, 200, 200);
forms['newForm1'].controller.show();
newPassword(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of PASSWORD - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Object
dataprovider
the specified dataprovider name/JSVariable of the JSField object
Number
x
the horizontal "x" position of the JSfield object in pixels
Number
y
the vertical "y" position of the JSField object in pixels
Number
width
the width of the JSField object in pixels
Number
height
the height of the JSField object in pixels
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var pass = form.newPassword(scopes.globals.aVariable, 100, 100, 70, 30);
forms['newForm1'].controller.show();
newPortal(name, relation, x, y, width, height)
Creates a new JSPortal object on the form - including the name of the JSPortal object; the relation the JSPortal object is based on, the "x" and "y" position of the JSPortal object in pixels, as well as the width and height of the JSPortal object in pixels.
String
name
the specified name of the JSPortal object
Object
relation
the relation of the JSPortal object
Number
x
the horizontal "x" position of the JSPortal object in pixels
Number
y
the vertical "y" position of the JSPortal object in pixels
Number
width
the width of the JSPortal object in pixels
Number
height
the height of the JSPortal object in pixels
var form = solutionModel.newForm('newForm1', 'db:/server1/table1', null, true, 800, 600);
var relation = solutionModel.newRelation('parentToChild','db:/server1/table1','db:/server2/table2',JSRelation.INNER_JOIN);
relation.newRelationItem('another_parent_table_id', '=', 'another_child_table_parent_id');
var portal = form.newPortal('portal',relation,200,200,300,300);
portal.newField('someColumn',JSField.TEXT_FIELD,200,200,120);
forms['newForm1'].controller.show();
newRadios(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of RADIOS (radio buttons) - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Object
dataprovider
the specified dataprovider name/JSVariable of the JSField object
Number
x
the horizontal "x" position of the JSfield object in pixels
Number
y
the vertical "y" position of the JSField object in pixels
Number
width
the width of the JSField object in pixels
Number
height
the height of the JSField object in pixels
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var vlist = solutionModel.newValueList('options',JSValueList.CUSTOM_VALUES);
vlist.customValues = "value1\nvalue2\nvalue3";
var radios = form.newRadios('columnDataProvider',100,100,200,200);
radios.valuelist = vlist;
newRtfArea(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of RTF_AREA (enables more than one line of text to be displayed in a field) - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Object
dataprovider
the specified dataprovider name/JSVariable of the JSField object
Number
x
the horizontal "x" position of the JSfield object in pixels
Number
y
the vertical "y" position of the JSField object in pixels
Number
width
the width of the JSField object in pixels
Number
height
the height of the JSField object in pixels
var form = solutionModel.newForm('newForm1',myDatasource,null,true,800,600);
var rtf_area = form.newRtfArea('columnDataProvider',100,100,100,100);
forms['newForm1'].controller.show();
newSpinner(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of SPINNER - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Object
dataprovider
the specified dataprovider name/JSVariable of the JSField object
Number
x
the horizontal "x" position of the JSfield object in pixels
Number
y
the vertical "y" position of the JSField object in pixels
Number
width
the width of the JSField object in pixels
Number
height
the height of the JSField object in pixels
var form = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
var spinner = form.newSpinner(myDataProvider, 10, 460, 100, 20);
forms['newForm1'].controller.show();
newTabPanel(name, x, y, width, height)
Creates a new JSTabPanel object on the form - including the name of the JSTabPanel object, the "x" and "y" position of the JSTabPanel object in pixels, as well as the width and height of the JSTabPanel object in pixels.
String
name
the specified name of the JSTabPanel object
Number
x
the horizontal "x" position of the JSTabPanel object in pixels
Number
y
the vertical "y" position of the JSTabPanel object in pixels
Number
width
the width of the JSTabPanel object in pixels
Number
height
the height of the JSTabPanel object in pixels
var form = solutionModel.newForm('parentForm','db:/server1/parent_table',null,false,640,480);
var childOne = solutionModel.newForm('childOne','db:/server1/child_table',null,false,400,300);
childOne.newField('child_table_text', JSField.TEXT_FIELD,10,10,100,20);
var parentToChild = solutionModel.newRelation('parentToChild','db:/server1/parent_table','db:/server1/child_table',JSRelation.INNER_JOIN);
parentToChild.newRelationItem('parent_table_id','=','child_table_parent_id');
var childTwo = solutionModel.newForm('childTwo','db:/server1/my_table',null,false,400,300);
childTwo.newField('my_table_image', JSField.IMAGE_MEDIA,10,10,100,100);
var tabPanel = form.newTabPanel('tabs',10,10,620,460);
tabPanel.newTab('tab1','Child One',childOne,parentToChild);
tabPanel.newTab('tab2','Child Two',childTwo);
forms['parentForm'].controller.show();
newTextArea(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of TEXT_AREA - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Object
dataprovider
the specified dataprovider name/JSVariable of the JSField object
Number
x
the horizontal "x" position of the JSTabPanel object in pixels
Number
y
the vertical "y" position of the JSTabPanel object in pixels
Number
width
the width of the JSTabPanel object in pixels
Number
height
the height of the JSTabPanel object in pixels
var form = solutionModel.newForm('newForm1',myDatasource,null,true,800,600);
var globalVar = solutionModel.newGlobalVariable('globals', 'myGlobal',JSVariable.TEXT);
globalVar.defaultValue = "'Type your text in here'";
var textArea = form.newTextArea(globalVar,100,100,300,150);
forms['newForm1'].controller.show();
newTextField(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of TEXT_FIELD - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Object
dataprovider
the specified dataprovider name/JSVariable of the JSField object
Number
x
the horizontal "x" position of the JSfield object in pixels
Number
y
the vertical "y" position of the JSField object in pixels
Number
width
the width of the JSField object in pixels
Number
height
the height of the JSField object in pixels
var form = solutionModel.newForm('newForm1',myDatasource,null,true,800,600);
//choose the dataprovider or jsvariable you want for the Text Field
var x = null;
//global jsvariable as the dataprovider
//x = solutionModel.newGlobalVariable('globals', 'myGlobal',JSVariable.TEXT);
//x.defaultValue = "'Text from a global variable'";
//or a form jsvariable as the dataprovider
//x = form.newVariable('myFormVar',JSVariable.TEXT);
//x.defaultValue = "'Text from a form variable'";
var textField = form.newTextField(x,100,100,200,50);
//or a column data provider as the dataprovider
//textField.dataProviderID = columnTextDataProvider;
forms['newForm1'].controller.show();
newTypeAhead(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of TYPE_AHEAD - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Object
dataprovider
the specified dataprovider name/JSVariable of the JSField object
Number
x
the horizontal "x" position of the JSfield object in pixels
Number
y
the vertical "y" position of the JSField object in pixels
Number
width
the width of the JSField object in pixels
Number
height
the height of the JSField object in pixels
var form = solutionModel.newForm('newForm1',myDatasource,null,true,800,600);
var vlist = solutionModel.newValueList('options',JSValueList.CUSTOM_VALUES);
vlist.customValues = "value1\nvalue2\nvalue3";
var typeAhead = form.newTypeAhead(columnTextDataProvider,100,100,300,200);
typeAhead.valuelist = vlist;
forms['newForm1'].controller.show();
newWebComponent(name, type, position)
Creates a new JSWebComponent (spec based component) object on the RESPONSIVE form.
String
name
the specified name of the JSWebComponent object
String
type
the webcomponent name as it appears in the spec
Number
position
the position of JSWebComponent object in its parent container
var form = solutionModel.newForm('newForm1', 'db:/server1/table1', null, true, 800, 600);
var container = myForm.getLayoutContainer("row1")
var bean = container.newWebComponent('bean','mypackage-testcomponent',1);
newWebComponent(name, type, x, y, width, height)
Creates a new JSWebComponent (spec based component) object on the form.
String
name
the specified name of the JSWebComponent object
String
type
the webcomponent name as it appears in the spec
Number
x
the horizontal "x" position of the JSWebComponent object in pixels
Number
y
the vertical "y" position of the JSWebComponent object in pixels
Number
width
the width of the JSWebComponent object in pixels
Number
height
the height of the JSWebComponent object in pixels
var form = solutionModel.newForm('newForm1', 'db:/server1/table1', null, true, 800, 600);
var bean = form.newWebComponent('bean','mypackage-testcomponent',200,200,300,300);
forms['newForm1'].controller.show();
putAttribute(key, value)
Object
key
;
String
value
;
layoutContainer.putAttribute('class','container fluid');
remove()
Remove a layout container (with all its children) from hierarchy.
layoutContainer.remove();
removeBean(name)
Removes a JSBean that has the specified name. Returns true if removal was successful, false otherwise.
String
name
the specified name of the JSBean to be removed
var form = solutionModel.getForm('myform');
form.removeBean('mybean')
removeButton(name)
Removes a JSButton that has the specified name. Returns true if removal was successful, false otherwise.
String
name
the specified name of the JSButton to be removed
var form = solutionModel.newForm('newFormX',myDatasource,null,true,800,600);
var b1 = form.newButton('This is button1',100,100,200,50,null);
b1.name = 'b1';
var jsmethod = form.newMethod("function removeMe(event) { var form = solutionModel.getForm('newFormX'); if (form.removeButton('b1') == true) application.output('Button has been removed ok'); else application.output('Button could not be deleted'); forms['newFormX'].controller.recreateUI();}");
var b2 = form.newButton('Click here to remove button1',100,230,200,50,jsmethod);
b2.name = 'b2';
forms['newFormX'].controller.show();
removeComponent(name)
Removes a component (JSLabel, JSButton, JSField, JSPortal, JSBean, JSTabpanel, JSWebComponent) that has the given name. It is the same as calling "if(!removeLabel(name) && !removeButton(name) ....)".
Returns true if removal was successful, false otherwise.
String
name
the specified name of the component to be deleted
var form = solutionModel.newForm('newFormX','db:/server1/parent_table',null,true,1000,750);
var jsbutton = form.newButton('JSButton to delete',100,100,200,50,null);
jsbutton.name = 'jsb';
var jslabel = form.newLabel('JSLabel to delete',100,200,200,50,null);
jslabel.name = 'jsl';
jslabel.transparent = false;
jslabel.background = 'green';
var jsfield = form.newField('scopes.globals.myGlobalVariable',JSField.TEXT_FIELD,100,300,200,50);
jsfield.name = 'jsf';
var relation = solutionModel.newRelation('parentToChild','db:/server1/parent_table','db:/server1/child_table',JSRelation.INNER_JOIN);
relation.newRelationItem('parent_table_id', '=', 'child_table_id');
var jsportal = form.newPortal('jsp',relation,100,400,300,300);
jsportal.newField('child_table_id',JSField.TEXT_FIELD,200,200,120);
var childOne = solutionModel.newForm('childOne','db:/server1/child_table',null,false,400,300);
childOne.newField('child_table_id', JSField.TEXT_FIELD,10,10,100,20);
var childTwo = solutionModel.newForm('childTwo','server1','other_table',null,false,400,300);
childTwo.newField('some_table_id', JSField.TEXT_FIELD,10,10,100,100);
var jstabpanel = form.newTabPanel('jst',450,30,620,460);
jstabpanel.newTab('tab1','Child One',childOne,relation);
jstabpanel.newTab('tab2','Child Two',childTwo);
var jsmethod = form.newMethod("function removeMe(event) { var form = solutionModel.getForm('newFormX');\n if ((form.removeComponent('jsb') == true) && (form.removeComponent('jsl') == true) && (form.removeComponent('jsf') == true) && (form.removeComponent('jsp') == true) & (form.removeComponent('jst') == true)) application.output('Components removed ok'); else application.output('Some component(s) could not be deleted'); forms['newFormX'].controller.recreateUI();}");
var removerButton = form.newButton('Click here to remove form components',450,500,250,50,jsmethod);
removerButton.name = 'remover';
forms['newFormX'].controller.show();
removeField(name)
Removes a JSField that has the given name. Returns true if removal was successful, false otherwise.
String
name
the specified name of the JSField to remove
var form = solutionModel.newForm('newFormX',myDatasource,null,true,800,600);
var jsfield = form.newField(scopes.globals.myGlobalVariable,JSField.TEXT_FIELD,100,300,200,50);
jsfield.name = 'jsf';
var jsmethod = form.newMethod("function removeMe(event) { var form = solutionModel.getForm('newFormX');\n if (form.removeComponent('jsf') == true) application.output('Field has been removed ok'); else application.output('Field could not be deleted'); forms['newFormX'].controller.recreateUI();}");
var removerButton = form.newButton('Click here to remove the field',450,500,250,50,jsmethod);
removerButton.name = 'remover';
forms['newFormX'].controller.show();
removeLabel(name)
Removes a JSLabel that has the given name. Returns true if removal successful, false otherwise
String
name
the specified name of the JSLabel to be removed
var form = solutionModel.newForm('newFormX',myDatasource,null,true,1000,750);
var jslabel = form.newLabel('JSLabel to delete',100,200,200,50,null);
jslabel.name = 'jsl';
jslabel.transparent = false;
jslabel.background = 'green';
var jsmethod = form.newMethod("function removeMe(event) { var form = solutionModel.getForm('newFormX'); if (form.removeComponent('jsl') == true) application.output('Label has been removed'); else application.output('Label could not be deleted'); forms['newFormX'].controller.recreateUI();}");
var removerButton = form.newButton('Click here to remove the green label',450,500,250,50,jsmethod);
removerButton.name = 'remover';
forms['newFormX'].controller.show();
removePortal(name)
Removes a JSPortal that has the given name. Returns true if removal was successful, false otherwise.
String
name
the specified name of the JSPortal to be removed
var form = solutionModel.newForm('newFormX',myDatasource,null,true,800,600);
var relation = solutionModel.newRelation('parentToChild','db:/server1/myTable','db:/server1/myOtherTable',JSRelation.INNER_JOIN);
relation.newRelationItem('parent_table_id', '=', 'child_table_id');
var jsportal = form.newPortal('jsp',relation,100,400,300,300);
jsportal.newField('child_table_id',JSField.TEXT_FIELD,200,200,120);
var jsmethod = form.newMethod("function removeMe(event) { var form = solutionModel.getForm('newFormX');\n if (form.removeComponent('jsp') == true) application.output('Portal removed ok'); else application.output('Portal could not be deleted'); forms['newFormX'].controller.recreateUI();}");
var removerButton = form.newButton('Click here to remove the portal',450,500,250,50,jsmethod);
removerButton.name = 'remover';
forms['newFormX'].controller.show();
removeTabPanel(name)
Removes a JSTabPanel that has the given name. Returns true if removal was successful, false otherwise.
String
name
the specified name of the JSTabPanel to be removed
var form = solutionModel.newForm('newFormX','db:/server1/parent_table',null,false,800,600);
var childOne = solutionModel.newForm('childOne','db:/server1/child_table',null,false,400,300);
childOne.newField('child_table_text', JSField.TEXT_FIELD,10,10,100,20);
var parentToChild = solutionModel.newRelation('parentToChild','db:/server1/parent_table','db:/server1/child_table',JSRelation.INNER_JOIN);
parentToChild.newRelationItem('parent_table_id','=','child_table_id');
var childTwo = solutionModel.newForm('childTwo','db:/server1/another_table',null,false,400,300);
childTwo.newField('columnDataProvider', JSField.TEXT_FIELD,10,10,100,100);
var tabPanel = form.newTabPanel('jst',10,10,620,460);
tabPanel.newTab('tab1','Child One',childOne,parentToChild);
tabPanel.newTab('tab2','Child Two',childTwo);
var jsmethod = form.newMethod("function removeMe(event) { var form = solutionModel.getForm('newFormX');\n if (form.removeComponent('jst') == true)\n application.output('TabPanel has been removed ok');\n else\n application.output('TabPanel could not be deleted');\n forms['newFormX'].controller.recreateUI();\n}");
var removerButton = form.newButton('Click here to remove the tab panel',450,500,250,50,jsmethod);
removerButton.name = 'remover';
forms['newFormX'].controller.show();
removeWebComponent(name)
Removes a JSWebComponent that has the specified name. Returns true if removal was successful, false otherwise.
String
name
the specified name of the JSWebComponent to be removed
var form = solutionModel.getForm('myform');
form.removeWebComponent('mybean')