Page History

Div

style	display:none

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.

Div

id	description

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Event Summary

Table Row (tr)

Table Cell (td)

Table Cell (td)
onDrag The method that is triggered when (non Design Mode) dragging occurs.

Table Row (tr)

Table Cell (td)

Table Cell (td)
onDragEnd The method that is triggered when (non Design Mode) dragging end occurs.

Table Row (tr)

Table Cell (td)

Table Cell (td)
onDragOver The method that is triggered when (non Design Mode) dragging over a component occurs.

Table Row (tr)

Table Cell (td)

Table Cell (td)
onDrop The method that is triggered when (non Design Mode) dropping occurs.

Table Row (tr)

Table Cell (td)

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

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Summary

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
anchors Enables a component to stick to a specific side of form and/or to grow or shrink when a window is resized.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
background The background color of the component.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
borderType 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)
enabled The enable state of the component, default true.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
formIndex

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
initialSort The default sort order for the rows displayed in the portal.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
intercellSpacing The additional spacing between cell rows.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
location The x and y position of the component, in pixels, separated by a comma.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
multiLine When set, portal rows can have a custom layout of fields, buttons, etc.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
name The name of the component.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
printSliding Enables an element to resize based on its content and/or move when printing.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
printable Flag that tells if the component should be printed or not when the form is printed.

Table Row (tr)

Table Cell (td)
String

Table Cell (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.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
reorderable When set, the portal rows can be re-ordered by dragging the column headers.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
resizable When set the portal rows can be resized by users.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
rowBGColorCalculation The calculation dataprovider (such as servoy_row_bgcolor) used to add background color and highlight selected or alternate portal rows.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
rowHeight The height of each row in pixels.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
scrollbars Scrollbar options for the vertical and horizontal scrollbars.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
showHorizontalLines When set, the portal displays horizontal lines between the rows.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
showVerticalLines When set the portal displays vertical lines between the columns.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
size The width and height (in pixels), separated by a comma.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
sortable When set, users can sort the contents of the portal by clicking on the column headings.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
styleClass The name of the style class that should be applied to this component.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
tabSeq An index that specifies the position of the component in the tab sequence.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
transparent Flag that tells if the component is transparent or not.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
visible The visible property of the component, default true.

HTML Table

id	event
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Event Details

Table Body (tbody)

id	onDrag

Table Row (tr)

id	name

Table Cell (td)
onDrag

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is triggered when (non Design Mode) dragging occurs.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onDragEnd

Table Row (tr)

id	name

Table Cell (td)
onDragEnd

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is triggered when (non Design Mode) dragging end occurs.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onDragOver

Table Row (tr)

id	name

Table Cell (td)
onDragOver

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is triggered when (non Design Mode) dragging over a component occurs.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onDrop

Table Row (tr)

id	name

Table Cell (td)
onDrop

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is triggered when (non Design Mode) dropping occurs.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onRender

Table Row (tr)

id	name

Table Cell (td)
onRender

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is executed when the component is rendered.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	property
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Details

Table Body (tbody)

id	anchors

Table Row (tr)

id	name

Table Cell (td)
anchors

Table Row (tr)

id	des

Table Cell (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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	background

Table Row (tr)

id	name

Table Cell (td)
background

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The background color of the component.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	borderType

Table Row (tr)

id	name

Table Cell (td)
borderType

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The type, color and style of border of the component.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	designTimeProperties

Table Row (tr)

id	name

Table Cell (td)
designTimeProperties

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Property to get and add design-time properties for a component.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object - map of the design-time properties

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	enabled

Table Row (tr)

id	name

Table Cell (td)
enabled

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The enable state of the component, default true.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - enabled state

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	formIndex

Table Row (tr)

id	name

Table Cell (td)
formIndex

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	initialSort

Table Row (tr)

id	name

Table Cell (td)
initialSort

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The default sort order for the rows displayed in the portal.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	intercellSpacing

Table Row (tr)

id	name

Table Cell (td)
intercellSpacing

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The additional spacing between cell rows. Is composed from the horizontal spacing
and the vertical spacing.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	location

Table Row (tr)

id	name

Table Cell (td)
location

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The x and y position of the component, in pixels, separated by a comma.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	multiLine

Table Row (tr)

id	name

Table Cell (td)
multiLine

Table Row (tr)

id	des

Table Cell (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").

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	name

Table Row (tr)

id	name

Table Cell (td)
name

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The name of the component. Through this name it can also accessed in methods.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	printSliding

Table Row (tr)

id	name

Table Cell (td)
printSliding

Table Row (tr)

id	des

Table Cell (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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	printable

Table Row (tr)

id	name

Table Cell (td)
printable

Table Row (tr)

id	des

Table Cell (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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	relationName

Table Row (tr)

id	name

Table Cell (td)
relationName

Table Row (tr)

id	des

Table Cell (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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	reorderable

Table Row (tr)

id	name

Table Cell (td)
reorderable

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

When set, the portal rows can be re-ordered by dragging the column headers.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	resizable

Table Row (tr)

id	name

Table Cell (td)
resizable

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

When set the portal rows can be resized by users.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	rowBGColorCalculation

Table Row (tr)

id	name

Table Cell (td)
rowBGColorCalculation

Table Row (tr)

id	des

Table Cell (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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	rowHeight

Table Row (tr)

id	name

Table Cell (td)
rowHeight

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The height of each row in pixels. If 0 or not set, the height defaults to 10.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	scrollbars

Table Row (tr)

id	name

Table Cell (td)
scrollbars

Table Row (tr)

id	des

Table Cell (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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showHorizontalLines

Table Row (tr)

id	name

Table Cell (td)
showHorizontalLines

Table Row (tr)

id	des

Table Cell (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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showVerticalLines

Table Row (tr)

id	name

Table Cell (td)
showVerticalLines

Table Row (tr)

id	des

Table Cell (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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	size

Table Row (tr)

id	name

Table Cell (td)
size

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The width and height (in pixels), separated by a comma.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	sortable

Table Row (tr)

id	name

Table Cell (td)
sortable

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

When set, users can sort the contents of the portal by clicking on the column headings.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	styleClass

Table Row (tr)

id	name

Table Cell (td)
styleClass

Table Row (tr)

id	des

Table Cell (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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	tabSeq

Table Row (tr)

id	name

Table Cell (td)
tabSeq

Table Row (tr)

id	des

Table Cell (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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	transparent

Table Row (tr)

id	name

Table Cell (td)
transparent

Table Row (tr)

id	des

Table Cell (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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	visible

Table Row (tr)

id	name

Table Cell (td)
visible

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The visible property of the component, default true.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - visible property

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 24

New Version Current

Key

onDrag

onDragEnd

onDragOver

onDrop

onRender

anchors

background

borderType

designTimeProperties

enabled

formIndex

initialSort

intercellSpacing

location

multiLine

name

printSliding

printable

relationName

reorderable

resizable

rowBGColorCalculation

rowHeight

scrollbars

showHorizontalLines

showVerticalLines

size

sortable

styleClass

tabSeq

transparent

visible