Child pages
  • TabPanel

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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 'class' inside the {div} macro with 'id=description'
Divcache
styleindexdisplay:none

...

iddescription

...

padding0px
width80px

...

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Event Summary

...

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.

...

padding0px
width80px

...

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary

...

Table Cell (td)
Number

...

true
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Property SummaryEnables a component to stick to a specific side of form and/or to

...

Table Cell (td)
String

...

grow or shrink when a window is resized.

...

The background color of the component.

...

Table Cell (td)
String

...

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

...

Table Cell (td)
Boolean

...

Table Cell (td)
String

...

component.Property to get and add design-time properties for a component.The enable state of the component, default true.

...

...

Table Cell (td)
String

...

The font type of the component.

...

The foreground color of the component

...

Table Cell (td)
Number

...

.Form index returns the z-index of the form element.The horizontal alignment of the tabpanel.

...

Table Cell (td)
String

...

...

Table Cell (td)
String

...

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

...

The name of the component.

...

Table Cell (td)
Number

...

Table Cell (td)
Boolean

...

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

...

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

...

Table Cell (td)
Boolean

...

...

Table Cell (td)
String

...

Flag that tells how to arrange the tabs if they don't fit on a single line.

...

...

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

...

Table Cell (td)
String

...

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

...

Table Cell (td)
Number
The position of the tabs related to the tab panel.

...

Table Cell (td)
Number

...

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

...

Table Cell (td)
Boolean

...

Table Cell (td)
Boolean

...

Flag that tells if the component is transparent or not.

...

...

The visible property of the component, default true.

...

...

padding0px
width100%

...

servoy sSummary12%30%58%height: 30px;

...

Table Head (th)
colspan1
Event Details

...

idonChange-Number_JSEvent
Table Row (tr)
idname
Table Cell (td)
onChange

...

iddes

...

classsIndent

...

idprs

...

3Event SummaryvoidMethod to be executed when the selected tab is changed in the tab panel or divider position is changed in split pane.

...

classlastDetailRow

...

HTML Table
id

Div
classsIndent
{Number} previousIndex – index of tab shown before the change
{JSEvent} event – the event that triggered the action
servoy sDetail2Property Detailsanchorsnametd

anchors

id

des

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.
id
ret

Returns

divsIndentclients

class

classproperty
Colgroup Tag
Column
padding0px
width100%
Table Row (tr)
style2100%height:30px;
Table Head (th)
colspan1
Table Body (tbody)
idid
Table Row (tr)
Table Row (tr)
class
Table Cell (td)
Div
Table Row (tr)
Table Cell (td)
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
td

Supported Clients

sIndent
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)
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)
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
SmartClient,WebClient,NGClientsam

Sample

sIdentjavascript
lastDetailRow
backgroundname

background

dessIndent
The background color of the component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
borderTypename

borderType

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
commentname

comment

dessIndentret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
cssPositionname

cssPosition

dessIndent
Thecss position of the component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
designTimePropertiesname

designTimeProperties

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

Returns

sIndent map of the design-time properties
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
enabledname

enabled

dessIndent
The enable state of the component, default true.
ret

Returns

sIndent enabled state
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
fontTypename

fontType

dessIndent
The font type of the component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
foregroundname

foreground

dessIndent
The foreground color of the component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
formIndexname

formIndex

dessIndent
Form index returns the z-index of the form element. If two elements overlap,
then the element with higher Z index is displayed above the form element with lower Z index.
In case of form inheritance, form index is evaluated in the context (form) where property is defined.
Elements which have child form as context will always be on top of elements which have parent form.
If element is overridden in child form but form index property is still inherited its context is still parent form.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
horizontalAlignmentname

horizontalAlignment

dessIndent
The horizontal alignment of the tabpanel.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
locationname

location

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
namename

name

dessIndent
The name of the component. Through this name it can also accessed in methods.
Must be a valid javascript name. (no - in the name or start with number)
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
printSlidingname

printSliding

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
printablename

printable

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

By default components are printable.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
scrollTabsname

scrollTabs

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
sizename

size

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
styleClassname

styleClass

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
tabOrientationname

tabOrientation

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
tabSeqname

tabSeq

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
transparentname

transparent

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

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
visiblename

visible

dessIndent
The visible property of the component, default true.
ret

Returns

sIndent visible property
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow

eventservoy sDetail2100%height:30px2Event DetailsonChangename

onChange(previousIndex, event)

dessIndent
Method to be executed when the selected tab is changed in the tab panel or divider position is changed in split pane.
prs

Parameters

sIndentpreviousIndexindex of tab shown before the changeeventthe event that triggered the action
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow