Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Div
styledisplay: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
iddescription



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Event Summary
Table Row (tr)
Table Cell (td)
 
Table Cell (td)
onChange
Method to be executed when the selected tab is changed in the tab panel or divider position is changed in split pane.



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
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)
String
Table Cell (td)
fontType
The font type of the component.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
foreground
The foreground color of the component.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
formIndex
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
horizontalAlignment
The horizontal alignment of the tabpanel.
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)
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)
Boolean
Table Cell (td)
scrollTabs
Flag that tells how to arrange the tabs if they don't fit on a single line.
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)
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)
tabOrientation
The position of the tabs related to the tab panel.
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
idevent
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Event Details
Table Body (tbody)
idonChange-Number_JSEvent
Table Row (tr)
idname
Table Cell (td)

onChange

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Method to be executed when the selected tab is changed in the tab panel or divider position is changed in split pane.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} previousIndex - index of tab shown before the change
{JSEvent} event - the event that triggered the action
Table Row (tr)
classlastDetailRow
Table Cell (td)
 



HTML Table
idproperty
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
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

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)
idenabled
Table Row (tr)
idname
Table Cell (td)

enabled

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The enable state of the component, default true.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - enabled state
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idfontType
Table Row (tr)
idname
Table Cell (td)

fontType

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The font type of the component.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idforeground
Table Row (tr)
idname
Table Cell (td)

foreground

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The foreground color of the component.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idformIndex
Table Row (tr)
idname
Table Cell (td)

formIndex

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idhorizontalAlignment
Table Row (tr)
idname
Table Cell (td)

horizontalAlignment

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The horizontal alignment of the tabpanel.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number
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)
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)
idscrollTabs
Table Row (tr)
idname
Table Cell (td)

scrollTabs

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Flag that tells how to arrange the tabs if they don't fit on a single line.
If this flag is set, then the tabs will stay on a single line, but there will
be the possibility to scroll them to the left and to the right. If this flag
is not set, then the tabs will be arranged on multiple lines.
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)
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)
idtabOrientation
Table Row (tr)
idname
Table Cell (td)

tabOrientation

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The position of the tabs related to the tab panel. Can be one of TOP, RIGHT, BOTTOM, LEFT,
HIDE, SPLIT_HORIZONTAL, SPLIT_VERTICAL, ACCORDION_PANEL. The HIDE option makes the tabs invisible, SPLIT_HORIZONTAL
makes the tab panel horizontal split pane, SPLIT_VERTICAL makes the tab panel vertical split pane, ACCORDION_PANEL turns
the tab panel into an accordion.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number
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)