Options
All
  • Public
  • Public/Protected
  • All
Menu

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

atPos: string

Position of tooltip with respect to target. If set overrides the 'position' attribute.

autoHide: string

Whether to hide tooltip when hovering over tooltip content.

Client side callback to execute before tooltip is shown. Returning false will prevent display.

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.

delegate: string

Search expression for overriding the target.

escape: boolean

Defines whether HTML would be escaped or not.

formId?: string

ID of the form to use for AJAX requests.

globalSelector: string

A jQuery selector for global tooltip, defaults to a,:input,:button.

hideDelay: number

Delay time to hide tooltip in milliseconds.

hideEffect: string

Effect to be used for hiding.

hideEffectDuration: number

Delay time to hide tooltip in milliseconds.

hideEvent: string

Event hiding the tooltip.

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.

myPos: string

Position of tooltip with respect to target. If set overrides the 'position' attribute.

Client side callback to execute after tooltip is shown.

Client side callback to execute after tooltip is shown.

position: TooltipPosition

Position of the tooltip.

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

Delay time to show tooltip in milliseconds.

showEffect: string

Effect to be used for displaying.

showEvent: string

Event displaying the tooltip.

styleClass: string

Style class of the tooltip.

target: string

Search expression for the component to which the tooltip is attached.

trackMouse: boolean

Whether the tooltip position should follow the mouse or pointer.

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