Child pages
  • JSTabPanel

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sReturnTypes2100%height: 30px;2ExtendssWordListBLOCK

servoy sSummary12%30%58%height: 30px;3Constants SummaryConstant used for creating accordion panel from tab panel, by setting its tabOrientation.Constant used for restoring a tab panel orientation to it's initial state.Constant used for creating a tab panel that does not show tabs, by setting its tabOrientation.Constant used for creating horizontal split pane from tab panel, by setting its tabOrientation.Constant used for creating vertical split pane from tab panel, by setting its tabOrientation.

servoy sSummary12%30%58%height: 30px;3Property SummaryEnables a component to stick to a specific side of form and/or to grow or shrink when a window is resized.The background color of the component.The type, color and style of border of the component.CSS position is a replacement for anchoring system making it more intuitive to place a component.The enable state of the component, default true.The font type of the component.The foreground color of the component.The Z index of this component.A String representing a group ID for this component.The height in pixels of the component.The name of the component.Method to be executed when the selected tab is changed in the tab panel or divider position is changed in split pane.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.Flag that tells how to arrange the tabs if they don't fit on a single line.The name of the style class that should be applied to this component.Specifies either the position of the tabs related to the tab panel or the type of tab-panel.An index that specifies the position of the component in the tab sequence.Flag that tells if the component is transparent or not.The visible property of the component, default true.The width in pixels of the component.The x coordinate of the component on the form.The y coordinate of the component on the form.

servoy sSummary12%30%58%height: 30px;3Methods SummaryGet the value of an attribute of the element.Returns the attribute names of an element.Get a design-time property of an element.Get the design-time properties of an element.Returns the name of the form.Returns a JSTab instance representing the tab which has the specified name.Returns an array of JSTab instances holding the tabs of the tab panel.Returns the UUID of this component.Adds a new tab with the text label and JSForm.Adds a new tab with the text label and JSForm and JSRelation (can be null for unrelated).Set a design-time property of an element.Remove the attribute of an element.Clear a design-time property of an element.voidRemoves the tab with the specified name from the tab panel.voidSet the attribute value of an element.

constantservoy sDetail2100%height:30px2Constants DetailsACCORDION_PANELname

ACCORDION_PANEL

dessIndent
Constant used for creating accordion panel from tab panel, by setting its tabOrientation.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowDEFAULT_ORIENTATIONname

DEFAULT_ORIENTATION

dessIndent
Constant used for restoring a tab panel orientation to it's initial state.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
HIDEname

HIDE

dessIndent
Constant used for creating a tab panel that does not show tabs, by setting its tabOrientation.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
SPLIT_HORIZONTALname

SPLIT_HORIZONTAL

dessIndent
Constant used for creating horizontal split pane from tab panel, by setting its tabOrientation.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
SPLIT_VERTICALname

SPLIT_VERTICAL

dessIndent
Constant used for creating vertical split pane from tab panel, by setting its tabOrientation.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow

propertyservoy sDetail2100%height:30px2Property Detailsanchorsname

anchors

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowbackgroundname

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
cssPositionname

cssPosition

dessIndent
CSS position is a replacement for anchoring system making it more intuitive to place a component.
CSS position should be set on form, an absolute position form can either work with anchoring or with css position.
This is only working in NGClient.
ret

Returns

sIndent
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
enabledname

enabled

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

Returns

sIndent
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
The Z index of this component. If two components overlap,
then the component with higher Z index is displayed above
the component with lower Z index.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
groupIDname

groupID

dessIndent
A String representing a group ID for this component. If several
components have the same group ID then they belong to the same
group of components. Using the group itself, all components can
be disabled/enabled or made invisible/visible.
The group id should be a javascript compatible identifier to allow access of the group in scripting.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
heightname

height

dessIndent
The height in pixels of the component.
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
onChangename

onChange

dessIndent
Method to be executed when the selected tab is changed in the tab panel or divider position is changed in split pane.
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
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
Specifies either the position of the tabs related to the tab panel or the type of tab-panel.
Can be one of SM_ALIGNMENT.(TOP, RIGHT, BOTTOM, LEFT), DEFAULT_ORIENTATION, HIDE, SPLIT_HORIZONTAL, SPLIT_VERTICAL, ACCORDION_PANEL.
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
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
widthname

width

dessIndent
The width in pixels of the component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
xname

x

dessIndent
The x coordinate of the component on the form.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
yname

y

dessIndent
The y coordinate of the component on the form.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow

functionservoy sDetail2100%height:30px2Methods DetailsgetAttributename

getAttribute(name)

dessIndent
Get the value of an attribute of the element.
prs

Parameters

sIndentnamethe name of the attribute
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowgetAttributesname

getAttributes()

dessIndent
Returns the attribute names of an element.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getDesignTimePropertyname

getDesignTimeProperty(key)

dessIndent
Get a design-time property of an element.
prs

Parameters

sIndentkeythe name of the property
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getDesignTimePropertyNamesname

getDesignTimePropertyNames()

dessIndent
Get the design-time properties of an element.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getFormNamename

getFormName()

dessIndent
Returns the name of the form. (may be empty string as well)
ret

Returns

sIndent The name of the form.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getTabname

getTab(name)

dessIndent
Returns a JSTab instance representing the tab which has the specified name.
prs

Parameters

sIndentnameThe name of the tab that should be returned.
ret

Returns

sIndent A JSTab instance represented the requested tab.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getTabsname

getTabs()

dessIndent
Returns an array of JSTab instances holding the tabs of the tab panel.
ret

Returns

sIndent An array of JSTab instances representing all tabs of this tabpanel.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getUUIDname

getUUID()

dessIndent
Returns the UUID of this component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
newTabname

newTab(name, text, form)

dessIndent
Adds a new tab with the text label and JSForm.
prs

Parameters

sIndentnameThe name of the new tab.textThe text to be displayed on the new tab.formThe JSForm instance that should be displayed in the new tab.
ret

Returns

sIndent A JSTab instance representing the newly created and added tab.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
newTabname

newTab(name, text, form, relation)

dessIndent
Adds a new tab with the text label and JSForm and JSRelation (can be null for unrelated).
prs

Parameters

sIndentnameThe name of the new tab.textThe text to be displayed on the new tab.formThe JSForm instance that should be displayed in the new tab.relationA JSRelation object that relates the parent form with the form that will be displayed in the new tab.
ret

Returns

sIndent A JSTab instance representing the newly created and added tab.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
putDesignTimePropertyname

putDesignTimeProperty(key, value)

dessIndent
Set a design-time property of an element.
prs

Parameters

sIndentkeythe name of the propertyvaluethe value to store
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
removeAttributename

removeAttribute(name)

dessIndent
Remove the attribute of an element.
prs

Parameters

sIndentnamethe name of the attribute
ret

Returns

sIndent the deleted attribute value
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
removeDesignTimePropertyname

removeDesignTimeProperty(key)

dessIndent
Clear a design-time property of an element.
prs

Parameters

sIndentkeythe name of the property
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
removeTabname

removeTab(name)

dessIndent
Removes the tab with the specified name from the tab panel.
prs

Parameters

sIndentnamethe name of the tab to be removed
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setAttributename

setAttribute(name, value)

dessIndent
Set the attribute value of an element.
prs

Parameters

sIndentnamethe name of the attributevaluethe value of the attribute
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow