Options
All
  • Public
  • Public/Protected
  • All
Menu

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

appendTo: string

Search expression for the element to which the menu overlay is appended.

at: string

Defines which position on the target element to align the positioned element against

autoDisplay: boolean

Defines whether the first level of submenus will be displayed on mouseover or not. When set to false, click event is required to display this tiered menu.

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.

collision: string

When the positioned element overflows the window in some direction, move it to an alternative position. Similar to my and at, this accepts a single value or a pair for horizontal/vertical, e.g., flip, fit, fit flip, fit none.

disabled: boolean

Whether this menu button is initially disabled.

formId?: string

ID of the form to use for AJAX requests.

hideDelay: number

Number of milliseconds before hiding menu, if 0 not hidden until document.click.

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.

my: string

Defines which position on the element being positioned to align with the target element.

overlay: boolean

true if this menu is displayed as an overlay, or false otherwise.

Describes how to align this menu.

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: 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: 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.

showDelay: number

Number of milliseconds before displaying menu. Default to 0 immediate.

toggleEvent: ToggleEvent

Event to toggle the submenus.

trigger: string

ID of the event which triggers this menu.

triggerEvent: string

Event which triggers this menu.

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