Options
All
  • Public
  • Public/Protected
  • All
Menu

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

direction

direction: OpeningDirection

Specifies the opening animation direction of actions.

Optional formId

formId?: string

ID of the form to use for AJAX requests.

hideIcon

hideIcon: string

The icon class of the hide button element.

hideOnClickOutside

hideOnClickOutside: boolean

Whether the actions close when clicked outside.

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.

keepOpen

keepOpen: boolean

Whether the menu should be kept open on clicking menu items.

mask

mask: boolean

Whether to show a mask element behind the speed dial.

onClick

The click event that occurred.

onHide

Callback invoked when the speed dial was closed. This is called after the visible change callback.

onShow

Callback invoked when the speed dial was opened. This is called after the visible change callback.

onVisibleChange

onVisibleChange: OnVisibleChangeCallback

Callback invoked when the visibility of the speed dial changed. This is called before the hide and show callbacks.

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.

radius

radius: number

Radius for when type is set to one of the circle types.

transitionDelay

transitionDelay: number

Transition delay step in milliseconds for each action item.

type

Specifies the opening animation type of actions.

visible

visible: boolean

Specifies the visibility of the overlay.

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