Options
All
  • Public
  • Public/Protected
  • All
Menu

The configuration for the AccordionPanel 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

active

active: number[]

List of tabs that are currently active (open). Each item is a 0-based index of a tab.

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

true if activating a dynamic tab should not load the contents from server again and use the cached contents; or false if the caching is disabled.

collapsedIcon

collapsedIcon: string

The icon class name for the collapsed icon.

controlled

controlled: boolean

true if a tab controller was specified for this widget; or false otherwise. A tab controller is a server side listener that decides whether a tab change or tab close should be allowed.

dynamic

dynamic: boolean

true if the contents of each panel are loaded on-demand via AJAX; false otherwise.

expandedIcon

expandedIcon: string

The icon class name for the expanded icon.

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.

multiple

multiple: boolean

true if multiple tabs may be open at the same time; or false if opening one tab closes all other tabs.

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.

rtl

rtl: boolean

true if the current text direction rtl (right-to-left); or false otherwise.

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