XFormsDef (OpenText Process Suite Platform 10.8 Java SDK API)

java.lang.Object
- com.eibus.xforms.XFormsDef

```
public class XFormsDef
extends java.lang.Object
```
The Dynamic XForms class

This class contains a set of functions for creating dynamic xforms. With these functions you can build a caf/xform definition, step by step. The XForms-Previewer in Cordys can render the xform definition to html. This way you can show the xform to the user. In essence every page that you can create in the xform designer, you can create by using this class. You can add form controls like input, select, tabpages etc. As well as adding models and defining page layouts.

A few examples:
-------------------------------------------------------------------------------------------------------------------
Function which returns the node of an xform with a single input field:

public static int genXForm(Document document) {
        XFormsDef xf = new XFormsDef(document);
        int root = xf.getMainForm();

        int employee = xf.addInput(root, "Employee", "empID", "");

        return xf.getXFormsDefinition();
}

The first line, in the function, is the constructor for the xforms object. The second line gets the
node of the main form, the base for the design where the form controls/elements can be added.
The third adds the input. The fourth line returns the xform node.
-------------------------------------------------------------------------------------------------------------------
Function which returns the node of an xform with a button and an onclick event:

public static int genXForm(Document document) {
        XFormsDef xf = new XFormsDef(document);
        int root = xf.getMainForm();

        int bcBox = xf.addButtonControlbox(root, "cbBoxid", "vertical");
        int clickMeButton = xf.addButton(bcBox, "Click Me", "buttonID", "");
        String onClickScript = "alert(\"You clicked the button\");";
        int onClickEvent = xf.addOnClick(clickMeButton, onClickScript);

        return xf.getXFormsDefinition();
}
-------------------------------------------------------------------------------------------------------------------
Function returns the node of an xform with a table filled by a model:

public static int genXForm(Document document) {
        XFormsDef xf = new XFormsDef(document);
        int root = xf.getMainForm();

        int employeeTable = xf.addTable(root, "empTableID", "datagrid", true, "");
        int employee = xf.addInput(employeeTable, "Employee", "empID", "EmployeeID");
        int lastName = xf.addInput(employeeTable, "LastName", "nameID", "LastName");

        int controlBar = xf.addControlBar(employeeTable, true, true, true);
        int pagatinationBar = xf.addPaginationBar(employeeTable, true, true, true, true, true, false);

        String[] parLabels = new String[2];
        parLabels[0] = "fromEmployeeID";
        parLabels[1] = "toEmployeeID";
        String[] parValues = new String[2];
        parValues[0] = "1";
        parValues[1] = "10";
        int employeeModel = xf.addModel(
                "EmployeesModel",
                "http://schemas.cordys.com/1.0/demo/northwind/GetEmployees",
                "Employees",
                "get",
                parLabels,
                parValues);

        xf.linkModelWithElement(employeeModel, employeeTable);

        return xf.getXFormsDefinition();
}
-------------------------------------------------------------------------------------------------------------------
Function returns the node of an xform with a vertical and a horizontal splitter. All three splitter pages get an input field

public static int getXForm(Document document) {
        XFormsDef xf = new XFormsDef(document);
        int root = xf.getMainForm();

        int vSplit = xf.addSplitter(root, "left", 300, true);
        int leftPage = xf.getSplitterPage(vSplit, "left");
        int rightPage = xf.getSplitterPage(vSplit, "right");

        int hSplit = xf.addSplitter(leftPage, "top", 100, true);
        int topPage = xf.getSplitterPage(hSplit, "top");
        int bottomPage = xf.getSplitterPage(hSplit, "bottom");

        int inp1 = xf.addInput(topPage, "input1", "inp1id", "");
        int inp2 = xf.addInput(rightPage, "input2", "inp2id", "");
        int inp3 = xf.addInput(bottomPage, "input1", "inp1id", "");

        return xf.getXFormsDefinition();
}

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String ICON_BIG

static java.lang.String ICON_MID

static java.lang.String ICON_SMALL

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ICON_BIG`
`static java.lang.String`	`ICON_MID`
`static java.lang.String`	`ICON_SMALL`

Constructor Summary

Constructors
Constructor and Description
`XFormsDef()` Deprecated. use XFormsDef( node )
`XFormsDef(Document document)` Deprecated. use XFormsDef( node )
`XFormsDef(Document document, int xformsDefintion)` Deprecated. use XFormsDef( node )
`XFormsDef(int xformsDefinition)` Constructor of an xform definition.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`addAction(int node, java.lang.String name, java.lang.String source)` Adds an action event to an element
`int`	`addAction(int node, java.lang.String name, java.lang.String source, java.lang.String assignmentsXML)` Adds an action event to an element
`int`	`addButton(int node, java.lang.String label, java.lang.String id, java.lang.String reference)` Adds a button to a button controlbox.
`int`	`addButtonControlbox(int node, java.lang.String id, java.lang.String layout)` Adds a button group.
`int`	`addCheckbox(int node, java.lang.String label, java.lang.String id, java.lang.String reference, java.lang.String trueValue, java.lang.String falseValue)` Adds a checkbox
`int`	`addClickChoiceDocked(int node, java.lang.String URL, java.lang.String caption, java.lang.String formID, java.lang.String formCaption, java.lang.String formDescription, java.lang.String model, java.lang.String[] parameters, java.lang.String frame)` Adds a docked click choice option to the node.
`int`	`addClickChoiceDocked(int node, XFormsDef ccXForm, java.lang.String caption, java.lang.String formID, java.lang.String formCaption, java.lang.String formDescription, java.lang.String model, java.lang.String[] parameters, java.lang.String frame)` Adds a docked generated click choice option to the node.
`int`	`addClickChoiceSimple(int node, java.lang.String URL, java.lang.String caption, java.lang.String model, java.lang.String[] parameters, int width, int height)` Adds an undocked click choice option to the node.
`int`	`addClickChoiceSimple(int node, XFormsDef ccXForm, java.lang.String caption, java.lang.String model, java.lang.String[] parameters, int width, int height)` Adds an undocked generated click choice option to the node.
`int`	`addClickChoiceUnDocked(int node, java.lang.String URL, java.lang.String caption, java.lang.String formID, java.lang.String formCaption, java.lang.String formDescription, java.lang.String model, java.lang.String[] parameters, int left, int top, int width, int height)` Adds an undocked click choice option to the node.
`int`	`addClickChoiceUnDocked(int node, XFormsDef ccXForm, java.lang.String caption, java.lang.String formID, java.lang.String formCaption, java.lang.String formDescription, java.lang.String model, java.lang.String[] parameters, int left, int top, int width, int height)` Adds an undocked generated click choice option to the node.
`int`	`addCompositeControl(int node, java.lang.String id)` Adds a Composite control
`int`	`addCompositeControl(int node, java.lang.String id, java.lang.String namespace)` Adds a Composite control
`int`	`addControlBar(int node, boolean newButton, boolean deleteButton, boolean refreshButton)` Adds a controlbar to a table, groupbox or tabGroup.
`int`	`addFrame(int node, java.lang.String urlAddress, java.lang.String id)` Adds a frame
`void`	`addGlobalScript(java.lang.String source)` Adds a global script (allows for defining global variables).
`int`	`addGroup(int node, java.lang.String id, java.lang.String reference)` Adds a group, which allows other elements to be grouped together.
`int`	`addGroupBox(int node, java.lang.String label, java.lang.String id)` Simple visible groupbox for grouping other elements.
`int`	`addGroupBox(int node, java.lang.String label, java.lang.String id, java.lang.String reference, boolean collapsible, boolean expanded)` Groupbox with controls for grouping other elements.
`int`	`addImage(int node, java.lang.String id, java.lang.String urlImage, java.lang.String reference)` Adds an image
`int`	`addImageControlbox(int node, java.lang.String id, java.lang.String layout)` Adds an image group.
`int`	`addImageControlbox(int node, java.lang.String id, java.lang.String layout, java.lang.String iconSize)` Adds an image group.
`int`	`addInput(int node, java.lang.String label, java.lang.String id, java.lang.String reference)` Adds an input to the main xform or to another element.
`int`	`addItem(int node, java.lang.String label, java.lang.String value)` Adds an item to a custom content select or list
`int`	`addList(int node, java.lang.String label, java.lang.String id, java.lang.String reference, boolean multiple)` Adds a list to the xform or to another element.
`int`	`addModel(java.lang.String id, java.lang.String src, java.lang.String businessElement, java.lang.String type)` Adds a model to the form.
`int`	`addModel(java.lang.String id, java.lang.String src, java.lang.String businessElement, java.lang.String type, java.lang.String[] parameterLabels)` Adds a model to the form.
`int`	`addModel(java.lang.String id, java.lang.String src, java.lang.String businessElement, java.lang.String type, java.lang.String[] parameterLabels, java.lang.String[] parameterValues)` Adds a model to the form.
`int`	`addModelAfterEBIValidate(int modelNode, java.lang.String source)` Adds an AfterEBIValidate event to a WsAppsmodel
`int`	`addModelBeforeEBIValidate(int modelNode, java.lang.String source)` Adds an BeforeEBIValidate event to a WsAppsmodel
`int`	`addModelOnAfterChange(int modelNode, java.lang.String source)` Adds an OnAfterChange event to a model
`int`	`addModelOnAfterDelete(int modelNode, java.lang.String source)` Adds an OnAfterDelete event to a model
`int`	`addModelOnAfterInsert(int modelNode, java.lang.String source)` Adds an OnAfterInsert event to a model
`int`	`addModelOnBeforeChange(int modelNode, java.lang.String source)` Adds an OnBeforeChange event to a model
`int`	`addModelOnBeforeDelete(int modelNode, java.lang.String source)` Adds an OnBeforeDelete event to a model
`int`	`addModelOnBeforeInsert(int modelNode, java.lang.String source)` Adds an OnBeforeInsert event to a model
`int`	`addModelOnBeforeSync(int modelNode, java.lang.String source)` Adds an OnBeforeSynchronize event to a model
`int`	`addModelOnChange(int modelNode, java.lang.String source)` Adds an OnChange event to a model
`int`	`addModelOnDataCompleted(int modelNode, java.lang.String source)` Adds an OnDataCompleted event to a model
`int`	`addModelOnDelete(int modelNode, java.lang.String source)` Adds an OnDelete event to a model
`int`	`addModelOnFind(int modelNode, java.lang.String source)` Adds an OnFind event to a model
`int`	`addModelOnInsert(int modelNode, java.lang.String source)` Adds an OnInsert event to a model
`int`	`addModelOnRequest(int modelNode, java.lang.String source)` Adds an OnRequest event to a model
`int`	`addModelOnResponse(int modelNode, java.lang.String source)` Adds an OnResponse event to a model
`int`	`addModelOnSOAPFault(int modelNode, java.lang.String source)` Adds an OnSOAPFault event to a model
`int`	`addModelOnSynchronized(int modelNode, java.lang.String source)` Adds an OnSynchronized event to a model
`int`	`addNamespaceURI(int modelNode, java.lang.String prefix, java.lang.String uri)` Adds a namespace node to a model
`void`	`addNode(int elementNode, int destinationNode)` Adds a copy of a predefined node (elementNode), created with the function createEmptyNode to the destinationNode.
`int`	`addOnAfterClick(int node, java.lang.String source)` Adds an onafterclick event to a save, insert, delete or refresh button.
`int`	`addOnAfterZoom(int node, java.lang.String source)` Adds an OnAfterZoom event to an element (input, output, textarea or text)
`int`	`addOnBeforeBind(int node, java.lang.String source)` Adds an OnBeforeDataBind event to an element
`int`	`addOnBeforeClick(int node, java.lang.String source)` Adds an onbeforeclick event to a save, insert, delete or refresh button.
`int`	`addOnBeforeClose(java.lang.String source)` Adds an onbeforeclose event to the xform.
`int`	`addOnBeforeFill(int node, java.lang.String source)` Adds an onBeforeFill event to a select or a list
`int`	`addOnBeforeRowBind(int node, java.lang.String source)` Adds an addOnBeforeRowBind event to a table.
`int`	`addOnBeforeSynchronizedDialogOpen(int node, java.lang.String source)` Adds an on before synchronized dialog open event to a table with a synchronized dialog option.
`int`	`addOnBeforeZoom(int node, java.lang.String source)` Adds an OnBeforeZoom event to an element (input, output, textarea or text)
`int`	`addOnChange(int node, java.lang.String source)` Adds an OnChange event to an element
`int`	`addOnClick(int node, java.lang.String source)` Adds an OnClick event (only for a button and image).
`int`	`addOnFocusIn(int node, java.lang.String source)` Adds an OnFocusIn event to an element
`int`	`addOnFocusOut(int node, java.lang.String source)` Adds an OnFocusOut event to an element
`int`	`addOnFormInit(java.lang.String source)` Adds an init event to the main form, fires when form is started
`int`	`addOnFormInitDone(java.lang.String source)` Adds an init done event to the main form, fires when form has been loaded
`int`	`addOnRowChecked(int node, java.lang.String source)` Adds an onRowChecked event to a table.
`int`	`addOnRowSelect(int node, java.lang.String source)` Adds an onRowSelect event to a table.
`int`	`addOnValidate(int node, java.lang.String source)` Adds an OnValidate event to an element
`int`	`addOutput(int node, java.lang.String label, java.lang.String id, java.lang.String reference)` Adds an output to the xform or to another element.
`int`	`addPaginationBar(int node, boolean firstButton, boolean previousButton, boolean findButton, boolean nextButton, boolean LastButton, boolean showAllButton)` Adds a pagination bar to a table, groupbox or tabgroup.
`int`	`addPassword(int node, java.lang.String label, java.lang.String id, java.lang.String reference)` Adds an password (secret) to the xform or to another element.
`int`	`addRadio(int node, java.lang.String label, java.lang.String value)` Adds a radio to a radio controlbox.
`int`	`addRadioChoicebox(int node, java.lang.String id, java.lang.String label, java.lang.String reference, java.lang.String layout)` Adds a Radio group.
`int`	`addRichText(int node, java.lang.String id, java.lang.String label, java.lang.Boolean isEditable)` Adds a RichText control the xform.
`int`	`addSelect(int node, java.lang.String label, java.lang.String id, java.lang.String reference)` Adds a select to the xform or to another element.
`int`	`addSplitter(int node, java.lang.String type, int offSet, boolean takePositionIntoAccount)` Adds a splitter to a groupbox, group, mainform, tabpage or splitterpage.
`int`	`addTabGroup(int node, java.lang.String id, boolean tabsAtBottom)` Adds a tabgroup, for grouping tabpages.
`int`	`addTabGroup(int node, java.lang.String id, java.lang.String orientation, java.lang.String textDirection)` Adds a tabgroup, for grouping tabpages.
`int`	`addTable(int node, java.lang.String id, java.lang.String gridtype, boolean checkboxes, java.lang.String reference)` Adds the basic structure of a table.
`int`	`addTabPage(int node, java.lang.String label, java.lang.String id, java.lang.String reference)` Adds a tabpage to a tabgroup.
`int`	`addText(int node, java.lang.String label, java.lang.String id, java.lang.String reference)` Adds a text (label) to the main form or to another element.
`int`	`addTextarea(int node, java.lang.String label, java.lang.String id, java.lang.String reference)` Adds a textarea to the xform or to another element.
`int`	`addToolbar(boolean saveButton)` Adds a toolbar to the form.
`int`	`addToolbarButton(int node, java.lang.String id, java.lang.String imageURL)` Adds a custom button to a toolbar, controlbar or paginationbar.
`int`	`addToolbarSeparator(int node)` Adds a separator to the selected toolbar, controlbar or paginationbar.
`int`	`addXML(java.lang.String id, java.lang.String textXML)` Adds XML to the xform.
`int`	`addZoom(int node, java.lang.String zoomURL, java.lang.String zoomField)` Adds a zoom option to an input, output, textarea or text.
`int`	`addZoom(int node, XFormsDef zoomPage, java.lang.String idZoomPageField)` Adds a zoom page to an input, output, textarea or text.
`boolean`	`canAddElement(int node)` Checks whether a form control/element can be added to the node.
`void`	`copyNode(int node, int newParent)` Copies a node (and its children) to the new parent.
`int`	`createEmptyNode()` Creates an empty node.
`void`	`deleteNode(int node)` Deletes the node including its children.
`void`	`deleteSplitterNode(int node)` Delete the splitter, moves the elements in the splitterpages to the parent of the splitter.
`void`	`enableDefaultOption(int node, boolean isDefaultOptionEnabled)`
`void`	`enableLazyLoad(int node)` Enables lazy options for tab pages/group boxes.
`void`	`fillSelectWithModel(int modelNode, int elementNode, java.lang.String description, java.lang.String value)` Links a model with a select or a list, to fill the options of the select or list.
`static java.lang.String`	`generateURLForOLD(java.lang.String url)` For OLD Support correcting the absolute URLs
`int[]`	`getAllChildren(int node)` Returns an integer array with all the children (elements) that have been added to this node.
`Document`	`getDocument()` Deprecated. Use NOMDocumentPool.getInstance().lendDocument()
`java.lang.String`	`getLayout(int node)` Gets the default layout of mainform, groupbox, group, tabpage, splitterpage.
`java.lang.String`	`getLayoutElement(int node)` Gets the layout of an element.
`int`	`getMainForm()` Finds the node of the main form/root.
`int`	`getSplitterPage(int node, java.lang.String type)` Returns the splitter page, which is automatically create when a splitter is added to a group
`int`	`getToolbarButton(int node, java.lang.String buttonType)` Get a standard button from a toolbar, controlbar or paginationbar.
`int`	`getXFormsDefinition()` Gets the node of the xform created.
`void`	`hideGroupBoxHeader(int node)` Hides the header of a groupbox
`int`	`linkJavaScript(java.lang.String scriptURL)` Adds a link to a javascript source
`void`	`linkModelWithElement(int modelNode, int elementNode)` Links a model to an element.
`int`	`linkStyleSheet(java.lang.String styleSheetURL)` Adds a link to a style sheet
`void`	`moveNode(int node, int newParent)` Moves a node (and its children) from its current parent, to a new parent
`void`	`setAnchor(int node, java.lang.String leftValue, java.lang.String topValue, java.lang.String rightValue, java.lang.String bottomValue)` Sets the anchors of a control.
`void`	`setAssociatedModel(int mainModelNode, int subModelNode)` The subModel will be associated with the mainModel.
`void`	`setAssociatedModel(int mainModelNode, int subModelNode, boolean isSingleTransaction)` The subModel will be associated with the mainModel.
`void`	`setAssociatedReference(int subModelNode, java.lang.String parameterField, java.lang.String referenceField)` The references of the parameters of a subModel are set, to the referenceField.
`void`	`setAutoInsert(int node, java.lang.Boolean autoInsert)` AutoInsert
`void`	`setColumnSortable(int node, java.lang.Boolean columnSortable)` ColumnSortable
`void`	`setColumnsTableWidthAutomatic(int node)` This function automatically sets the size of the columns in a table to equal width, such that the width of all the columns equal the width of the entier table.
`void`	`setDefaultOption(int node, java.lang.String defaultOption)`
`void`	`setDisplayContextMenu(int node, java.lang.Boolean displayContextMenu)` DisplayContextMenu
`boolean`	`setEBIInitializeValueSets(int selectNode, int isInitializeValueSets)` To enable InitializeValueSets for select controls select node should attach to any one EBI model.
`boolean`	`setEBIModel(int modelNode, boolean isEBIModelValue, boolean isConstraintValidation, boolean isApplyAccessControl, boolean isInitializationRequired)`
`boolean`	`setEBIValidation(int control, boolean isConstraintValidation)` For input,checkbox,select,password,textarea controls EBI validation property can be set.
`void`	`setEnumerated(int node, boolean enumerated)` Set the enumerated parameter of a list or select box.
`void`	`setFocusAtStartup(boolean setFocus)` Sets the parameter focusAtStartup.
`void`	`setFormatSetMaxValue(int node, double maxValue)` Sets the maximum value of an integer, float or amount field
`void`	`setFormatSetMinValue(int node, double minValue)` Sets the minimum value of an integer, float or amount field
`void`	`setFormatToAmount(int node, boolean required, java.lang.String textAlignment, java.lang.String locale, java.lang.String displayformat, java.lang.String negativePattern, java.lang.String positivePattern, java.lang.String currency, int numberOfDecimals)` Sets the format of the element to an amount.
`void`	`setFormatToCreditcard(int node, boolean required, java.lang.String textAlignment)` Sets the field to creditcard format.
`void`	`setFormatToDate(int node, boolean required, java.lang.String textAlignment, java.lang.String locale, java.lang.String displayformat, java.lang.String timeZone)` Sets the format of the element to a date.
`void`	`setFormatToFloat(int node, boolean required, java.lang.String textAlignment, java.lang.String locale, java.lang.String displayformat, java.lang.String negativePattern, int numberOfDecimals)` Sets the format of the element to a float.
`void`	`setFormatToInteger(int node, boolean required, java.lang.String textAlignment, java.lang.String locale, java.lang.String displayformat, java.lang.String negativePattern)` Sets the format of the element to an integer.
`void`	`setFormatToMail(int node, boolean required, java.lang.String textAlignment)` Sets the format of the element to an e-mail format.
`void`	`setFormatToString(int node, boolean required, java.lang.String textAlignment, int minLength, int maxLength, java.lang.String legalCharacters, java.lang.String illegalCharacters)` Sets the format of the element to a string.
`void`	`setFreePositioning(int node, boolean freePositioning)` Independent of the layout of the parent, each element can be set to freePositioning.
`void`	`setLabelAlignment(int node, java.lang.String alignment, boolean setAlignmentOfSubElements)` Sets the alignment of the label of an element, or sets the default alignment of a groupbox, group, tabpage, main form or splitgroup.
`void`	`setLayout(int node, java.lang.String layout)` Sets the default layout of mainform, groupbox, group, tabpage, splitterpage.
`void`	`setloadOnDemand(int node, java.lang.Boolean loadOnDemand)` loadOnDemand
`void`	`setMinRows(int node, int minRows)` MinRows
`void`	`setModelProperties(int modelNode, boolean automatic, boolean nonTransactional, boolean promptToSave, java.lang.String gateway, java.lang.String receiver, int timeout)` Sets some extra properties of a model.
`void`	`setMovableColumns(int node, java.lang.Boolean movableColumns)` MovableColumns
`void`	`setNextMethodOfModel(int modelNode, java.lang.String src)` Adds a next method to a model, to retrieve the next set of records/data from the back end from the GET position.
`void`	`setPosition(int node, int x_coordinate, int y_coordinate)` Sets the position of an element to x,y coordinates.
`void`	`setPreviousMethodOfModel(int modelNode, java.lang.String src)` Adds a previous method to model, to retrieve the previous set of records/data from the back end from the GET position.
`void`	`setResizable(int node, java.lang.Boolean resizable)` Resizable
`void`	`setSaveGridState(int node, java.lang.Boolean saveGridState)` SaveGridState
`void`	`setShowSingleTab(int node, java.lang.Boolean showSingleTab)` ShowSingleTab
`void`	`setSize(int node, int width, int height)` Sets the size of an element
`void`	`setSize(int node, java.lang.String width, java.lang.String height)` Sets the size of an element.
`void`	`setSizeLabel(int node, int width)` Sets the width of the label of an input, output, password, textarea, select or list.
`void`	`setStyleClass(int node, java.lang.String styleClassName)` Sets the style class of an element
`void`	`setSynchronizedDialogDocked(int node, java.lang.String dialogXForm, java.lang.String dialogFrame, java.lang.String dialogID, java.lang.String dialogCaption, java.lang.String dialogDescription)` Adds a docked synchronized dialog to a table.
`void`	`setSynchronizedDialogDocked(int node, XFormsDef xfDialog, java.lang.String dialogFrame, java.lang.String dialogID, java.lang.String dialogCaption, java.lang.String dialogDescription)` Adds a docked synchronized dialog to a table.
`void`	`setSynchronizedDialogNotDocked(int node, java.lang.String dialogXForm, java.lang.String dialogID, java.lang.String dialogCaption, java.lang.String dialogDescription, int dialogLeft, int dialogTop, int dialogWidth, int dialogHeight, boolean newWindow)` Adds an undocked synchronized dialog to a table.
`void`	`setSynchronizedDialogNotDocked(int node, XFormsDef xfDialog, java.lang.String dialogID, java.lang.String dialogCaption, java.lang.String dialogDescription, int dialogLeft, int dialogTop, int dialogWidth, int dialogHeight, boolean newWindow)` Adds an undocked synchronized dialog to a table.
`void`	`setSynchronizedDialogSimple(int node, java.lang.String dialogXForm, int dialogWidth, int dialogHeight)` Adds a synchronized dialog to a table, with a minimum of parameters.
`void`	`setSynchronizedDialogSimple(int node, XFormsDef xfDialog, int dialogWidth, int dialogHeight)` Adds a synchronized dialog to a table, with a minimum of parameters.
`void`	`setTabIndex(int node, int tabIndex)` Sets the tabIndex of the node.
`void`	`setToggleColumns(int node, java.lang.Boolean toggleColumns)` ToggleColumns
`void`	`setTooltip(int node, java.lang.String tooltip)` Adds a tooltip to an element.
`void`	`setXFormsVersion(java.lang.String version)` Sets the xforms version, XForms Version can be either be 1 or 2.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ICON_SMALL
```
public static final java.lang.String ICON_SMALL
```
    See Also:
    
    Constant Field Values
  - ICON_MID
```
public static final java.lang.String ICON_MID
```
    See Also:
    
    Constant Field Values
  - ICON_BIG
```
public static final java.lang.String ICON_BIG
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - XFormsDef
```
@Deprecated
public XFormsDef()
```
    Deprecated. use XFormsDef( node )
    
    Constructor of an xform definition. Creates the basic nodes. The defaults are:
    - XFormsVersion = "1"
    - vcmVersion = "vcmdemo10
    - Layout of the main form is vertical by default.
  - XFormsDef
```
@Deprecated
public XFormsDef(Document document)
```
    Deprecated. use XFormsDef( node )
    
    Constructor of an xform definition. Creates the basic nodes. The defaults are:
    - XFormsVersion = "1"
    - vcmVersion = "vcmdemo10
    - Layout of the main form is vertical by default.
    
    Parameters:
    
    document - Document object
  - XFormsDef
```
@Deprecated
public XFormsDef(Document document,
                              int xformsDefintion)
```
    Deprecated. use XFormsDef( node )
    
    Constructor of an xform definition. Creates the basic nodes. The defaults are:
    - XFormsVersion = "1"
    - vcmVersion = "vcmdemo10
    - Layout of the main form is vertical by default.
    
    Parameters:
    
    document - Document object
    
    xformsDefintion - This node should be valid xforms defintion.
  - XFormsDef
```
public XFormsDef(int xformsDefinition)
```
    Constructor of an xform definition. Creates the basic nodes. The defaults are:
    - XFormsVersion = "1"
    - vcmVersion = "vcmdemo10
    - Layout of the main form is vertical by default.
    
    Parameters:
    
    xformsDefintion - This node should be valid xforms defintion.
- Method Detail
  - getXFormsDefinition
```
public int getXFormsDefinition()
```
    Gets the node of the xform created.
    
    Returns:
    
    int node of the complete xform
  - getMainForm
```
public int getMainForm()
```
    Finds the node of the main form/root. This node is the top level for adding elements.
    
    Returns:
    
    int node, the root node for adding elements. Returns 0 if not found.
  - getDocument
```
@Deprecated
public Document getDocument()
```
    Deprecated. Use NOMDocumentPool.getInstance().lendDocument()
    
    Returns the document used in this class
    
    Returns:
    
    document of this class
  - setXFormsVersion
```
public void setXFormsVersion(java.lang.String version)
```
    Sets the xforms version, XForms Version can be either be 1 or 2. If the version is set as 1, the page will be rendered in Quirks Mode. If the version is set as 2, the page will be rendered in Transitional Mode, which means it will be possible to render the page in multiple browsers once it is ported.
    
    Parameters:
    
    version - string with the version number or description of the xform
  - setFocusAtStartup
```
public void setFocusAtStartup(boolean setFocus)
```
    Sets the parameter focusAtStartup.
    
    Parameters:
    
    setFocus - true: the first elemnt in the form gets a focus when form is started. False: no element gets focus when started
  - addText
```
public int addText(int node,
                   java.lang.String label,
                   java.lang.String id,
                   java.lang.String reference)
```
    Adds a text (label) to the main form or to another element.
    
    Parameters:
    
    node - the node of the parent where this element is added
    
    label - string with label description.
    
    id - identifier of this element.
    
    reference - name of the datasource field (when a model is attached). When there will be no model, it should be "".
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - addInput
```
public int addInput(int node,
                    java.lang.String label,
                    java.lang.String id,
                    java.lang.String reference)
```
    Adds an input to the main xform or to another element.
    
    Parameters:
    
    node - the node of the parent where this element is added
    
    label - string with label of this element.
    
    id - identifier of this element.
    
    reference - name of the datasource field (when a model is attached). When there will be no model it should be "".
    
    Returns:
    
    int node the node of this element. Returns 0 if unsuccessful.
  - addPassword
```
public int addPassword(int node,
                       java.lang.String label,
                       java.lang.String id,
                       java.lang.String reference)
```
    Adds an password (secret) to the xform or to another element.
    
    Parameters:
    
    node - the node of the parent where this element is added
    
    label - string with label of this element.
    
    id - identifier of this element.
    
    reference - name of the datasource field (when a model is attached). When there will be no model it should be "".
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - addOutput
```
public int addOutput(int node,
                     java.lang.String label,
                     java.lang.String id,
                     java.lang.String reference)
```
    Adds an output to the xform or to another element.
    
    Parameters:
    
    node - the node of the parent where this element is added
    
    label - string with label of this element.
    
    id - identifier of this element.
    
    reference - name of the datasource field (when a model is attached). When there will be no model, it should be "".
    
    Returns:
    
    int node the node of this element. Returns 0 if unsuccessful.
  - addTextarea
```
public int addTextarea(int node,
                       java.lang.String label,
                       java.lang.String id,
                       java.lang.String reference)
```
    Adds a textarea to the xform or to another element.
    
    Parameters:
    
    node - the node of the parent where this element is added
    
    label - string with label of this element.
    
    id - identifier of this element.
    
    reference - name of the datasource field (when a model is attached). When there will be no model, it should be "".
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - addRichText
```
public int addRichText(int node,
                       java.lang.String id,
                       java.lang.String label,
                       java.lang.Boolean isEditable)
```
    Adds a RichText control the xform.
    
    Parameters:
    
    node - of the parent where this element is added.
    
    id - of this element
    
    label - string with label description
    
    isEditable - enable the runtime editing for the richtext
    
    Returns:
    
    the node of this element. Returns 0 if unsuccessful.
  - addButtonControlbox
```
public int addButtonControlbox(int node,
                               java.lang.String id,
                               java.lang.String layout)
```
    Adds a button group. This group can only contain buttons (not toolbar buttons). Buttons are always added to this group.
    
    Parameters:
    
    node - of the parent where this element is added.
    
    id - of this element
    
    layout - determines the positioning of buttons. Either "vertical" or "horizontal". "Vertical" is default.
    
    Returns:
    
    the node of this element. Returns 0 if unsuccessful.
  - addButton
```
public int addButton(int node,
                     java.lang.String label,
                     java.lang.String id,
                     java.lang.String reference)
```
    Adds a button to a button controlbox. To add a button to a toolbar the function addToolbarButton is used.
    
    Parameters:
    
    node - of the button controlbox.
    
    label - description which appears on the button
    
    id - identifier of this element.
    
    reference - name of the datasource field (when a model is attached). When there will be no model, it should be ""
    
    Returns:
    
    int node, node of the button. Returns 0 if unsuccessful.
  - addRadioChoicebox
```
public int addRadioChoicebox(int node,
                             java.lang.String id,
                             java.lang.String label,
                             java.lang.String reference,
                             java.lang.String layout)
```
    Adds a Radio group. This group can only contain radio buttons.
    
    Parameters:
    
    node - of the parent where this element is added.
    
    id - of this element
    
    reference - name of the datasource field (when a model is attached). When there will be no model, it should be ""
    
    layout - determines the positioning of buttons. Either "vertical" or "horizontal". "Vertical" is default.
    
    Returns:
    
    the node of this element. Returns 0 if unsuccessful.
  - addRadio
```
public int addRadio(int node,
                    java.lang.String label,
                    java.lang.String value)
```
    Adds a radio to a radio controlbox.
    
    Parameters:
    
    node - of the radio button.
    
    label - description which appears on the radio button
    
    id - identifier of this element.
    
    Returns:
    
    int node, node of the radio button. Returns 0 if unsuccessful.
  - addSelect
```
public int addSelect(int node,
                     java.lang.String label,
                     java.lang.String id,
                     java.lang.String reference)
```
    Adds a select to the xform or to another element.
    
    Parameters:
    
    node - the node of the parent where this element is added
    
    label - string with label of this element.
    
    id - identifier of this element.
    
    reference - name of the datasource field, which determines the shown value (when a model is attached). When there will be no model, it has to be set to ""
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - addList
```
public int addList(int node,
                   java.lang.String label,
                   java.lang.String id,
                   java.lang.String reference,
                   boolean multiple)
```
    Adds a list to the xform or to another element.
    
    Parameters:
    
    node - the node of the parent where this element is added
    
    label - string with label of this element.
    
    id - identifier of this element.
    
    reference - name of the datasource field (when a model is attached). When there will be no model, it should be "".
    
    multiple - can multiple options be selected
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - setEnumerated
```
public void setEnumerated(int node,
                          boolean enumerated)
```
    Set the enumerated parameter of a list or select box. Determines whether enumerated data from models can be handled
    
    Parameters:
    
    node - of list or select
    
    enumerated - true: handle enumated
  - enableDefaultOption
```
public void enableDefaultOption(int node,
                                boolean isDefaultOptionEnabled)
```
    Parameters:
    
    node - select
    
    isDefaultOptionEnabled - true: to enable defaultoption
  - setDefaultOption
```
public void setDefaultOption(int node,
                             java.lang.String defaultOption)
```
    Parameters:
    
    node - select
    
    defaultOption - the option which should be selected as defaultoption. This can contain values like "Cordys:Vanenburg" then the string before the colon will be taken as value and after the colon will be considered as description. If it doesn't contain any colon then the same string will be considered as value and description.
  - addItem
```
public int addItem(int node,
                   java.lang.String label,
                   java.lang.String value)
```
    Adds an item to a custom content select or list
    
    Parameters:
    
    node - of parent, must be select or list
    
    label - description which is shown to the user
    
    value - field which determines the value
    
    Returns:
    
    int node, node of the item. Returns 0 if unsuccessful.
  - addCheckbox
```
public int addCheckbox(int node,
                       java.lang.String label,
                       java.lang.String id,
                       java.lang.String reference,
                       java.lang.String trueValue,
                       java.lang.String falseValue)
```
    Adds a checkbox
    
    Parameters:
    
    node - the node of the parent where this element is added
    
    label - string with label of this element.
    
    id - identifier of this element.
    
    reference - name of the datasource field (when a model is attached). When there will be no model it should be "".
    
    trueValue - value the box gets when it is checked. Usually "true" or "1" depending on the database.
    
    falseValue - value the box gets when it is not checked. Usually "false" or "0".
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - addTable
```
public int addTable(int node,
                    java.lang.String id,
                    java.lang.String gridtype,
                    boolean checkboxes,
                    java.lang.String reference)
```
    Adds the basic structure of a table. Later elements like: input, output, select etc can be added to the table.
    
    Parameters:
    
    node - the node of the parent where this element is added
    
    id - the identifier of a table
    
    gridtype - the type of grid: "datagrid", "navigationgrid" or "displaygrid". "datagrid" is default.
    
    checkboxes - should the standard checkboxes in first column be shown
    
    reference - for binding non-transactional data. Fill with parent node name of references to row.
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - addGroupBox
```
public int addGroupBox(int node,
                       java.lang.String label,
                       java.lang.String id)
```
    Simple visible groupbox for grouping other elements. The layout is by default set to "vertical", use the function setLayout() to overwrite. By default: collapsible false, expanded true
    
    Parameters:
    
    node - the node of the parent where this element is added
    
    label - string with label of this element.
    
    id - identifier of this element.
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - addGroupBox
```
public int addGroupBox(int node,
                       java.lang.String label,
                       java.lang.String id,
                       java.lang.String reference,
                       boolean collapsible,
                       boolean expanded)
```
    Groupbox with controls for grouping other elements. The layout is by default set to "vertical", use the function setLayout() to overwrite.
    
    Parameters:
    
    node - the node of the parent where this element is added
    
    label - string with label of this element.
    
    id - identifier of this element.
    
    reference - name of the datasource field (when a model is attached). When there will be no model, it should be "".
    
    collapsible - determines if the box can be minimized
    
    expanded - is the box minimize or maximize at start up
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - enableLazyLoad
```
public void enableLazyLoad(int node)
```
    Enables lazy options for tab pages/group boxes.
    
    Parameters:
    
    node -
  - addGroup
```
public int addGroup(int node,
                    java.lang.String id,
                    java.lang.String reference)
```
    Adds a group, which allows other elements to be grouped together. The layout is by default set to "vertical", use the function setLayout() to overwrite.
    
    Parameters:
    
    node - form or group where the group is added
    
    id - identifier of the group
    
    reference - link to datasource field, when model is attached.
    
    Returns:
    
    int node, node of the group. Returns 0 if unsuccessful.
  - addTabGroup
```
public int addTabGroup(int node,
                       java.lang.String id,
                       boolean tabsAtBottom)
```
    Adds a tabgroup, for grouping tabpages.
    
    Parameters:
    
    node - the node of the parent where this element is added
    
    id - the identifier of this element
    
    tabsAtBottom - true sets the tabs at the bottom of the tabpages
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - addTabGroup
```
public int addTabGroup(int node,
                       java.lang.String id,
                       java.lang.String orientation,
                       java.lang.String textDirection)
```
    Adds a tabgroup, for grouping tabpages.
    
    Parameters:
    
    node - the node of the parent where this element is added
    
    id - the identifier of this element
    
    orientation - Sets the position in which tabs display at runtime. The available options are Top , Right , Bottom , Left , and Stacked .
    
    textDirection - Sets the display direction of text in the tabs. The available options are Vertical and Horizontal. Text direction availabe only for Right and Left orientation
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - addTabPage
```
public int addTabPage(int node,
                      java.lang.String label,
                      java.lang.String id,
                      java.lang.String reference)
```
    Adds a tabpage to a tabgroup. The layout is by default set to "vertical".
    
    Parameters:
    
    node - parent must be a tabgroup
    
    label - string with label of this element.
    
    id - identifier of this element.
    
    reference - link to datasource field, when model is attached.
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - addImageControlbox
```
public int addImageControlbox(int node,
                              java.lang.String id,
                              java.lang.String layout)
```
    Adds an image group. This group can only contain images, and images can only be added to an image controlbox.
    
    Parameters:
    
    node - of the parent where this element is added.
    
    id - of this element
    
    layout - determines the positioning of images. Either "vertical" or "horizontal". "Vertical" is default.
    
    Returns:
    
    the node of this element. Returns 0 if unsuccessful.
  - addImageControlbox
```
public int addImageControlbox(int node,
                              java.lang.String id,
                              java.lang.String layout,
                              java.lang.String iconSize)
```
    Adds an image group. This group can only contain images, and images can only be added to an image controlbox.
    
    Parameters:
    
    node - of the parent where this element is added.
    
    id - of this element
    
    layout - determines the positioning of images. Either "vertical" or "horizontal". "Vertical" is default.
    
    iconSize - specifies the size(small/mid/big) of the image. If empty then full image is shown.
    
    Returns:
    
    the node of this element. Returns 0 if unsuccessful.
  - addImage
```
public int addImage(int node,
                    java.lang.String id,
                    java.lang.String urlImage,
                    java.lang.String reference)
```
    Adds an image
    
    Parameters:
    
    node - the node of the image control box
    
    urlImage - the path of the image
    
    reference - link to datasource field, when model is attached.
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - addFrame
```
public int addFrame(int node,
                    java.lang.String urlAddress,
                    java.lang.String id)
```
    Adds a frame
    
    Parameters:
    
    node - the node of the parent where this element is added
    
    urlAddress - the url of the webpage
    
    id - identifier of this element
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - addCompositeControl
```
public int addCompositeControl(int node,
                               java.lang.String id)
```
    Adds a Composite control
    
    Parameters:
    
    node - the node of the parent where this element is added
    
    id - identifier of this element
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - addCompositeControl
```
public int addCompositeControl(int node,
                               java.lang.String id,
                               java.lang.String namespace)
```
    Adds a Composite control
    
    Parameters:
    
    node - the node of the parent where this element is added
    
    id - identifier of this element
    
    namespace - url of runtime library of this element
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - addAction
```
public int addAction(int node,
                     java.lang.String name,
                     java.lang.String source)
```
    Adds an action event to an element
    
    Parameters:
    
    node - parent element which gets this event
    
    name - name of the event
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addAction
```
public int addAction(int node,
                     java.lang.String name,
                     java.lang.String source,
                     java.lang.String assignmentsXML)
```
    Adds an action event to an element
    
    Parameters:
    
    node - parent element which gets this event
    
    name - name of the event
    
    source - script started when event is raised.
    
    assignmentsXML - the assignments xml that needs to be added to the action
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addNamespaceURI
```
public int addNamespaceURI(int modelNode,
                           java.lang.String prefix,
                           java.lang.String uri)
```
    Adds a namespace node to a model
    
    Parameters:
    
    modelNode - node of model which gets this namespace
    
    prefix - the prefix of the namespace.
    
    uri - the uri of the namespace
    
    Returns:
    
    namespace node. Returns 0 if unsuccessful.
  - addZoom
```
public int addZoom(int node,
                   java.lang.String zoomURL,
                   java.lang.String zoomField)
```
    Adds a zoom option to an input, output, textarea or text. The zoompage (xform) must already be available in the xmlStore.
    
    Parameters:
    
    node - the node of the parent (input, output, textarea, text)
    
    zoomURL - the page to be zoomed to.
    
    zoomField - the field from the zoom page to be returned to the parent element (node).
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - addZoom
```
public int addZoom(int node,
                   XFormsDef zoomPage,
                   java.lang.String idZoomPageField)
```
    Adds a zoom page to an input, output, textarea or text. The zoompage is a generated page, and the XFormsDef object has to be passed as a parameter. The zoom page must contain a table from which the user can select a line. NOTE: this function automatically adds the xforms definition as an XML to this object. Furthermore the inputfield gets a before- and afterzoom-event. So beware of this fact. An onRowSelect event is added to the table of the of zoomPage. The file "_xform_xformsdef_zoom.caf" must be available in the XMLStore.
    
    Parameters:
    
    node - of the element getting the zoom
    
    zoomPage - the xformsdef object of the zoompage, this page must contain a table.
    
    idZoomPageField - the id of the field in the zoompage that contains the data to be returned.
    
    Returns:
    
    the node of the zoom node. Returns 0 if unsuccessful.
  - addClickChoiceDocked
```
public int addClickChoiceDocked(int node,
                                java.lang.String URL,
                                java.lang.String caption,
                                java.lang.String formID,
                                java.lang.String formCaption,
                                java.lang.String formDescription,
                                java.lang.String model,
                                java.lang.String[] parameters,
                                java.lang.String frame)
```
    Adds a docked click choice option to the node.
    
    Parameters:
    
    node - element receiving the click choice, can be: input, output, textarea or text
    
    URL - the address of page to be started. Can be either an xform (must be published to runtime) or an internet address (e.g. "http://www.cordys.com")
    
    caption - the text shown to the user in the context menu when the element is right clicked
    
    formID - the id of the form to be started
    
    formCaption - caption of the form to be started
    
    formDescription - description of the form to be started
    
    model - the model of the click choice form to be started. Required when passing data from the main form to the click choice form. This model will receive the data from the element. the model of the form. Set to null or "" if not relevant
    
    parameters - array of string with the model parameter(s), which should get the value of the element. Set to null when not relevant
    
    frame - in which the click choice form is to be started: main, sub, left, leftsub, right, rightsub, header, footer, new window, header toolbar, left toolbar, right toolbar and footer toolbar
    
    Returns:
    
    the click choice node of the element
  - addClickChoiceDocked
```
public int addClickChoiceDocked(int node,
                                XFormsDef ccXForm,
                                java.lang.String caption,
                                java.lang.String formID,
                                java.lang.String formCaption,
                                java.lang.String formDescription,
                                java.lang.String model,
                                java.lang.String[] parameters,
                                java.lang.String frame)
```
    Adds a docked generated click choice option to the node. An instance of an xform can be passed, which is started as an click choice option. The xform definition of this instance is added as xml. Furthermore an onFocusIn event is added to the node, which means that another inFocus - event can not be used. An element can have only one generated click choice option.
    
    Parameters:
    
    node - element receiving the click choice, can be: input, output, textarea or text
    
    ccXForm - XFormsDef instance of the click choice form.
    
    caption - the text shown to the user in the context menu when the element is right clicked
    
    formID - the id of the form to be started
    
    formCaption - caption of the form to be started
    
    formDescription - description of the form to be started
    
    model - the model of the click choice form to be started. Required when passing data from the main form to the click choice form. This model will receive the data from the element. the model of the form. Set to null or "" if not relevant
    
    parameters - array of string with the model parameter(s), which should get the value of the element. Set to null when not relevant
    
    frame - in which the click choice form is to be started: main, sub, left, leftsub, right, rightsub, header, footer, new window, header toolbar, left toolbar, right toolbar and footer toolbar
    
    Returns:
    
    the click choice node of the element
  - addClickChoiceUnDocked
```
public int addClickChoiceUnDocked(int node,
                                  java.lang.String URL,
                                  java.lang.String caption,
                                  java.lang.String formID,
                                  java.lang.String formCaption,
                                  java.lang.String formDescription,
                                  java.lang.String model,
                                  java.lang.String[] parameters,
                                  int left,
                                  int top,
                                  int width,
                                  int height)
```
    Adds an undocked click choice option to the node.
    
    Parameters:
    
    node - element receiving the click choice, can be: input, output, textarea or text
    
    URL - the address of page to be started. Can be either an xform (must be published to runtime) or an internet address (e.g. "http://www.cordys.com")
    
    caption - the text shown to the user in the context menu when the element is right clicked
    
    formID - the id of the form to be started
    
    formCaption - caption of the form to be started
    
    formDescription - description of the form to be started
    
    model - the model of the click choice form to be started. Required when passing data from the main form to the click choice form. This model will receive the data from the element. the model of the form. Set to null or "" if not relevant
    
    parameters - array of string with the model parameter(s), which should get the value of the element. Set to null when not relevant
    
    left - distance in pixels from the left edge
    
    top - distance in pixels from the top edge
    
    width - horizontal size in pixels
    
    height - vertical size in pixels
    
    Returns:
    
    the click choice node of the element
  - addClickChoiceUnDocked
```
public int addClickChoiceUnDocked(int node,
                                  XFormsDef ccXForm,
                                  java.lang.String caption,
                                  java.lang.String formID,
                                  java.lang.String formCaption,
                                  java.lang.String formDescription,
                                  java.lang.String model,
                                  java.lang.String[] parameters,
                                  int left,
                                  int top,
                                  int width,
                                  int height)
```
    Adds an undocked generated click choice option to the node. An instance of an xform can be passed, which is started as an click choice option. The xform definition of this instance is added as xml. Furthermore an onFocusIn event is added to the node, which means that another inFocus - event can not be used. An element can have only one generated click choice option.
    
    Parameters:
    
    node - element receiving the click choice, can be: input, output, textarea or text
    
    ccXForm - XFormsDef instance of the click choice form.
    
    caption - the text shown to the user in the context menu when the element is right clicked
    
    formID - the id of the form to be started
    
    formCaption - caption of the form to be started
    
    formDescription - description of the form to be started
    
    model - the model of the click choice form to be started. Required when passing data from the main form to the click choice form. This model will receive the data from the element. the model of the form. Set to null or "" if not relevant
    
    parameters - array of string with the model parameter(s), which should get the value of the element. Set to null when not relevant
    
    left - distance in pixels from the left edge
    
    top - distance in pixels from the top edge
    
    width - horizontal size in pixels
    
    height - vertical size in pixels
    
    Returns:
    
    the click choice node of the element
  - addClickChoiceSimple
```
public int addClickChoiceSimple(int node,
                                java.lang.String URL,
                                java.lang.String caption,
                                java.lang.String model,
                                java.lang.String[] parameters,
                                int width,
                                int height)
```
    Adds an undocked click choice option to the node. The formCaption, formDescription, formID, left and top are defaulted.
    
    Parameters:
    
    node - element receiving the click choice, can be: input, output, textarea or text
    
    URL - the address of page to be started. Can be either an xform (must be published to runtime) or an internet address (e.g. "http://www.cordys.com")
    
    caption - the text shown to the user in the context menu when the element is right clicked
    
    model - the model of the click choice form to be started. Required when passing data from the main form to the click choice form. This model will receive the data from the element. the model of the form. Set to null or "" if not relevant
    
    parameters - array of string with the model parameter(s), which should get the value of the element. Set to null when not relevant
    
    width - horizontal size in pixels
    
    height - vertical size in pixels
    
    Returns:
    
    the click choice node of the element
  - addClickChoiceSimple
```
public int addClickChoiceSimple(int node,
                                XFormsDef ccXForm,
                                java.lang.String caption,
                                java.lang.String model,
                                java.lang.String[] parameters,
                                int width,
                                int height)
```
    Adds an undocked generated click choice option to the node. The formCaption, formDescription, formID, left and top are defaulted. An instance of an xform can be passed, which is started as an click choice option. The xform definition of this instance is added as xml. Furthermore an onFocusIn event is added to the node, which means that another inFocus - event can not be used. An element can have only one generated click choice option.
    
    Parameters:
    
    node - element receiving the click choice, can be: input, output, textarea or text
    
    ccXForm - XFormsDef instance of the click choice form.
    
    caption - the text shown to the user in the context menu when the element is right clicked
    
    model - the model of the click choice form to be started. Required when passing data from the main form to the click choice form. This model will receive the data from the element. the model of the form. Set to null or "" if not relevant
    
    parameters - array of string with the model parameter(s), which should get the value of the element. Set to null when not relevant
    
    width - horizontal size in pixels
    
    height - vertical size in pixels
    
    Returns:
    
    the click choice node of the element
  - setSynchronizedDialogDocked
```
public void setSynchronizedDialogDocked(int node,
                                        java.lang.String dialogXForm,
                                        java.lang.String dialogFrame,
                                        java.lang.String dialogID,
                                        java.lang.String dialogCaption,
                                        java.lang.String dialogDescription)
```
    Adds a docked synchronized dialog to a table.
    
    Parameters:
    
    node - of the table
    
    dialogXForm - the form to be shown containing the details
    
    dialogFrame - in which frame should the dialog be started: main, sub, left, leftsub, right, rightsub, header, footer, new window, header toolbar, left toolbar, right toolbar and footer toolbar
    
    dialogID - denotes the dialog ID that is opened while clicking on a row.
    
    dialogCaption - caption of the dialog page
    
    dialogDescription - description of the dialog page
  - setSynchronizedDialogSimple
```
public void setSynchronizedDialogSimple(int node,
                                        java.lang.String dialogXForm,
                                        int dialogWidth,
                                        int dialogHeight)
```
    Adds a synchronized dialog to a table, with a minimum of parameters. This will result in an undocked window at coordinates 100, 100.
    
    Parameters:
    
    node - of the table
    
    dialogXForm - the form to be shown containing the details
    
    dialogWidth - the width of the window
    
    dialogHeight - the height of the window
  - setSynchronizedDialogNotDocked
```
public void setSynchronizedDialogNotDocked(int node,
                                           java.lang.String dialogXForm,
                                           java.lang.String dialogID,
                                           java.lang.String dialogCaption,
                                           java.lang.String dialogDescription,
                                           int dialogLeft,
                                           int dialogTop,
                                           int dialogWidth,
                                           int dialogHeight,
                                           boolean newWindow)
```
    Adds an undocked synchronized dialog to a table.
    
    Parameters:
    
    node - of the table
    
    dialogXForm - the xforms page to be started
    
    dialogID - denotes the dialog ID that is opened while clicking on a row.
    
    dialogCaption - caption of the dialog page
    
    dialogDescription - description of the dialog page
    
    dialogLeft - when it is not docked, the x-coordinate of the top left corner of the dialog
    
    dialogTop - when it is not docked, the y-coordinate of the top left corner of the dialog
    
    dialogWidth - when it is not docked, the width
    
    dialogHeight - when it is not docked, the height
    
    newWindow - should the dialog be started in a new browser of in a frame
  - setSynchronizedDialogDocked
```
public void setSynchronizedDialogDocked(int node,
                                        XFormsDef xfDialog,
                                        java.lang.String dialogFrame,
                                        java.lang.String dialogID,
                                        java.lang.String dialogCaption,
                                        java.lang.String dialogDescription)
```
    Adds a docked synchronized dialog to a table. The dialog to be started from the table is a generated xform itself. The dialog should contain a single record model which shows the details of a row of the table. NOTE: an addOnBeforeSynchronizedDialogOpen event is added in this function, do not add your own. A handler xform is used to show the dialog: "_xform_xformsdef_dialog.caf", available in xml-store.
    
    Parameters:
    
    node - of the table
    
    xfDialog - the form to be shown as a synchronized dialog
    
    dialogFrame - in which frame should the dialog be started: main, sub, left, leftsub, right, rightsub, header, footer, new window, header toolbar, left toolbar, right toolbar and footer toolbar
    
    dialogID - denotes the dialog ID that is opened while clicking on a row.
    
    dialogCaption - caption of the dialog page
    
    dialogDescription - description of the dialog page
  - setSynchronizedDialogSimple
```
public void setSynchronizedDialogSimple(int node,
                                        XFormsDef xfDialog,
                                        int dialogWidth,
                                        int dialogHeight)
```
    Adds a synchronized dialog to a table, with a minimum of parameters. This will result in an undocked window at coordinates 100, 100. The dialog to be started from the table is a generated xform itself. The dialog should contain a single record model which shows the details of a row of the table. NOTE: an addOnBeforeSynchronizedDialogOpen event is added in this function, do not add your own. A handler xform is used to show the dialog: "_xform_xformsdef_dialog.caf", available in xml-store.
    
    Parameters:
    
    node - of the table
    
    xfDialog - the form to be shown as a synchronized dialog
    
    dialogWidth - the width of the window
    
    dialogHeight - the height of the window
  - setSynchronizedDialogNotDocked
```
public void setSynchronizedDialogNotDocked(int node,
                                           XFormsDef xfDialog,
                                           java.lang.String dialogID,
                                           java.lang.String dialogCaption,
                                           java.lang.String dialogDescription,
                                           int dialogLeft,
                                           int dialogTop,
                                           int dialogWidth,
                                           int dialogHeight,
                                           boolean newWindow)
```
    Adds an undocked synchronized dialog to a table. The dialog is a generated xform. The dialog to be started from the table is a generated xform itself. The dialog should contain a single record model which shows the details of a row of the table. NOTE: an addOnBeforeSynchronizedDialogOpen event is added in this function, do not add your own. A handler xform is used to show the dialog: "_xform_xformsdef_dialog.caf", available in xml-store.
    
    Parameters:
    
    node - of the table
    
    xfDialog - the form to be shown as a synchronized dialog
    
    dialogID - denotes the dialog ID that is opened while clicking on a row.
    
    dialogCaption - caption of the dialog page
    
    dialogDescription - description of the dialog page
    
    dialogLeft - when it is not docked, the x-coordinate of the top left corner of the dialog
    
    dialogTop - when it is not docked, the y-coordinate of the top left corner of the dialog
    
    dialogWidth - when it is not docked, the width
    
    dialogHeight - when it is not docked, the height
    
    newWindow - should the dialog be started in a new browser of in a frame
  - addOnBeforeSynchronizedDialogOpen
```
public int addOnBeforeSynchronizedDialogOpen(int node,
                                             java.lang.String source)
```
    Adds an on before synchronized dialog open event to a table with a synchronized dialog option. Do not use in combination with a generated dialog (where the synchronized dialog is defined by you).
    
    Parameters:
    
    node - parent element which gets this event
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addControlBar
```
public int addControlBar(int node,
                         boolean newButton,
                         boolean deleteButton,
                         boolean refreshButton)
```
    Adds a controlbar to a table, groupbox or tabGroup. By option the standard buttons new, delete and refresh can automatically be added
    
    Parameters:
    
    node - of the table
    
    newButton - should the "new" button be added
    
    deleteButton - should the "delete" button be added
    
    refreshButton - should the "refresh" button be added
    
    Returns:
    
    the node of the controlbar
  - addPaginationBar
```
public int addPaginationBar(int node,
                            boolean firstButton,
                            boolean previousButton,
                            boolean findButton,
                            boolean nextButton,
                            boolean LastButton,
                            boolean showAllButton)
```
    Adds a pagination bar to a table, groupbox or tabgroup. By option the standard buttons for: first, previous, find, next, last and showall can be added automatically.
    
    Parameters:
    
    node - of a table, groupbox or tabgroup
    
    firstButton - should the "first" button be added
    
    previousButton - should the "previous" button be added
    
    findButton - should the "find" button be added
    
    nextButton - should the "next" button be added
    
    LastButton - should the "last" button be added
    
    showAllButton - should the "show all" button be added. This button is only available for tables.
    
    Returns:
    
    the node of the controlbar
  - getToolbarButton
```
public int getToolbarButton(int node,
                            java.lang.String buttonType)
```
    Get a standard button from a toolbar, controlbar or paginationbar.
    
    Parameters:
    
    node - of the toolbar, controlbar or paginationbar
    
    buttonType - the standard button to be returned. Can be "save", "insert", "delete", "refresh", "first", "previous", "next", "last", "find" or "showall".
    
    Returns:
    
    the node of the button. Returns 0 if unsuccessful.
  - addOnBeforeClick
```
public int addOnBeforeClick(int node,
                            java.lang.String source)
```
    Adds an onbeforeclick event to a save, insert, delete or refresh button. These are infact the events:
    - onBeforeSave
    - onBeforeInsert
    - onBeforeDelete
    - onBeforeRefresh
    - onBeforeFirst
    - onBeforePrevious
    - onBeforeFind
    - onBeforeNext
    - onBeforeLast
    - onBeforeShowAll
    
    Parameters:
    
    node - insert, delete or refresh button of a controlbar, or save button of toolbar. The first, previous, find, next, last, showall of pagination bar.
    
    source - script to be executed when event is fired
    
    Returns:
    
    node of the event. Returns 0 if unsuccessful
  - addOnAfterClick
```
public int addOnAfterClick(int node,
                           java.lang.String source)
```
    Adds an onafterclick event to a save, insert, delete or refresh button. These are in fact the evnts:
    - onAfterSave
    - onAfterInsert
    - onAfterDelete
    - onAfterRefresh
    - onAfterFirst
    - onAfterPrevious
    - onAfterFind
    - onAfterNext
    - onAfterLast
    - onAfterShowAll
    
    Parameters:
    
    node - insert, delete or refresh button of a controlbar, or save button of toolbar. The first, previous, find, next, last, showall of pagination bar.
    
    source - script to be executed when event is fired
    
    Returns:
    
    node of the event. Returns 0 if unsuccessful
  - addToolbarButton
```
public int addToolbarButton(int node,
                            java.lang.String id,
                            java.lang.String imageURL)
```
    Adds a custom button to a toolbar, controlbar or paginationbar.
    
    Parameters:
    
    node - of the toolbar, controlbar or paginationbar
    
    id - of the button
    
    imageURL - the URL to the image (.gif) which is displayed on the button
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - addToolbarSeparator
```
public int addToolbarSeparator(int node)
```
    Adds a separator to the selected toolbar, controlbar or paginationbar.
    
    Parameters:
    
    node - of the toolbar, controlbar or paginationbar
    
    Returns:
    
    int node, the node of the separator. Returns 0 if unsuccessful.
  - addToolbar
```
public int addToolbar(boolean saveButton)
```
    Adds a toolbar to the form. The parameter determines whether the toolbar gets a standard save button.
    
    Parameters:
    
    saveButton - should the standard save button be added or not.
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - createEmptyNode
```
public int createEmptyNode()
```
    Creates an empty node. For creating a structure, which has to be added several times to the xform. Use the addNode function to add this node to your xform. The function is very handy when you have element structures that appear many times in your xform.
    
    Returns:
    
    int node
  - addNode
```
public void addNode(int elementNode,
                    int destinationNode)
```
    Adds a copy of a predefined node (elementNode), created with the function createEmptyNode to the destinationNode. The top node of elementNode is not added, only a copy of the children of elementNode are added to the destinationNode. The elementNode can contain any number of elements and functions. NOTE: when variations of elementNode have to be added to the xform, first make the changes and then add the result. Since a copy of the children is added, you lose the nodes of the (copied) children, so it's hard to make changes after adding the node.
    
    Parameters:
    
    elementNode - element or collection of elements
    
    destinationNode - location where the elementNode is added
  - moveNode
```
public void moveNode(int node,
                     int newParent)
```
    Moves a node (and its children) from its current parent, to a new parent
    
    Parameters:
    
    node - to be moved
    
    newParent - the target parent, the node is appended to the children of the newParent
  - copyNode
```
public void copyNode(int node,
                     int newParent)
```
    Copies a node (and its children) to the new parent.
    
    Parameters:
    
    node - to be copied
    
    newParent - the target parent, the node is appended to the children of the newParent
  - deleteNode
```
public void deleteNode(int node)
```
    Deletes the node including its children. Deleting an element will delete all linked events, tooltips, sub-elements etc. It will not delete attached models (just the reference is deleted). All nodes can be deleted except the xformsDefinition, main form node and a splitterpage. When a splitter is deleted, the corresponding splitterpages are also deleted. When children of splitterpages must be saved, use function deleteSplitterNode()
    
    Parameters:
    
    node - the node to be deleted
  - deleteSplitterNode
```
public void deleteSplitterNode(int node)
```
    Delete the splitter, moves the elements in the splitterpages to the parent of the splitter. Compensates for offset. When all the children of the splitter page must be deleted, use function deleteNode()
    
    Parameters:
    
    node - the node of a splitter to be deleted
  - getAllChildren
```
public int[] getAllChildren(int node)
```
    Returns an integer array with all the children (elements) that have been added to this node. Labels of groupbox or tabpage label are ingored as being children (these have not been seperatly added).
    
    Parameters:
    
    node - of which the children are required, group, groupbox, table, tabgroup etc.
    
    Returns:
    
    array of int with all the nodes of the children
  - canAddElement
```
public boolean canAddElement(int node)
```
    Checks whether a form control/element can be added to the node. Formcontrols/elements can be added to mainform, groupbox, group, tabpage, splitterpage, table. Mainform, groupbox, group, tabpage, splitterpage containing a splitter can not have an element added. In that case the element should be added to the sub splitterpage.
    
    Parameters:
    
    node -
    
    Returns:
    
    true if it is possible to add an form control
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a string of the caf/xform definition
  - setFormatToInteger
```
public void setFormatToInteger(int node,
                               boolean required,
                               java.lang.String textAlignment,
                               java.lang.String locale,
                               java.lang.String displayformat,
                               java.lang.String negativePattern)
```
    Sets the format of the element to an integer.
    
    Parameters:
    
    node - of input, output, password, textarea, select or list
    
    required - is data required/mandatory in this field or can it be left empty
    
    textAlignment - determines the alignment of the text in the field. Can be "left", "center" or "right". For the default value set to null or "";
    
    locale - for setting to country specific format. Use e.g. "nl-NL", "en-US", "hi-IN" etc
    
    displayformat - determines the way the value is displayed. Use only # and 0. E.g. "#,###", "#,#00"
    
    negativePattern - determines the position of the minus sign. Possible values: "-n", "- n", "n-", "n -". Default is "-n".
  - setFormatToCreditcard
```
public void setFormatToCreditcard(int node,
                                  boolean required,
                                  java.lang.String textAlignment)
```
    Sets the field to creditcard format.
    
    Parameters:
    
    node - of input, output, password, textarea, select or list
    
    required - is data required/mandatory in this field or can it be left empty
    
    textAlignment - determines the alignment of the text in the field. Can be "left", "center" or "right". For the default value set to null or "";
  - setFormatToFloat
```
public void setFormatToFloat(int node,
                             boolean required,
                             java.lang.String textAlignment,
                             java.lang.String locale,
                             java.lang.String displayformat,
                             java.lang.String negativePattern,
                             int numberOfDecimals)
```
    Sets the format of the element to a float.
    
    Parameters:
    
    node - of input, output, password, textarea, select or list
    
    required - is data required/mandatory in this field or can it be left empty
    
    textAlignment - determines the alignment of the text in the field. Can be "left", "center" or "right". For the default value set to null or "";
    
    locale - for setting to country specific format. Use e.g. "nl-NL", "en-US", "hi-IN" etc
    
    displayformat - determines the way the value is displayed. E.g.: "#,###.00", "(##)-##0", "#0.# %", "0000.00", "0#,##0.00"
    
    negativePattern - determines the position of the minus sign. Possible values: "-n", "- n", "n-", "n -". Default is "-n".
    
    numberOfDecimals - rounds the value to the specified number of decimals. If not required set to -1
  - setFormatToString
```
public void setFormatToString(int node,
                              boolean required,
                              java.lang.String textAlignment,
                              int minLength,
                              int maxLength,
                              java.lang.String legalCharacters,
                              java.lang.String illegalCharacters)
```
    Sets the format of the element to a string.
    
    Parameters:
    
    node - of input, output, password, textarea, select or list
    
    required - is data required/mandatory in this field or can it be left empty
    
    textAlignment - determines the alignment of the text in the field. Can be "left", "center" or "right". For the default value set to null or "";
    
    minLength - minimum number of characters. If not required set to -1
    
    maxLength - maximum number of characters. If not required set to -1
    
    legalCharacters - specify the legal characters, like "abc"
    
    illegalCharacters - specify the illegal characters, like "[0-9]"
  - setFormatToMail
```
public void setFormatToMail(int node,
                            boolean required,
                            java.lang.String textAlignment)
```
    Sets the format of the element to an e-mail format.
    
    Parameters:
    
    node - of input, output, password, textarea, select or list
    
    required - is data required/mandatory in this field or can it be left empty
    
    textAlignment - determines the alignment of the text in the field. Can be "left", "center" or "right". For the default value set to null or "";
  - setFormatToAmount
```
public void setFormatToAmount(int node,
                              boolean required,
                              java.lang.String textAlignment,
                              java.lang.String locale,
                              java.lang.String displayformat,
                              java.lang.String negativePattern,
                              java.lang.String positivePattern,
                              java.lang.String currency,
                              int numberOfDecimals)
```
    Sets the format of the element to an amount.
    
    Parameters:
    
    node - of input, output, password, textarea, select or list
    
    required - is data required/mandatory in this field or can it be left empty
    
    textAlignment - determines the alignment of the text in the field. Can be "left", "center" or "right". For the default value set to null or "";
    
    locale - for setting to country specific format. Use e.g. "nl-NL", "en-US", "hi-IN" etc
    
    displayformat - determines the way the value is displayed. Use "#", "," and/or "."
    
    negativePattern - determines the position of currency symbol and minus sign. Options: ($n), -$n, $-n, $n-, (n$), -n$, n-$, n$-, ($ n), -$ n, $ -n, $ n-, (n $), -n $, n- $, and n $-,
    
    positivePattern - determines the position of currency symbol. Options $n, n$, $ n, and n $
    
    currency - the literal value such as $, or by the ASCII value such as 38 (for $), or by the Unicode value such as $ (for $).
    
    numberOfDecimals - rounds the value to the specified number of decimals. If not required set to -1
  - setFormatToDate
```
public void setFormatToDate(int node,
                            boolean required,
                            java.lang.String textAlignment,
                            java.lang.String locale,
                            java.lang.String displayformat,
                            java.lang.String timeZone)
```
    Sets the format of the element to a date. An date select button is added automatically in renderer
    
    Parameters:
    
    node - of input, output, password, textarea, select or list
    
    required - is data required/mandatory in this field or can it be left empty
    
    textAlignment - determines the alignment of the text in the field. Can be "left", "center" or "right". For the default value set to null or "";
    
    locale - for setting to country specific format. Use e.g. "nl-NL", "en-US", "hi-IN" etc
    
    displayformat - e.g. "dd-MMM-yyyy" for 03-Jul-1980. Or use
    -"shortdate",
    -"shortdate shorttime",
    -"shortdate longtime",
    -"longdate",
    -"longdate shorttime",
    -"longdate longtime",
    -"longtime",
    -"shorttime".
    
    timeZone - set to e.g. "Europe/Amsterdam", "GMT-4"
  - setFormatSetMinValue
```
public void setFormatSetMinValue(int node,
                                 double minValue)
```
    Sets the minimum value of an integer, float or amount field
    
    Parameters:
    
    node - of input, output, password, textarea, select or list
    
    minValue -
  - setFormatSetMaxValue
```
public void setFormatSetMaxValue(int node,
                                 double maxValue)
```
    Sets the maximum value of an integer, float or amount field
    
    Parameters:
    
    node - of input, output, password, textarea, select or list
    
    maxValue -
  - setSize
```
public void setSize(int node,
                    int width,
                    int height)
```
    Sets the size of an element
    
    Parameters:
    
    node - element which size has to be set
    
    width - in px. Default value is 200px
    
    height - in px. Default value is 200px
  - setSize
```
public void setSize(int node,
                    java.lang.String width,
                    java.lang.String height)
```
    Sets the size of an element. If width or height values are not valid then this API doesn't set size.
    
    Parameters:
    
    node - element which size has to be set
    
    width - width of an element. eg. null or 100px or 100%.
    
    height - height of an element e.g. null or 100px or 100%
  - setSizeLabel
```
public void setSizeLabel(int node,
                         int width)
```
    Sets the width of the label of an input, output, password, textarea, select or list. This is only relevant when the alignment of the label is left or right.
    
    Parameters:
    
    node - of input, output, password, textarea, select or list.
    
    width - of label in px
  - setColumnsTableWidthAutomatic
```
public void setColumnsTableWidthAutomatic(int node)
```
    This function automatically sets the size of the columns in a table to equal width, such that the width of all the columns equal the width of the entier table. This results in no scrollbar and no blank column space
    
    Parameters:
    
    node - of table
  - setAnchor
```
public void setAnchor(int node,
                      java.lang.String leftValue,
                      java.lang.String topValue,
                      java.lang.String rightValue,
                      java.lang.String bottomValue)
```
    Sets the anchors of a control. For this, the control/element must be in free layout.
    Pass like: setAnchor(node, "20%", "50", "60%", "null");
    The values have to be set like e.g.:
    20% 50 60% null , anchors element to top at distance of 50, at relative distance 20% from left
    null 65% 30 25% , anchors element to right at distance of 30, at relative distance 65% from top
    60% null 30% 10 , anchors element to bottom at distance 10, relative distance 60% from left
    null 10% 0 60% , anchors AND fixes element to right by setting to "0", element will resize when parent is resized
    null null 50 40 , anchors element to right and bottom at distance 50 and 40
    0 0 0 0 , anchors and fixed all sides to the edge of the parent
    
    When values are not in correct format, the anchors are NOT set.
    Also, note that both top and bottom or left and right cannot be NULL i.e. if top is NULL then bottom cannot be.
    
    Parameters:
    
    node - of the element to be anchored
    
    leftValue - absolute or relative distance from left side of parent. Can be e.g.: "20%", "20" or "null"
    
    topValue - absolute or relative distance from top side of parent. Can be e.g.: "20%", "20" or "null"
    
    rightValue - absolute or relative distance from right side of parent. Can be e.g.: "20%", "20" or "null"
    
    bottomValue - absolute or relative distance from bottom side of parent. Can be e.g.: "20%", "20" or "null"
  - setLayout
```
public void setLayout(int node,
                      java.lang.String layout)
```
    Sets the default layout of mainform, groupbox, group, tabpage, splitterpage. This layout will be the default for the elements added to this group. The layout of the main form can be set by passing the root node. When the group has children, then the layout of these children are updated to match the parent. Unless the child has layout "free", then it remains "free".
    
    Parameters:
    
    node - element which layout has to be set.
    
    layout - "horizontal" , "vertical", "free",
  - setFreePositioning
```
public void setFreePositioning(int node,
                               boolean freePositioning)
```
    Independent of the layout of the parent, each element can be set to freePositioning. When freePositioning = true the default layout of the parent is ignored and using the functions setPosition() and setSize() the exact location can be set. When freePositioning=false the layout of the parent is used.
    
    Parameters:
    
    node -
    
    freePositioning -
  - getLayout
```
public java.lang.String getLayout(int node)
```
    Gets the default layout of mainform, groupbox, group, tabpage, splitterpage. This layout is the default for the elements added to this group. The layout of the main form can be set by passing the root node.
    
    Parameters:
    
    node -
    
    Returns:
    
    String with the layout. Returns null when no layout was found.
  - getLayoutElement
```
public java.lang.String getLayoutElement(int node)
```
    Gets the layout of an element. Layout can be "horizontal" , "vertical", "free". It is the layout of the element, not the default layout for its children.
    
    Parameters:
    
    node - , node of the element which layout is required
    
    Returns:
    
    String with the layout. Returns null when no layout was found.
  - setLabelAlignment
```
public void setLabelAlignment(int node,
                              java.lang.String alignment,
                              boolean setAlignmentOfSubElements)
```
    Sets the alignment of the label of an element, or sets the default alignment of a groupbox, group, tabpage, main form or splitgroup. For simple elements the alignment of a label can be: "ontop", "left", "right" or "hide" For group elements the alignment of the label can be: "ontop", "left", or "right". To hide the header of a groupbox there is the function: hideGroupBoxHeader. When the default alignment of a group is set, the setAlignmentOfSubElements=true parameter updates the label alignments of the child elements of the group. Only the direct children of the group are effected, not elements in subgroups.
    
    Parameters:
    
    node - of element of which the label alignment has to be set. Or the node of the group(box), tabpage, main form or splitgroup.
    
    alignment - can be "ontop", "left", "right" or "hide"
    
    setAlignmentOfSubElements - do the subelement of the group need to be realigned as well.
  - hideGroupBoxHeader
```
public void hideGroupBoxHeader(int node)
```
    Hides the header of a groupbox
    
    Parameters:
    
    node - of the groupbox
  - setPosition
```
public void setPosition(int node,
                        int x_coordinate,
                        int y_coordinate)
```
    Sets the position of an element to x,y coordinates. Only applicable when the layout of the form or group (where the element is located) is "free"
    
    Parameters:
    
    node - of the element to be positioned
    
    x_coordinate - in pixels >=0
    
    y_coordinate - in pixels >=0
  - setTooltip
```
public void setTooltip(int node,
                       java.lang.String tooltip)
```
    Adds a tooltip to an element. Element can be input, output, password, textarea, button, checkbox, groupbox, group, tabpage and image
    
    Parameters:
    
    node - of element which gets the tooltip
    
    tooltip - text to be shown in tooltip
  - setloadOnDemand
```
public void setloadOnDemand(int node,
                            java.lang.Boolean loadOnDemand)
```
    loadOnDemand
    
    Parameters:
    
    node - of element to set the loadOnDemand. Can be Tabpage
    
    loadOnDemand - Sets the control as a load-on-demand control. This means that when a page is loaded for the first time at run time, the control is initialized (loaded with content) only when you click it.
  - setResizable
```
public void setResizable(int node,
                         java.lang.Boolean resizable)
```
    Resizable
    
    Parameters:
    
    node - of element to set the Resizable. Can be groupbox, table, tabpage, textarea
    
    resizable - Specifies whether the control is resizable or not
  - setSaveGridState
```
public void setSaveGridState(int node,
                             java.lang.Boolean saveGridState)
```
    SaveGridState
    
    Parameters:
    
    node - of table to set the SaveGridState. Can be only table
    
    saveGridState - Specifies if modifications made to the Table control (column size and placement) will be retained when the XForm is visited again at runtime.
  - setDisplayContextMenu
```
public void setDisplayContextMenu(int node,
                                  java.lang.Boolean displayContextMenu)
```
    DisplayContextMenu
    
    Parameters:
    
    node - of table to set the DisplayContextMenu. Can be only table
    
    displayContextMenu - The boolean value that denotes whether a context menu will appear when you right-click the header of the Table control.
  - setToggleColumns
```
public void setToggleColumns(int node,
                             java.lang.Boolean toggleColumns)
```
    ToggleColumns
    
    Parameters:
    
    node - of table to set the ToggleColumns. Can be only table
    
    toggleColumns - Sets or retrieves the boolean value that denotes whether the columns of the Table control can be toggled (to show and hide them) at run time.
  - setMinRows
```
public void setMinRows(int node,
                       int minRows)
```
    MinRows
    
    Parameters:
    
    node - of table to set the MinRows. Can be only table
    
    minRows - Sets the minimum value rows that should be shown at run time.
  - setMovableColumns
```
public void setMovableColumns(int node,
                              java.lang.Boolean movableColumns)
```
    MovableColumns
    
    Parameters:
    
    node - of table to set the MovableColumns. Can be only table
    
    movableColumns - Sets or retrieves the boolean value that denotes whether the columns of the Table control can be moved at run time.
  - setAutoInsert
```
public void setAutoInsert(int node,
                          java.lang.Boolean autoInsert)
```
    AutoInsert
    
    Parameters:
    
    node - of table to set the AutoInsert. Can be only table
    
    autoInsert - Sets or retrieves the boolean value that Adds a new, empty row to the table when you enter valid data in the last row of the table. This is applicable for a table associated with a transactional data model only.
  - setColumnSortable
```
public void setColumnSortable(int node,
                              java.lang.Boolean columnSortable)
```
    ColumnSortable
    
    Parameters:
    
    node - of table to set the ColumnSortable. Can be only table
    
    columnSortable - Sets or retrieves the boolean value to enable sorting of columns in the control.
  - setShowSingleTab
```
public void setShowSingleTab(int node,
                             java.lang.Boolean showSingleTab)
```
    ShowSingleTab
    
    Parameters:
    
    node - of TabGroup to set the Show tab header always. Can be only TabGroup
    
    showSingleTab - Sets or retrieves the boolean value to Show tab header always
  - setTabIndex
```
public void setTabIndex(int node,
                        int tabIndex)
```
    Sets the tabIndex of the node. It is better to set the parameter "focus at startup" to false, using the function setFocusAtStartup.
    
    Parameters:
    
    node - of element to set the tabIndex. Can be input, password, checkbox, select, list, textarea, button or frame
    
    tabIndex - this number sets the priority in the tab sequence, must be >=1. tabIndex = 2 comes after 1 before 3
  - addSplitter
```
public int addSplitter(int node,
                       java.lang.String type,
                       int offSet,
                       boolean takePositionIntoAccount)
```
    Adds a splitter to a groupbox, group, mainform, tabpage or splitterpage.
    
    Parameters:
    
    node - the node that will get the splitter
    
    type - four possibilities: "left", "right", "top" or "bottom". Where:
    - "left" gives a vertical splitter, with a fixed area width left of the splitter, size: offset. So the right side resizes when the parent resizes
    - "right" gives a vertical splitter, with a fixed area width right of the splitter of size: offset.
    - "top" gives a horizontal splitter, with a fixed top height of size: offset.
    - "bottom" gives a horizontal splitter, with a fixed bottom height of size: offset.
    
    offSet - the distance from the border of the parent to the splitter.
    
    takePositionIntoAccount - a splitter can be added to a group that already has elements. This parameter determines what happens with the elements. The elements are copied to one of the splitterpages. There are different options:
    - false or node has a "vertical" or "horizontal" layout, all the elements will be moved to the left or top splitterpage. Depending whether the splitter is vertical or horizontal.
    - true and node has a "free" layout. When the coordinates/position of an element is beyond the offset, all the elements are moved to the "bottom" or "right" splitterpage. All other elements are moved to the "left" or "top" splitterpage (depending of the type of splitter).
    
    Returns:
    
    node of the splitter
  - getSplitterPage
```
public int getSplitterPage(int node,
                           java.lang.String type)
```
    Returns the splitter page, which is automatically create when a splitter is added to a group
    
    Parameters:
    
    node - of the splitter page
    
    type - : "left", "right", "top" or "bottom"
    
    Returns:
    
    the node of the splitterpage. Returns 0 if unsuccessful
  - addOnClick
```
public int addOnClick(int node,
                      java.lang.String source)
```
    Adds an OnClick event (only for a button and image). The standard toolbar buttons save, insert, delete, refresh, first etc already have a standard onclick.
    
    Parameters:
    
    node - of the button or image
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addOnChange
```
public int addOnChange(int node,
                       java.lang.String source)
```
    Adds an OnChange event to an element
    
    Parameters:
    
    node - parent element which gets this event
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addOnBeforeBind
```
public int addOnBeforeBind(int node,
                           java.lang.String source)
```
    Adds an OnBeforeDataBind event to an element
    
    Parameters:
    
    node - parent element which gets this event
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addOnValidate
```
public int addOnValidate(int node,
                         java.lang.String source)
```
    Adds an OnValidate event to an element
    
    Parameters:
    
    node - parent element which gets this event
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addOnFocusIn
```
public int addOnFocusIn(int node,
                        java.lang.String source)
```
    Adds an OnFocusIn event to an element
    
    Parameters:
    
    node - parent element which gets this event
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addOnFocusOut
```
public int addOnFocusOut(int node,
                         java.lang.String source)
```
    Adds an OnFocusOut event to an element
    
    Parameters:
    
    node - parent element which gets this event
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addOnBeforeZoom
```
public int addOnBeforeZoom(int node,
                           java.lang.String source)
```
    Adds an OnBeforeZoom event to an element (input, output, textarea or text)
    
    Parameters:
    
    node - parent element which gets this event
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addOnAfterZoom
```
public int addOnAfterZoom(int node,
                          java.lang.String source)
```
    Adds an OnAfterZoom event to an element (input, output, textarea or text)
    
    Parameters:
    
    node - parent element which gets this event
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addOnRowSelect
```
public int addOnRowSelect(int node,
                          java.lang.String source)
```
    Adds an onRowSelect event to a table.
    
    Parameters:
    
    node - of the table
    
    source - script to be executed when event fires
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addOnRowChecked
```
public int addOnRowChecked(int node,
                           java.lang.String source)
```
    Adds an onRowChecked event to a table. Fired when a row is checked.
    
    Parameters:
    
    node - of the table
    
    source - script to be executed when event fires
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addOnBeforeRowBind
```
public int addOnBeforeRowBind(int node,
                              java.lang.String source)
```
    Adds an addOnBeforeRowBind event to a table.
    
    Parameters:
    
    node - of the table
    
    source - script to be executed when event fires
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addOnBeforeFill
```
public int addOnBeforeFill(int node,
                           java.lang.String source)
```
    Adds an onBeforeFill event to a select or a list
    
    Parameters:
    
    node - of the select or list
    
    source - script to be executed when event fires
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addGlobalScript
```
public void addGlobalScript(java.lang.String source)
```
    Adds a global script (allows for defining global variables).
    
    Parameters:
    
    source - the script to be added outside the existing functions
  - addXML
```
public int addXML(java.lang.String id,
                  java.lang.String textXML)
```
    Adds XML to the xform. The id xml node is added automatically: <xml id="..">...your xml ...</xml>
    
    Parameters:
    
    id - the id of the xmlNode
    
    textXML - string contain the XML
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - linkJavaScript
```
public int linkJavaScript(java.lang.String scriptURL)
```
    Adds a link to a javascript source
    
    Parameters:
    
    scriptURL - address of the source
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - linkStyleSheet
```
public int linkStyleSheet(java.lang.String styleSheetURL)
```
    Adds a link to a style sheet
    
    Parameters:
    
    styleSheetURL - address of the style sheet
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - setStyleClass
```
public void setStyleClass(int node,
                          java.lang.String styleClassName)
```
    Sets the style class of an element
    
    Parameters:
    
    node - the node of the element
    
    styleClassName - the name of the style class
  - addOnFormInit
```
public int addOnFormInit(java.lang.String source)
```
    Adds an init event to the main form, fires when form is started
    
    Parameters:
    
    source - executed when event is raised
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - addOnFormInitDone
```
public int addOnFormInitDone(java.lang.String source)
```
    Adds an init done event to the main form, fires when form has been loaded
    
    Parameters:
    
    source - executed when event is raised
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - addOnBeforeClose
```
public int addOnBeforeClose(java.lang.String source)
```
    Adds an onbeforeclose event to the xform. This event is fired when xform is closed
    
    Parameters:
    
    source - executed when event is raised
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - addModel
```
public int addModel(java.lang.String id,
                    java.lang.String src,
                    java.lang.String businessElement,
                    java.lang.String type)
```
    Adds a model to the form. By default data request automatic= true, and non-transactional=false, receiver is empty. When these defaults are not sufficient use the function setModelProperties.
    
    Parameters:
    
    id - identifier of the model
    
    src - the namespace and name of the method. E.g.: "http://schemas.cordys.com/1.0/demo/northwind/GetEmployees"
    
    businessElement - denotes the name of the business object that is retrieved from the backend. This is often the table name.
    
    type - "get", "next" or "previous"
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - addModel
```
public int addModel(java.lang.String id,
                    java.lang.String src,
                    java.lang.String businessElement,
                    java.lang.String type,
                    java.lang.String[] parameterLabels)
```
    Adds a model to the form. By default data request automatic is true, and non-transactional is false, receiver is empty. When these defaults are not sufficient use the function setModelProperties.
    
    Parameters:
    
    id - identifier of the model
    
    src - the namespace and name of the method. E.g.: "http://schemas.cordys.com/1.0/demo/northwind/GetEmployees"
    
    businessElement - denotes the name of the business object that is retrieved from the backend. This is often the table name.
    
    type - "get", "next" or "previous"
    
    parameterLabels - array of string with the parameter names of the method to be sent to backend (values will be "")
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - addModel
```
public int addModel(java.lang.String id,
                    java.lang.String src,
                    java.lang.String businessElement,
                    java.lang.String type,
                    java.lang.String[] parameterLabels,
                    java.lang.String[] parameterValues)
```
    Adds a model to the form. By default data request automatic is true, non-transactional is false, receiver is empty and promptToSave is true. When these defaults are not sufficient use the function setModelProperties.
    
    Parameters:
    
    id - identifier of the model
    
    src - the namespace and name of the method. E.g.: "http://schemas.cordys.com/1.0/demo/northwind/GetEmployees"
    
    businessElement - denotes the name of the business object that is retrieved from the backend. This is often the table name.
    
    type - "get", "next" or "previous"
    
    parameterLabels - array of string with the parameter names to be sent to backend
    
    parameterValues - array of string with the parameter values to be sent to backend
    
    Returns:
    
    int node, the node of this element. Returns 0 if unsuccessful.
  - generateURLForOLD
```
public static java.lang.String generateURLForOLD(java.lang.String url)
```
    For OLD Support correcting the absolute URLs
    
    Parameters:
    
    url - path of the stylesheet, html, js file, image, caf
  - setModelProperties
```
public void setModelProperties(int modelNode,
                               boolean automatic,
                               boolean nonTransactional,
                               boolean promptToSave,
                               java.lang.String gateway,
                               java.lang.String receiver,
                               int timeout)
```
    Sets some extra properties of a model. This is only required when defaults of the addModel function are not sufficient.
    
    Parameters:
    
    modelNode - node of the model (must be model)
    
    automatic - denotes whether the request is to be fired automatically to the back end when the form is loaded or not
    
    nonTransactional - the model data need not confirm to the Cordys protocol if true
    
    promptToSave - if true the user will be prompted when exiting the form in casen data has been changed which could be saved.
    
    gateway - if "" (empty string) then default remains. Denotes the URL of the gateway to which the request is sent from the model. By default, this contains the Cordys web gateway URL. However, this can also be the URL of a Web Service to which the request can be sent.
    
    receiver - Denotes the receiver to which the web gateway sends the request. This can be the DN of a SOAP Node or SOAP Processor or Connection Point, when the gateway is set to Cordys gateway. This does not apply if the gateway is set to a Web Service URL.
    
    timeout - time in miliseconds the webserver has to wait for response from backend. (-1 for no timeout)
  - setNextMethodOfModel
```
public void setNextMethodOfModel(int modelNode,
                                 java.lang.String src)
```
    Adds a next method to a model, to retrieve the next set of records/data from the back end from the GET position. This should not be set for non-transactional models.
    
    Parameters:
    
    src - the namespace and name of the method. E.g.: "http://schemas.cordys.com/1.0/demo/northwind/GetEmployees"
    
    modelNode - the node of the model that requires the next method
  - setPreviousMethodOfModel
```
public void setPreviousMethodOfModel(int modelNode,
                                     java.lang.String src)
```
    Adds a previous method to model, to retrieve the previous set of records/data from the back end from the GET position. This should not be set for non-transactional models.
    
    Parameters:
    
    src - the namespace and name of the method. E.g.: "http://schemas.cordys.com/1.0/demo/northwind/GetPreviousEmployees"
    
    modelNode - the node of the model that requires the next method
  - setAssociatedModel
```
public void setAssociatedModel(int mainModelNode,
                               int subModelNode)
```
    The subModel will be associated with the mainModel. Possible references are set to default (parameter names are identical), but can be overwitten with setAssociatedReference function.
    
    Parameters:
    
    mainModelNode - node of the leading model
    
    subModelNode - node of the model, which is associated with the mainModel
  - setAssociatedModel
```
public void setAssociatedModel(int mainModelNode,
                               int subModelNode,
                               boolean isSingleTransaction)
```
    The subModel will be associated with the mainModel. Possible references are set to default (parameter names are identical), but can be overwitten with setAssociatedReference function.
    
    Parameters:
    
    mainModelNode - node of the leading model
    
    subModelNode - node of the model, which is associated with the mainModel
    
    isSingleTransaction - boolean value to enable or disable single transaction in the subModel
  - setAssociatedReference
```
public void setAssociatedReference(int subModelNode,
                                   java.lang.String parameterField,
                                   java.lang.String referenceField)
```
    The references of the parameters of a subModel are set, to the referenceField.
    
    Parameters:
    
    subModelNode -
    
    parameterField - the parameter of the subModel that gets the reference
    
    referenceField - the reference field of the mainModel
  - linkModelWithElement
```
public void linkModelWithElement(int modelNode,
                                 int elementNode)
```
    Links a model to an element. To fill a select or list with data from a model, the function fillSelectWithModel can be used.
    
    Parameters:
    
    modelNode - node of model to be linked with an element
    
    elementNode - node of element which value () is determined by model
  - fillSelectWithModel
```
public void fillSelectWithModel(int modelNode,
                                int elementNode,
                                java.lang.String description,
                                java.lang.String value)
```
    Links a model with a select or a list, to fill the options of the select or list. To view the active value use linkModelWithElement.
    
    Parameters:
    
    modelNode - node of model to be linked with an element
    
    elementNode - node of select or list.
    
    description - datasource field shown to the user
    
    value - datasource field set as value in the select
  - setEBIModel
```
public boolean setEBIModel(int modelNode,
                           boolean isEBIModelValue,
                           boolean isConstraintValidation,
                           boolean isApplyAccessControl,
                           boolean isInitializationRequired)
```
    Parameters:
    
    modelNode -
    
    isEBIModelValue - XForms needs to be enabled for dealing woth EBI defined logic .To enable this should be true.
    
    isConstraintValidation - By enabling this user can validate object/attributes.
    
    isApplyAccessControl - By enabling this user can restrict access to object/attributes
    
    isInitializationRequired - When user inserts new object user can give default values to objects/attributes by setting this as true.
    
    Returns:
    
    true if sucessful
  - setEBIInitializeValueSets
```
public boolean setEBIInitializeValueSets(int selectNode,
                                         int isInitializeValueSets)
```
    To enable InitializeValueSets for select controls select node should attach to any one EBI model.
    
    Parameters:
    
    selectNode -
    
    isInitializeValueSets -
    
    Returns:
    
    true if successful in setting of isInitializeChoices value to selectNode
  - setEBIValidation
```
public boolean setEBIValidation(int control,
                                boolean isConstraintValidation)
```
    For input,checkbox,select,password,textarea controls EBI validation property can be set. To enable validation on controls user should attach controls to a EBI model.
    
    Parameters:
    
    control -
    
    isConstraintValidation -
    
    Returns:
    
    true if successful in setting of isValidationRequired value to control node.
  - addModelBeforeEBIValidate
```
public int addModelBeforeEBIValidate(int modelNode,
                                     java.lang.String source)
```
    Adds an BeforeEBIValidate event to a WsAppsmodel
    
    Parameters:
    
    modelNode - the node of the model
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addModelAfterEBIValidate
```
public int addModelAfterEBIValidate(int modelNode,
                                    java.lang.String source)
```
    Adds an AfterEBIValidate event to a WsAppsmodel
    
    Parameters:
    
    modelNode - the node of the model
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addModelOnAfterInsert
```
public int addModelOnAfterInsert(int modelNode,
                                 java.lang.String source)
```
    Adds an OnAfterInsert event to a model
    
    Parameters:
    
    modelNode - the node of the model
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addModelOnBeforeInsert
```
public int addModelOnBeforeInsert(int modelNode,
                                  java.lang.String source)
```
    Adds an OnBeforeInsert event to a model
    
    Parameters:
    
    modelNode - the node of the model
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addModelOnChange
```
public int addModelOnChange(int modelNode,
                            java.lang.String source)
```
    Adds an OnChange event to a model
    
    Parameters:
    
    modelNode - the node of the model
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addModelOnBeforeChange
```
public int addModelOnBeforeChange(int modelNode,
                                  java.lang.String source)
```
    Adds an OnBeforeChange event to a model
    
    Parameters:
    
    modelNode - the node of the model
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addModelOnAfterChange
```
public int addModelOnAfterChange(int modelNode,
                                 java.lang.String source)
```
    Adds an OnAfterChange event to a model
    
    Parameters:
    
    modelNode - the node of the model
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addModelOnDelete
```
public int addModelOnDelete(int modelNode,
                            java.lang.String source)
```
    Adds an OnDelete event to a model
    
    Parameters:
    
    modelNode - the node of the model
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addModelOnBeforeDelete
```
public int addModelOnBeforeDelete(int modelNode,
                                  java.lang.String source)
```
    Adds an OnBeforeDelete event to a model
    
    Parameters:
    
    modelNode - the node of the model
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addModelOnAfterDelete
```
public int addModelOnAfterDelete(int modelNode,
                                 java.lang.String source)
```
    Adds an OnAfterDelete event to a model
    
    Parameters:
    
    modelNode - the node of the model
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addModelOnInsert
```
public int addModelOnInsert(int modelNode,
                            java.lang.String source)
```
    Adds an OnInsert event to a model
    
    Parameters:
    
    modelNode - the node of the model
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addModelOnSynchronized
```
public int addModelOnSynchronized(int modelNode,
                                  java.lang.String source)
```
    Adds an OnSynchronized event to a model
    
    Parameters:
    
    modelNode - the node of the model
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addModelOnRequest
```
public int addModelOnRequest(int modelNode,
                             java.lang.String source)
```
    Adds an OnRequest event to a model
    
    Parameters:
    
    modelNode - the node of the model
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addModelOnSOAPFault
```
public int addModelOnSOAPFault(int modelNode,
                               java.lang.String source)
```
    Adds an OnSOAPFault event to a model
    
    Parameters:
    
    modelNode - the node of the model
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addModelOnResponse
```
public int addModelOnResponse(int modelNode,
                              java.lang.String source)
```
    Adds an OnResponse event to a model
    
    Parameters:
    
    modelNode - the node of the model
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addModelOnDataCompleted
```
public int addModelOnDataCompleted(int modelNode,
                                   java.lang.String source)
```
    Adds an OnDataCompleted event to a model
    
    Parameters:
    
    modelNode - the node of the model
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addModelOnBeforeSync
```
public int addModelOnBeforeSync(int modelNode,
                                java.lang.String source)
```
    Adds an OnBeforeSynchronize event to a model
    
    Parameters:
    
    modelNode - the node of the model
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.
  - addModelOnFind
```
public int addModelOnFind(int modelNode,
                          java.lang.String source)
```
    Adds an OnFind event to a model
    
    Parameters:
    
    modelNode - the node of the model
    
    source - script started when event is raised.
    
    Returns:
    
    action node. Returns 0 if unsuccessful.

Class XFormsDef

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ICON_SMALL

ICON_MID

ICON_BIG

Constructor Detail

XFormsDef

XFormsDef

XFormsDef

XFormsDef

Method Detail

getXFormsDefinition

getMainForm

getDocument

setXFormsVersion

setFocusAtStartup

addText

addInput

addPassword

addOutput

addTextarea

addRichText

addButtonControlbox

addButton

addRadioChoicebox

addRadio

addSelect

addList

setEnumerated

enableDefaultOption

setDefaultOption

addItem

addCheckbox

addTable

addGroupBox

addGroupBox

enableLazyLoad

addGroup

addTabGroup

addTabGroup

addTabPage

addImageControlbox

addImageControlbox

addImage

addFrame

addCompositeControl

addCompositeControl

addAction

addAction

addNamespaceURI

addZoom

addZoom

addClickChoiceDocked

addClickChoiceDocked

addClickChoiceUnDocked

addClickChoiceUnDocked

addClickChoiceSimple

addClickChoiceSimple

setSynchronizedDialogDocked

setSynchronizedDialogSimple

setSynchronizedDialogNotDocked

setSynchronizedDialogDocked

setSynchronizedDialogSimple

setSynchronizedDialogNotDocked

addOnBeforeSynchronizedDialogOpen

addControlBar

addPaginationBar

getToolbarButton

addOnBeforeClick

addOnAfterClick

addToolbarButton

addToolbarSeparator

addToolbar

createEmptyNode

addNode

moveNode