View Source

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

background
The background color of the component.

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

Object

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

enabled
The enable state of the component, default true.

formIndex

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

intercellSpacing
The additional spacing between cell rows.

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

multiLine
When set, portal rows can have a custom layout of fields, buttons, etc.

name
The name of the component.

printSliding
Enables an element to resize based on its content and/or move when printing.

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

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.

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

resizable
When set the portal rows can be resized by users.

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

rowHeight
The height of each row in pixels.

scrollbars
Scrollbar options for the vertical and horizontal scrollbars.

showHorizontalLines
When set, the portal displays horizontal lines between the rows.

showVerticalLines
When set the portal displays vertical lines between the columns.

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

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

styleClass
The name of the style class that should be applied to this component.

tabSeq
An index that specifies the position of the component in the tab sequence.

transparent
Flag that tells if the component is transparent or not.

visible
The visible property of the component, default true.

Event Details

onDrag

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

onDragEnd

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

onDragOver

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

onDrop

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

onRender

The method that is executed when the component is rendered.

Property Details

anchors

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.

Returns

background

The background color of the component.

Returns

borderType

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

Returns

designTimeProperties

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

Returns

Object - map of the design-time properties

enabled

The enable state of the component, default true.

Returns

Boolean - enabled state

formIndex

Returns

initialSort

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

Returns

intercellSpacing

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

Returns

location

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

Returns

multiLine

When set, portal rows can have a custom layout of fields, buttons, etc. displayed for each
matching row (rather than the default "grid").

Returns

name

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

Returns

printSliding

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.

Returns

printable

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

By default components are printable.

Returns

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.

Returns

reorderable

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

Returns

resizable

When set the portal rows can be resized by users.

Returns

rowBGColorCalculation

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.

Returns

rowHeight

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

Returns

scrollbars

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.

Returns

showHorizontalLines

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.

Returns

showVerticalLines

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.

Returns

size

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

Returns

sortable

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

Returns

styleClass

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.

Returns

tabSeq

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.

Returns

transparent

Flag that tells if the component is transparent or not.

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

Returns