Class DialogManager

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

Hierarchy (view full)

AEventDispatcher
- DialogManager

Index

Constructors

constructor

new DialogManager(options): DialogManager
Parameters
- options: {
      doc: Document;
      livePreviews: Partial<ILivePreviewOptions>;
      onDialogBackgroundClick: "cancel" | "confirm";
  }
  - 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, ...args): void
Parameters
- type: string | string[]
- Rest ...args: any[]
Returns void
Inherited from AEventDispatcher.fire
- Defined in internal/AEventDispatcher.ts:101

`Protected` forward

forward(from, ...types): 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
- Rest ...types: string[]
  the event types to forward
Returns void
Inherited from AEventDispatcher.forward
- Defined in internal/AEventDispatcher.ts:137

`Protected` listenersChanged

listenersChanged(_type, _active): 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, listener): this
Parameters
- type: "dialogOpened"
- listener: ((dialog) => void)
  - - (dialog): void
    - emitted a dialog is opened
      
      Parameters
      dialog: ADialog
      the opened dialog
      
      Returns void
      As Member Of
      DialogManager
      
      Group
      Events
Returns this
Overrides AEventDispatcher.on
- Defined in ui/dialogs/DialogManager.ts:62
on(type, listener): this
Parameters
- type: "dialogClosed"
- listener: ((dialog, action) => void)
  - - (dialog, action): 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
      
      Group
      Events
Returns this
Overrides AEventDispatcher.on
- Defined in ui/dialogs/DialogManager.ts:63
on(type, listener): this
Parameters
- type: string | string[]
- listener: IEventListener
Returns this
Overrides AEventDispatcher.on
- Defined in ui/dialogs/DialogManager.ts:64

push

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

remove

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

removeAboveLevel

removeAboveLevel(level): 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): boolean
Parameters
- dialog: ADialog
Returns boolean
- Defined in ui/dialogs/DialogManager.ts:164

setHighlight

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

setHighlightColumn

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

triggerDialogClosed

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

`Protected` unforward

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

Class DialogManager

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: { doc: Document; livePreviews: Partial<ILivePreviewOptions>; onDialogBackgroundClick: "cancel" | "confirm"; }

doc: Document

livePreviews: Partial<ILivePreviewOptions>

onDialogBackgroundClick: "cancel" | "confirm"

Returns DialogManager

Properties

Readonly livePreviews

Readonly node

Readonly onDialogBackgroundClick

Static Readonly EVENT_DIALOG_CLOSED

Static Readonly EVENT_DIALOG_OPENED

Accessors

maxLevel

Returns number

Methods

clearHighlight

Returns void

Protected createEventList

Returns string[]

Protected fire

Parameters

type: string | string[]

Rest ...args: any[]

Returns void

Protected forward

Parameters

from: IEventHandler

Rest ...types: string[]

Returns void

Protected listenersChanged

Parameters

_type: string

_active: boolean

Returns void

on

Parameters

type: "dialogOpened"

listener: ((dialog) => void)

Parameters

dialog: ADialog

Returns void

As Member Of

Group

Returns this

Parameters

type: "dialogClosed"

listener: ((dialog, action) => void)

Parameters

dialog: ADialog

action: "cancel" | "confirm"

Returns void

As Member Of

Group

Returns this

Parameters

type: string | string[]

listener: IEventListener

Returns this

push

Parameters

dialog: ADialog

Returns void

remove

Parameters

dialog: ADialog

handled: boolean = false

Returns boolean

removeAboveLevel

Parameters

level: number

options: {
doc: Document;
livePreviews: Partial<ILivePreviewOptions>;
onDialogBackgroundClick: "cancel" | "confirm";
}

`Readonly` livePreviews

`Readonly` node

`Readonly` onDialogBackgroundClick

`Static` `Readonly` EVENT_DIALOG_CLOSED

`Static` `Readonly` EVENT_DIALOG_OPENED

`Protected` createEventList

`Protected` fire

`Rest` ...args: any[]

`Protected` forward

`Rest` ...types: string[]

`Protected` listenersChanged

mask: {
height: number;
left: number;
top: number;
width: number;
}

`Protected` unforward

`Rest` ...types: string[]