Options
All
  • Public
  • Public/Protected
  • All
Menu

The configuration for the TabView widget. You can access this configuration via BaseWidget.cfg. Please note that this configuration is usually meant to be read-only and should not be modified.

Hierarchy

Index

Properties

behaviors

behaviors: Record<string, Behavior>

A map with all behaviors that were defined for this widget. The key is the name of the behavior, the value is the callback function that is invoked when the behavior is called.

cache

cache: boolean

When tab contents are lazy loaded via AJAX toggle mode, caching only retrieves the tab contents once and subsequent toggles of a cached tab does not communicate with server. If caching is turned off, tab contents are reloaded from server each time tab is clicked.

dynamic

dynamic: boolean

Enables lazy loading of inactive tabs.

effect

effect: string

Name of the transition effect.

effectDuration

effectDuration: number

Duration of the transition effect.

Optional formId

formId?: string

ID of the form to use for AJAX requests.

id

id: string | string[]

The client-side ID of the widget, with all parent naming containers, such as myForm:myWidget. This is also the ID of the container HTML element for this widget. In case the widget needs multiple container elements (such as Paginator), this may also be an array if IDs.

multiViewState

multiViewState: boolean

Whether to keep TabView state across views.

onTabChange

onTabChange: OnTabChangeCallback

Client side callback to execute when a tab is clicked. If the callback returns false, the tab is not selected.

onTabClose

onTabClose: OnTabCloseCallback

Client side callback to execute on tab close. When the callback returns false, the tab is not closed.

onTabShow

Client side callback to execute when a tab is shown.

postConstruct

postConstruct: PostConstructCallback

An optional callback that is invoked after this widget was created successfully, at the end of the init method. This is usually specified via the widgetPostConstruct attribute on the JSF component. Note that this is also called during a refresh (AJAX update).

postRefresh

postRefresh: PostRefreshCallback

An optional callback that is invoked after this widget was refreshed after an AJAX update, at the end of the refresh method. This is usually specified via the widgetPostRefresh attribute on the JSF component.

preDestroy

preDestroy: PreDestroyCallback

An optional callback that is invoked before this widget is about to be destroyed, e.g. when the component was removed at the end of an AJAX update. This is called at the beginning of the destroy method. This is usually specified via the widgetPreDestroy attribute on the JSF component.

scrollable

scrollable: boolean

When enabled, tab headers can be scrolled horizontally instead of wrapping.

selected

selected: number

The currently selected tab.

tabindex

tabindex: number

Position of the element in the tabbing order.

widgetVar

widgetVar: string

The name of the widget variables of this widget. The widget variable can be used to access a widget instance by calling PF("myWidgetVar").

Generated using TypeDoc