Options
All
  • Public
  • Public/Protected
  • All
Menu

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

appendTo: string

Selector for the element to which the overlay lightbox panel is appended.

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.

Optional formId

formId?: string

ID of the form to use for AJAX requests.

height

height: number

Height of the overlay in iframe mode.

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.

iframeTitle

iframeTitle: string

Title of the iframe element.

mode

The type of content that is shown in the lightbox.

onHide

Client-side callback invoked when the lightbox is hidden.

onShow

Client-side callback invoked when the lightbox 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.

visible

visible: boolean

Whether the lightbox is initially visible.

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").

width

width: number

Width of the overlay in iframe mode.

Generated using TypeDoc