Skip to end of metadata
Go to start of metadata



Event Summary
  onChange
Method to be executed when the selected tab is changed in the tab panel or divider position is changed in split pane.



Property Summary
Number anchors
Enables a component to stick to a specific side of form and/or to
grow or shrink when a window is resized.
String background
The background color of the component.
String borderType
The type, color and style of border of the component.
Object designTimeProperties
Property to get and add design-time properties for a component.
Boolean enabled
The enable state of the component, default true.
String fontType
The font type of the component.
String foreground
The foreground color of the component.
Number formIndex
Number horizontalAlignment
The horizontal alignment of the tabpanel.
String location
The x and y position of the component, in pixels, separated by a comma.
String name
The name of the component.
Number printSliding
Enables an element to resize based on its content and/or move when printing.
Boolean printable
Flag that tells if the component should be printed or not when the form is printed.
Boolean scrollTabs
Flag that tells how to arrange the tabs if they don't fit on a single line.
String size
The width and height (in pixels), separated by a comma.
String styleClass
The name of the style class that should be applied to this component.
Number tabOrientation
The position of the tabs related to the tab panel.
Number tabSeq
An index that specifies the position of the component in the tab sequence.
Boolean transparent
Flag that tells if the component is transparent or not.
Boolean visible
The visible property of the component, default true.



Event Details

onChange

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

Parameters

{Number} previousIndex - index of tab shown before the change
{JSEvent} event - the event that triggered the action
 



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
 

fontType

The font type of the component.

Returns

 

foreground

The foreground color of the component.

Returns

 

formIndex

Returns

 

horizontalAlignment

The horizontal alignment of the tabpanel.

Returns

 

location

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

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

 

scrollTabs

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.

Returns

 

size

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

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

 

tabOrientation

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.

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

 

visible

The visible property of the component, default true.

Returns

Boolean - visible property
 



  • No labels