TabPanel

(part of package 'Bootstrap Components') Extends designtime/SolutionModel: JSWebComponent Extends runtime: RuntimeWebComponent

This is a reference page; many components have detailed usage guides here.

Properties

closeIconStyleClass

Type: styleclass Default Value: "glyphicon glyphicon-remove close-icon"

---

containerStyleClass

Type: styleclass

---

height

Minimum height of the tabpanel, should be used for responsive forms. Can be 100% (to take parent container height) or a number (in pixels).

Type: string Default Value: "500"

---

showTabCloseIcon

Type: boolean Default Value: false

---

styleClass

Set the styleclasses that should be applied at to this component

Type: styleclass

---

tabIndex

Type: int Default Value: 1

---

tabSeq

Tab sequence number of form containers is used for all nested components in the main form.

Type: tabseq

---

tabs

Type: tab[]

---

visible

Whether the button is visible or not

Type: visible

---

Events

onChangeMethodID

Fired after a different tab is selected

Parameters:

previousIndex int event JSEvent

---

onTabClickedMethodID

Fired when the user clicks on a tab. When false is returned, the tab switch is prevented

Parameters:

event JSEvent clickedTabIndex int dataTarget string

Returns: boolean

---

onTabCloseMethodID

Fired when the user clicks on the tab close icon. When false is returned, the tab close is prevented

Parameters:

event JSEvent clickedTabIndex int

Returns: boolean

---

API

addTab

Adds a tab with the given form and tab text on the given index.

@param {String} form The name of the form to add as a tab @param {String} tabText the tab text that should be displayed @param {Number} [index] optional give an index where the tab should be placed, default at the end.

Parameters:

form form tabText tagstring index int (optional)

Returns: tab

---

getTabAt

Parameters:

i int

Returns: tab

---

removeAllTabs

Removes all tabs of this tabpanel

Returns: boolean

---

removeTabAt

Removes the tab from the given index.

Parameters:

index int

Returns: boolean

---

selectTabAt

Selects the tab of the given index

@deprecated use tabIndex property instead.

Parameters:

index int

Returns: boolean

---

Types

tab

scripting type: CustomType<bootstrapcomponents-tabpanel.tab>

• containedForm

  • Type: form

• disabled

  • Type: boolean

  • Default Value: false

• hideCloseIcon

  • Type: boolean

  • Default Value: false

• iconStyleClass

  • Type: styleclass

• imageMediaID

  • Type: media

• name

  • Type: string

• relationName

  • Type: relation

• styleClass

  • Type: styleclass

• text

  • Type: tagstring

• toolTipText

  • Type: tagstring

---