Child pages
  • Portal

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Rev: 1381948887907

...

HTML Table
id
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Event Summary
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onDragonDrag
The method that is triggered when (non Design Mode) dragging occurs.
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onDragEndonDragEnd
The method that is triggered when (non Design Mode) dragging end occurs.
Table Body (tbody)
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onDragOveronDragOver
The method that is triggered when (non Design Mode) dragging over a component occurs.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onDroponDrop
The method that is triggered when (non Design Mode) dropping occurs.
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onRenderonRender
The method that is executed when the component is rendered.

HTML Table
id
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

tbody
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
tbody
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#anchorsanchors
Enables a component to stick to a specific side of form and/or to
grow or shrink when a window is resized.
tbody
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#backgroundbackground
The background color of the component.
tbody
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#borderTypeborderType
The type, color and style of border of the component.
Table Row (tr)
Table Cell (td)
Object
Table Cell (td)
designTimeProperties
Property to get and add design-time properties for a component.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#enabledenabled
The enable state of the component, default true.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
formIndex
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#initialSortinitialSort
The default sort order for the rows displayed in the portal.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#intercellSpacingintercellSpacing
The additional spacing between cell rows.
tbody
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#locationlocation
The x and y position of the component, in pixels, separated by a comma.
tbody
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#multiLinemultiLine
When set, portal rows can have a custom layout of fields, buttons, etc.
tbody
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#namename
The name of the component.
tbody
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#printSlidingprintSliding
Enables an element to resize based on its content and/or move when printing.
tbody
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#printableprintable
Flag that tells if the component should be printed or not when the form is printed.
tbody
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#relationNamerelationName
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.
tbody
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#reorderablereorderable
When set, the portal rows can be re-ordered by dragging the column headers.
tbody
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#resizableresizable
When set the portal rows can be resized by users.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#rowBGColorCalculationrowBGColorCalculation
The calculation dataprovider (such as servoy_row_bgcolor) used to add background
color and highlight selected or alternate portal rows.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#rowHeightrowHeight
The height of each row in pixels.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#scrollbarsscrollbars
Scrollbar options for the vertical and horizontal scrollbars.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#showHorizontalLinesshowHorizontalLines
When set, the portal displays horizontal lines between the rows.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#showVerticalLinesshowVerticalLines
When set the portal displays vertical lines between the columns.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#sizesize
The width and height (in pixels), separated by a comma.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#sortablesortable
When set, users can sort the contents of the portal by clicking on the column headings.
tbody
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#styleClassstyleClass
The name of the style class that should be applied to this component.
tbody
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#tabSeqtabSeq
An index that specifies the position of the component in the tab sequence.
tbody
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#transparenttransparent
Flag that tells if the component is transparent or not.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#visiblevisible
The visible property of the component, default true.

HTML Table
idevent
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Event Details
Table Body (tbody)
idonDrag
Table Row (tr)
idname
Table Cell (td)
onDrag
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is triggered when (non Design Mode) dragging occurs.
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonDragEnd
Table Row (tr)
idname
Table Cell (td)
onDragEnd
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is triggered when (non Design Mode) dragging end occurs.
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonDragOver
Table Row (tr)
idname
Table Cell (td)
onDragOver
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is triggered when (non Design Mode) dragging over a component occurs.
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonDrop
Table Row (tr)
idname
Table Cell (td)
onDrop
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is triggered when (non Design Mode) dropping occurs.
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonRender
Table Row (tr)
idname
Table Cell (td)
onRender
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is executed when the component is rendered.
Table Row (tr)
classlastDetailRow
Table Cell (td)


HTML Table
idproperty
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Property Details
Table Body (tbody)
idanchors
Table Row (tr)
idname
Table Cell (td)
anchors
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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.

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idbackground
Table Row (tr)
idname
Table Cell (td)
background
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The background color of the component.
Table Row (tr)
idret
Table Cell (td)
Returns
String
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idborderType
Table Row (tr)
idname
Table Cell (td)
borderType
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The type, color and style of border of the component.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
iddesignTimeProperties
Table Row (tr)
idname
Table Cell (td)
designTimeProperties
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Property to get and add design-time properties for a component.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Object - map of the design-time properties
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idborderTypeenabled
Table Row (tr)
idname
Table Cell (td)
borderType
enabled
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The type, color and style of border enable state of the component, default true.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
StringBoolean - enabled state
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idenabledformIndex
Table Row (tr)
idname
Table Cell (td)
enabled
Table Row (tr)
iddes
The enable state of the component, default true.
formIndex
Table Cell (td)
Div
classsIndent
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean – enabled stateNumber
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idinitialSort
Table Row (tr)
idname
Table Cell (td)
initialSort
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The default sort order for the rows displayed in the portal.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idintercellSpacing
Table Row (tr)
idname
Table Cell (td)
intercellSpacing
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The additional spacing between cell rows. Is composed from the horizontal spacing
and the vertical spacing.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idlocation
Table Row (tr)
idname
Table Cell (td)
location
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The x and y position of the component, in pixels, separated by a comma.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idmultiLine
Table Row (tr)
idname
Table Cell (td)
multiLine
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
When set, portal rows can have a custom layout of fields, buttons, etc. displayed for each
matching row (rather than the default "grid").
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idname
Table Row (tr)
idname
Table Cell (td)
name
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The name of the component. Through this name it can also accessed in methods.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idprintSliding
Table Row (tr)
idname
Table Cell (td)
printSliding
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idprintable
Table Row (tr)
idname
Table Cell (td)
printable
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Flag that tells if the component should be printed or not when the form is printed.

By default components are printable.

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idrelationName
Table Row (tr)
idname
Table Cell (td)
relationName
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idreorderable
Table Row (tr)
idname
Table Cell (td)
reorderable
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
When set, the portal rows can be re-ordered by dragging the column headers.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idresizable
Table Row (tr)
idname
Table Cell (td)
resizable
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
When set the portal rows can be resized by users.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idrowBGColorCalculation
Table Row (tr)
idname
Table Cell (td)
rowBGColorCalculation
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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.

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idrowHeight
Table Row (tr)
idname
Table Cell (td)
rowHeight
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The height of each row in pixels. If 0 or not set, the height defaults to 10.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idscrollbars
Table Row (tr)
idname
Table Cell (td)
scrollbars
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idshowHorizontalLines
Table Row (tr)
idname
Table Cell (td)
showHorizontalLines
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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.

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idshowVerticalLines
Table Row (tr)
idname
Table Cell (td)
showVerticalLines
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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.

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsize
Table Row (tr)
idname
Table Cell (td)
size
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The width and height (in pixels), separated by a comma.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsortable
Table Row (tr)
idname
Table Cell (td)
sortable
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
When set, users can sort the contents of the portal by clicking on the column headings.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idstyleClass
Table Row (tr)
idname
Table Cell (td)
styleClass
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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.

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idtabSeq
Table Row (tr)
idname
Table Cell (td)
tabSeq
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idtransparent
Table Row (tr)
idname
Table Cell (td)
transparent
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Flag that tells if the component is transparent or not.

The default value is "false", that is the components
are not transparent.

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idvisible
Table Row (tr)
idname
Table Cell (td)
visible
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The visible property of the component, default true.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean - visible property
Table Row (tr)
classlastDetailRow
Table Cell (td)