Options
All
  • Public
  • Public/Protected
  • All
Menu

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

addClasses?: boolean
appendTo?: any
axis?: string
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.

cancel?: string
connectToSortable?: string | Element | JQuery<HTMLElement> | Element[]
containment?: any
cursor?: string
cursorAt?: any
delay?: number
disabled?: boolean
distance?: number
formId?: string

ID of the form to use for AJAX requests.

grid?: number[]
handle?: any
helper?: any
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.

iframeFix?: any

Callback for when dragging starts.

Callback for when dragging ends.

opacity?: number
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.

refreshPositions?: boolean
revert?: any
revertDuration?: number
scope?: string
scroll?: boolean
scrollSensitivity?: number
scrollSpeed?: number
snap?: any
snapMode?: string
snapTolerance?: number
stack?: string
target: string

ID of the target of this draggable.

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

zIndex?: number

Generated using TypeDoc