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: Number Default Value: 1

---

tabSeq

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

Type: Tabseq

---

tabs

Type: Array<CustomType<bootstrapcomponents-tabpanel.tab>>

---

visible

Whether the button is visible or not

Type: Visible

---

Events

onChangeMethodID(previousIndex,event)

Fired after a different tab is selected

Parameters:

• {Number} previousIndex

• {JSEvent} event

---

onTabClickedMethodID(event,clickedTabIndex,dataTarget)

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

Parameters:

• {JSEvent} event

• {Number} clickedTabIndex

• {String} dataTarget

Returns: {Boolean}

---

onTabCloseMethodID(event,clickedTabIndex)

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

Parameters:

• {JSEvent} event

• {Number} clickedTabIndex

Returns: {Boolean}

---

API

addTab(form,tabText,index)

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

Parameters:

• {Form} form The name of the form to add as a tab

• {String} tabText The tab text that should be displayed

• {Number} [index] Give an index where the tab should be placed, default at the end.

Returns: CustomType<bootstrapcomponents-tabpanel.tab> The newly created tab object that represents the added form in the tab panel.

---

getTabAt(index)

Retrieves the tab at the specified index from the tabs model.

Parameters:

• {Number} index The 1-based index of the tab to retrieve.

Returns: CustomType<bootstrapcomponents-tabpanel.tab> The tab object at the specified index, or null if the index is out of range.

---

removeAllTabs()

Removes all tabs of this tabpanel

Returns: Boolean True if all tabs were successfully removed; false otherwise.

---

removeTabAt(index)

Removes the tab from the given index.

Parameters:

• {Number} index <<<<<<<< add description for this param <<<<<<<<

Returns: Boolean True if the tab was successfully removed; false otherwise.

---

selectTabAt(index)

Selects the tab of the given index

@deprecated use tabIndex property instead.

Parameters:

• {Number} index

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

---