Class DialogManager

base class for event dispatching using d3 event mechanism, thus .suffix is supported for multiple registrations

Hierarchy (View Summary)

AEventDispatcher
- DialogManager

Index

Constructors

constructor

new DialogManager(
    options: {
        doc: Document;
        livePreviews: Partial<ILivePreviewOptions>;
        onDialogBackgroundClick: "cancel" | "confirm";
    },
): DialogManager
Parameters
- options: {
      doc: Document;
      livePreviews: Partial<ILivePreviewOptions>;
      onDialogBackgroundClick: "cancel" | "confirm";
  }
Returns DialogManager
Overrides AEventDispatcher.constructor
- Defined in ui/dialogs/DialogManager.ts:39

Properties

`Readonly`livePreviews

livePreviews: Partial<ILivePreviewOptions>

`Readonly`node

node: HTMLElement

`Readonly`onDialogBackgroundClick

onDialogBackgroundClick: "cancel" | "confirm"

`Static` `Readonly`EVENT_DIALOG_CLOSED

EVENT_DIALOG_CLOSED: "dialogClosed" = 'dialogClosed'

`Static` `Readonly`EVENT_DIALOG_OPENED

EVENT_DIALOG_OPENED: "dialogOpened" = 'dialogOpened'

Accessors

maxLevel

get maxLevel(): number
Returns number
- Defined in ui/dialogs/DialogManager.ts:69

Methods

clearHighlight

clearHighlight(): void
Returns void
- Defined in ui/dialogs/DialogManager.ts:112

`Protected`createEventList

createEventList(): string[]
return the list of events to be able to dispatch

Returns string[]
by default no events
Overrides AEventDispatcher.createEventList
- Defined in ui/dialogs/DialogManager.ts:58

`Protected`fire

fire(type: string | string[], ...args: any[]): void
Parameters
- type: string | string[]
- ...args: any[]
Returns void
Inherited from AEventDispatcher.fire
- Defined in internal/AEventDispatcher.ts:101

`Protected`forward

forward(from: IEventHandler, ...types: string[]): void
forwards one or more events from a given dispatcher to the current one i.e. when one of the given events is fired in 'from' it will be forwarded to all my listeners
Parameters
- from: IEventHandler
  the event dispatcher to forward from
- ...types: string[]
  the event types to forward
Returns void
Inherited from AEventDispatcher.forward
- Defined in internal/AEventDispatcher.ts:137

`Protected`listenersChanged

listenersChanged(_type: string, _active: boolean): void
helper function that will be called upon a listener has changed
Parameters
- _type: string
  event type
- _active: boolean
  registered or de registered
Returns void
Inherited from AEventDispatcher.listenersChanged
- Defined in internal/AEventDispatcher.ts:89

on

on(type: "dialogOpened", listener: (dialog: ADialog) => void): this
Parameters
- type: "dialogOpened"
- listener: (dialog: ADialog) => void
  - - (dialog: ADialog): void
    - emitted a dialog is opened
      
      Parameters
      dialog: ADialog
      the opened dialog
      
      Returns void
      As Member Of
      DialogManager
Returns this
Overrides AEventDispatcher.on
- Defined in ui/dialogs/DialogManager.ts:62
on(
type: "dialogClosed",
listener: (dialog: ADialog, action: "cancel" | "confirm") => void,
): this
Parameters
- type: "dialogClosed"
- listener: (dialog: ADialog, action: "cancel" | "confirm") => void
  - - (dialog: ADialog, action: "cancel" | "confirm"): void
    - emitted a dialog is closed
      
      Parameters
      dialog: ADialog
      the closed dialog
      
      action: "cancel" | "confirm"
      the action how the dialog was closed
      
      Returns void
      As Member Of
      DialogManager
Returns this
Overrides AEventDispatcher.on
- Defined in ui/dialogs/DialogManager.ts:63
on(type: string | string[], listener: IEventListener): this
Parameters
- type: string | string[]
- listener: IEventListener
Returns this
Overrides AEventDispatcher.on
- Defined in ui/dialogs/DialogManager.ts:64

push

push(dialog: ADialog): void
Parameters
- dialog: ADialog
Returns void
- Defined in ui/dialogs/DialogManager.ts:186

remove

remove(dialog: ADialog, handled?: boolean): boolean
Parameters
- dialog: ADialog
- handled: boolean = false
Returns boolean
- Defined in ui/dialogs/DialogManager.ts:137

removeAboveLevel

removeAboveLevel(level: number): void
Parameters
- level: number
Returns void
- Defined in ui/dialogs/DialogManager.ts:156

removeAll

removeAll(): void
Returns void
- Defined in ui/dialogs/DialogManager.ts:124

removeLike

removeLike(dialog: ADialog): boolean
Parameters
- dialog: ADialog
Returns boolean
- Defined in ui/dialogs/DialogManager.ts:164

setHighlight

setHighlight(
mask: { height: number; left: number; top: number; width: number },
): void
Parameters
- mask: { height: number; left: number; top: number; width: number }
Returns void
- Defined in ui/dialogs/DialogManager.ts:73

setHighlightColumn

setHighlightColumn(column: Column): void
Parameters
- column: Column
Returns void
- Defined in ui/dialogs/DialogManager.ts:91

triggerDialogClosed

triggerDialogClosed(dialog: ADialog, action: "cancel" | "confirm"): void
Parameters
- dialog: ADialog
- action: "cancel" | "confirm"
Returns void
- Defined in ui/dialogs/DialogManager.ts:133

`Protected`unforward

unforward(from: IEventHandler, ...types: string[]): void
removes the forwarding declarations
Parameters
- from: IEventHandler
  the originated dispatcher
- ...types: string[]
  event types to forward
Returns void
Inherited from AEventDispatcher.unforward
- Defined in internal/AEventDispatcher.ts:146

Class DialogManager

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DialogManager

Properties

ReadonlylivePreviews

Readonlynode

ReadonlyonDialogBackgroundClick

Static ReadonlyEVENT_DIALOG_CLOSED

Static ReadonlyEVENT_DIALOG_OPENED

Accessors

maxLevel

Returns number

Methods

clearHighlight

Returns void

ProtectedcreateEventList

Returns string[]

Protectedfire

Parameters

Returns void

Protectedforward

Parameters

Returns void

ProtectedlistenersChanged

Parameters

Returns void

on

Parameters

Parameters

Returns void

As Member Of

Returns this

Parameters

Parameters

Returns void

As Member Of

Returns this

Parameters

Returns this

push

Parameters

Returns void

remove

Parameters

Returns boolean

removeAboveLevel

Parameters

Returns void

removeAll

Returns void

removeLike

Parameters

Returns boolean

setHighlight

Parameters

Returns void

setHighlightColumn

Parameters

Returns void

triggerDialogClosed

Parameters

Returns void

Protectedunforward

Parameters

Returns void

Settings

On This Page

`Readonly`livePreviews

`Readonly`node

`Readonly`onDialogBackgroundClick

`Static` `Readonly`EVENT_DIALOG_CLOSED

`Static` `Readonly`EVENT_DIALOG_OPENED

`Protected`createEventList

`Protected`fire

`Protected`forward

`Protected`listenersChanged

`Protected`unforward