DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE
STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR. \\ \\ Enter additional information related to this
Enter additional information related to this 'class'
inside the \ {div} macro with 'id=description' {div}
{div:id=description}{div}\\
{table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Event Summary{th}{tr}{tbody}{tr}{td}{td}{td}[#onDrag]
The method that is triggered when (non Design Mode) dragging occurs.{td}{tr}{tbody}{tbody}{tr}{td}{td}{td}[#onDragEnd]
The method that is triggered when (non Design Mode) dragging end occurs.{td}{tr}{tbody}{tbody}{tr}{td}{td}{td}[#onDragOver]
The method that is triggered when (non Design Mode) dragging over a component occurs.{td}{tr}{tbody}{tbody}{tr}{td}{td}{td}[#onDrop]
The method that is triggered when (non Design Mode) dropping occurs.{td}{tr}{tbody}{tbody}{tr}{td}{td}{td}[#onRender]
The method that is executed when the component is rendered.{td}{tr}{tbody}{table}\\
{table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Property Summary{th}{tr}{tbody}{tr}{td}[Number]{td}{td}[#anchors]
Enables a component to stick to a specific side of form and/or to
grow or shrink when a window is resized.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#background]
The background color of the component.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#borderType]
The type, color and style of border of the component.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#enabled]
The enable state of the component, default true.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#initialSort]
The default sort order for the rows displayed in the portal.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#intercellSpacing]
The additional spacing between cell rows.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#location]
The x and y position of the component, in pixels, separated by a comma.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#multiLine]
When set, portal rows can have a custom layout of fields, buttons, etc.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#name]
The name of the component.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#printSliding]
Enables an element to resize based on its content and/or move when printing.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#printable]
Flag that tells if the component should be printed or not when the form is printed.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#relationName]
The name of the relationship between the table related to the currently active
form and the table you want to show data from in the portal.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#reorderable]
When set, the portal rows can be re\-ordered by dragging the column headers.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#resizable]
When set the portal rows can be resized by users.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#rowBGColorCalculation]
The calculation dataprovider (such as servoy\_row\_bgcolor) used to add background
color and highlight selected or alternate portal rows.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#rowHeight]
The height of each row in pixels.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#scrollbars]
Scrollbar options for the vertical and horizontal scrollbars.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#showHorizontalLines]
When set, the portal displays horizontal lines between the rows.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#showVerticalLines]
When set the portal displays vertical lines between the columns.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#size]
The width and height (in pixels), separated by a comma.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#sortable]
When set, users can sort the contents of the portal by clicking on the column headings.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#styleClass]
The name of the style class that should be applied to this component.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#tabSeq]
An index that specifies the position of the component in the tab sequence.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#transparent]
Flag that tells if the component is transparent or not.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#visible]
The visible property of the component, default true.{td}{tr}{tbody}{table}\\
{table:id=event|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Event Details{th}{tr}{tbody:id=onDrag}{tr:id=name}{td}h6.onDrag{td}{tr}{tr:id=des}{td}{div:class=sIndent}The method that is triggered when (non Design Mode) dragging occurs.{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=onDragEnd}{tr:id=name}{td}h6.onDragEnd{td}{tr}{tr:id=des}{td}{div:class=sIndent}The method that is triggered when (non Design Mode) dragging end occurs.{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=onDragOver}{tr:id=name}{td}h6.onDragOver{td}{tr}{tr:id=des}{td}{div:class=sIndent}The method that is triggered when (non Design Mode) dragging over a component occurs.{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=onDrop}{tr:id=name}{td}h6.onDrop{td}{tr}{tr:id=des}{td}{div:class=sIndent}The method that is triggered when (non Design Mode) dropping occurs.{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=onRender}{tr:id=name}{td}h6.onRender{td}{tr}{tr:id=des}{td}{div:class=sIndent}The method that is executed when the component is rendered.{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}\\
{table:id=property|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Property Details{th}{tr}{tbody:id=anchors}{tr:id=name}{td}h6.anchors{td}{tr}{tr:id=des}{td}{div:class=sIndent}Enables a component to stick to a specific side of form and/or to
grow or shrink when a window is resized.
If opposite anchors are activated then the component with grow or
shrink with the window. For example if Top and Bottom are activated,
then the component will grow/shrink when the window is vertically
resized. If Left and Right are activated then the component
will grow/shrink when the window is horizontally resized.
If opposite anchors are not activated, then the component will
keep a constant distance from the sides of the window which
correspond to the activated anchors.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=background}{tr:id=name}{td}h6.background{td}{tr}{tr:id=des}{td}{div:class=sIndent}The background color of the component.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=borderType}{tr:id=name}{td}h6.borderType{td}{tr}{tr:id=des}{td}{div:class=sIndent}The type, color and style of border of the component.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=enabled}{tr:id=name}{td}h6.enabled{td}{tr}{tr:id=des}{td}{div:class=sIndent}The enable state of the component, default true.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- enabled state{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=initialSort}{tr:id=name}{td}h6.initialSort{td}{tr}{tr:id=des}{td}{div:class=sIndent}The default sort order for the rows displayed in the portal.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=intercellSpacing}{tr:id=name}{td}h6.intercellSpacing{td}{tr}{tr:id=des}{td}{div:class=sIndent}The additional spacing between cell rows. Is composed from the horizontal spacing
and the vertical spacing.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=location}{tr:id=name}{td}h6.location{td}{tr}{tr:id=des}{td}{div:class=sIndent}The x and y position of the component, in pixels, separated by a comma.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=multiLine}{tr:id=name}{td}h6.multiLine{td}{tr}{tr:id=des}{td}{div:class=sIndent}When set, portal rows can have a custom layout of fields, buttons, etc. displayed for each
matching row (rather than the default "grid").{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=name}{tr:id=name}{td}h6.name{td}{tr}{tr:id=des}{td}{div:class=sIndent}The name of the component. Through this name it can also accessed in methods.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=printSliding}{tr:id=name}{td}h6.printSliding{td}{tr}{tr:id=des}{td}{div:class=sIndent}Enables an element to resize based on its content and/or move when printing.
The component can move horizontally or vertically and can grow or shrink in
height and width, based on its content and the content of neighboring
components.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=printable}{tr:id=name}{td}h6.printable{td}{tr}{tr:id=des}{td}{div:class=sIndent}Flag that tells if the component should be printed or not when the form is printed.
By default components are printable.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=relationName}{tr:id=name}{td}h6.relationName{td}{tr}{tr:id=des}{td}{div:class=sIndent}The name of the relationship between the table related to the currently active
form and the table you want to show data from in the portal.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=reorderable}{tr:id=name}{td}h6.reorderable{td}{tr}{tr:id=des}{td}{div:class=sIndent}When set, the portal rows can be re\-ordered by dragging the column headers.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=resizable}{tr:id=name}{td}h6.resizable{td}{tr}{tr:id=des}{td}{div:class=sIndent}When set the portal rows can be resized by users.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=rowBGColorCalculation}{tr:id=name}{td}h6.rowBGColorCalculation{td}{tr}{tr:id=des}{td}{div:class=sIndent}The calculation dataprovider (such as servoy\_row\_bgcolor) used to add background
color and highlight selected or alternate portal rows.
NOTE: This property has been deprecated and is kept visible for legacy purposes. Use CSS Row Styling & onRender event instead.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=rowHeight}{tr:id=name}{td}h6.rowHeight{td}{tr}{tr:id=des}{td}{div:class=sIndent}The height of each row in pixels. If 0 or not set, the height defaults to 10.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=scrollbars}{tr:id=name}{td}h6.scrollbars{td}{tr}{tr:id=des}{td}{div:class=sIndent}Scrollbar options for the vertical and horizontal scrollbars. Each of the
vertical and horizontal scrollbars can be configured to display all the time,
to display only when needed or to never display.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showHorizontalLines}{tr:id=name}{td}h6.showHorizontalLines{td}{tr}{tr:id=des}{td}{div:class=sIndent}When set, the portal displays horizontal lines between the rows.
NOTE:
In a multi\-line portal, a horizontal line is only displayed
in the selected row; to display a horizontal line in all rows, add a
line to the portal.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showVerticalLines}{tr:id=name}{td}h6.showVerticalLines{td}{tr}{tr:id=des}{td}{div:class=sIndent}When set the portal displays vertical lines between the columns.
NOTE:
In a multi\-line portal, a vertical line is only displayed
in the selected row; to display a vertical line in all rows, add
a line to the portal.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=size}{tr:id=name}{td}h6.size{td}{tr}{tr:id=des}{td}{div:class=sIndent}The width and height (in pixels), separated by a comma.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=sortable}{tr:id=name}{td}h6.sortable{td}{tr}{tr:id=des}{td}{div:class=sIndent}When set, users can sort the contents of the portal by clicking on the column headings.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=styleClass}{tr:id=name}{td}h6.styleClass{td}{tr}{tr:id=des}{td}{div:class=sIndent}The name of the style class that should be applied to this component.
When defining style classes for specific component types, their names
must be prefixed according to the type of the component. For example
in order to define a class names 'fancy' for fields, in the style
definition the class must be named 'field.fancy'. If it would be
intended for labels, then it would be named 'label.fancy'. When specifying
the class name for a component, the prefix is dropped however. Thus the
field or the label will have its styleClass property set to 'fancy' only.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=tabSeq}{tr:id=name}{td}h6.tabSeq{td}{tr}{tr:id=des}{td}{div:class=sIndent}An index that specifies the position of the component in the tab sequence. The components
are put into the tab sequence in increasing order of this property. A value of 0 means
to use the default mechanism of building the tab sequence (based on their location on the form).
A value of \-2 means to remove the component from the tab sequence.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=transparent}{tr:id=name}{td}h6.transparent{td}{tr}{tr:id=des}{td}{div:class=sIndent}Flag that tells if the component is transparent or not.
The default value is "false", that is the components
are not transparent.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=visible}{tr:id=name}{td}h6.visible{td}{tr}{tr:id=des}{td}{div:class=sIndent}The visible property of the component, default true.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- visible property{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table} |