Class DDDraggable

Interface for HTML elements extended with drag & drop options. Used to associate DD configuration with DOM elements.

Hierarchy (View Summary)

DDBaseImplement
- DDDraggable

Implements

HTMLElementExtendOpt<DDDragOpt>

Index

Accessors

Constructors

Methods

destroy disable enable off on triggerEvent updateOption

Properties

el helper option

Accessors

disabled

get disabled(): boolean
Returns the current disabled state. Note: Use enable()/disable() methods to change state as other operations need to happen.

Returns boolean
Inherited from DDBaseImplement.disabled
- Defined in dd-base-impl.ts:22

Constructors

constructor

new DDDraggable(el: GridItemHTMLElement, option?: DDDragOpt): DDDraggable
Parameters
- el: GridItemHTMLElement
- option: DDDragOpt = {}
Returns DDDraggable
Overrides DDBaseImplement.constructor
- Defined in dd-draggable.ts:65

Methods

destroy

destroy(): void
Destroy this drag & drop implementation and clean up resources. Removes all event handlers and clears internal state.

Returns void
Overrides DDBaseImplement.destroy
- Defined in dd-draggable.ts:118

disable

disable(forDestroy?: boolean): void
Disable this drag & drop implementation. Subclasses should override to perform additional cleanup.
Parameters
- forDestroy: boolean = false
Returns void
Overrides DDBaseImplement.disable
- Defined in dd-draggable.ts:105

enable

enable(): void
Enable this drag & drop implementation. Subclasses should override to perform additional setup.

Returns void
Overrides DDBaseImplement.enable
- Defined in dd-draggable.ts:91

off

off(event: DDDragEvent): void
Unregister an event callback for the specified event.
Parameters
- event: DDDragEvent
  Event name to stop listening for
Returns void
Overrides DDBaseImplement.off
- Defined in dd-draggable.ts:87

on

on(event: DDDragEvent, callback: (event: DragEvent) => void): void
Register an event callback for the specified event.
Parameters
- event: DDDragEvent
  Event name to listen for
- callback: (event: DragEvent) => void
  Function to call when event occurs
Returns void
Overrides DDBaseImplement.on
- Defined in dd-draggable.ts:83

triggerEvent

triggerEvent(eventName: string, event: Event): boolean | void
Trigger a registered event callback if one exists and the implementation is enabled.
Parameters
- eventName: string
  Name of the event to trigger
- event: Event
  DOM event object to pass to the callback
Returns boolean | void
Result from the callback function, if any
Inherited from DDBaseImplement.triggerEvent
- Defined in dd-base-impl.ts:81

updateOption

updateOption(opts: DDDragOpt): DDDraggable
Method to update the options and return the DD implementation
Parameters
- opts: DDDragOpt
Returns DDDraggable
Implementation of HTMLElementExtendOpt.updateOption
- Defined in dd-draggable.ts:129

Properties

el

el: GridItemHTMLElement

The HTML element being extended

helper

helper: HTMLElement

option

option: DDDragOpt = {}

The drag & drop options/configuration