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.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 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.Clear a design-time property of an element.voidRemoves the tab with the specified name from the tab panel.

constantservoy sDetail2100%height:30px2Constants DetailsACCORDION_PANELname

ACCORDION_PANEL

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow DEFAULT_ORIENTATIONname

DEFAULT_ORIENTATION

dessIndentConstant 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

dessIndentConstant 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

dessIndentConstant 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

dessIndentConstant 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

dessIndentEnables 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
lastDetailRow backgroundname

background

dessIndentThe background color of the component.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
borderTypename

borderType

dessIndentThe type, color and style of border of the component.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
enabledname

enabled

dessIndentThe enable state of the component, default true.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
fontTypename

fontType

dessIndentThe font type of the component.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
foregroundname

foreground

dessIndentThe foreground color of the component.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
formIndexname

formIndex

dessIndentThe 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

dessIndentA 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

dessIndentThe height in pixels of the component.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
namename

name

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
onChangename

onChange

dessIndentMethod 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

dessIndentEnables 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

dessIndentFlag 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

dessIndentFlag 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

dessIndentThe 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

dessIndentSpecifies 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

dessIndentAn 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

dessIndentFlag 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

dessIndentThe visible property of the component, default true.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
widthname

width

dessIndentThe width in pixels of the component.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
xname

x

dessIndentThe x coordinate of the component on the form.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
yname

y

dessIndentThe 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 DetailsgetDesignTimePropertyname

getDesignTimeProperty(key)

dessIndentGet 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()

dessIndentGet the design-time properties of an element.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
getFormNamename

getFormName()

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
getTabname

getTab(name)

dessIndentReturns 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
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
getTabsname

getTabs()

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
getUUIDname

getUUID()

dessIndentReturns the UUID of this component.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
newTabname

newTab(name, text, form)

dessIndentAdds 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
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
newTabname

newTab(name, text, form, relation)

dessIndentAdds 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
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
putDesignTimePropertyname

putDesignTimeProperty(key, value)

dessIndentSet 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 
removeDesignTimePropertyname

removeDesignTimeProperty(key)

dessIndentClear 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)

dessIndentRemoves the tab with the specified name from the tab panel.prs

Parameters

sIndentnamethe name of the tab to be removed
ret

Returns

sIndentclients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow