Class InfoDialog

A generic info dialog box

Hierarchy (View Summary)

DraggableDialog
- InfoDialog
  - CopyDialog

Index

Constructors

Properties

action actions background content dialog dragging events h minH minW mode node noDrag title tx ty w x y className id styleId styles

Constructors

constructor

new InfoDialog(args: DialogArgs): InfoDialog
Parameters
- args: DialogArgs
  The data describing the dialog
Returns InfoDialog
Inherited from DraggableDialog.constructor
- Defined in ts/ui/dialog/DraggableDialog.ts:497

Properties

`Protected`action

action: string

The drag acction being taken (move, left, right, top, bottom, etc.)

`Protected`actions

actions: ActionMap = ...

Functions to handle the various mouse events, returning an array [dx, dy, dw, dh] of changes to the position and size od the dialog.

`Protected`background

background: HTMLElement

The background element when

`Protected`content

content: HTMLElement

The content div element

`Protected`dialog

dialog: HTMLDialogElement

The dialog element node

`Protected`dragging

dragging: boolean = false

True when the dialog is being dragged or sized

`Protected`events

events: any[][] = ...

Events to add when dragging and remove when drag completes

`Protected`h

h: number

The current dialog height

`Protected`minH

minH: number = 80

The maximum width of the dialog

`Protected`minW

minW: number = 200

The minimum width of the dialog

`Protected`mode

mode: string = ''

When moving/sizing by keyboard, this gives which is being adjusted.

`Protected`node

node: HTMLElement

The node to focus when dialog closes

`Protected`noDrag

noDrag: HTMLElement[]

Elements where clicking doesn't cause dragging

`Protected`title

title: HTMLElement

The title element

`Protected`tx

tx: number = 0

The current x translation of the dialog

`Protected`ty

ty: number = 0

The current y translation of the dialog

`Protected`w

w: number

The current dialog width

`Protected`x

x: number

The current mouse x position

`Protected`y

y: number

The current mouse y position

`Static`className

className: string = ''

The class name to use for the dialog, if any

`Static`id

id: number = 0

An id incremented for each instance of a dialog

`Static`styleId

styleId: string = 'MJX-DIALOG-styles'

The style element ID for dialog styles

`Static`styles

styles: StyleJson = ...

The default styles for all dialogs

Methods

`Protected`actionKey

actionKey(action: (event: KeyboardEvent) => void, event: KeyboardEvent): void
Handle the enter or space key on a button icon
Parameters
- action: (event: KeyboardEvent) => void
  The action to take on enter or space
- event: KeyboardEvent
  The event to check
Returns void
Inherited from DraggableDialog.actionKey
- Defined in ts/ui/dialog/DraggableDialog.ts:1008

`Protected`aKey

aKey(event: KeyboardEvent): void
Handle the "a" key for selecting all
Parameters
- event: KeyboardEvent
  The key event to handle
Returns void
Inherited from DraggableDialog.aKey
- Defined in ts/ui/dialog/DraggableDialog.ts:955

`Protected`arrowKey

arrowKey(event: KeyboardEvent, direction: string): void
Handle the arrow keys
Parameters
- event: KeyboardEvent
  The key event to handle
- direction: string
  The direction of the arrow
Returns void
Inherited from DraggableDialog.arrowKey
- Defined in ts/ui/dialog/DraggableDialog.ts:988

attach

attach(): void
Add the dialog to the page and attach the event handlers

Returns void
Inherited from DraggableDialog.attach
- Defined in ts/ui/dialog/DraggableDialog.ts:662

`Protected`closeDialog

closeDialog(event?: Event): void
Close the dialog
Parameters
- Optionalevent: Event
  The event that caused the closure
Returns void
Inherited from DraggableDialog.closeDialog
- Defined in ts/ui/dialog/DraggableDialog.ts:1091

copyToClipboard

copyToClipboard(): void
Implement the copy-to-clipboard action

Returns void
Inherited from DraggableDialog.copyToClipboard
- Defined in ts/ui/dialog/DraggableDialog.ts:1028

`Protected`dragAction

dragAction(type: string, event?: MouseEvent): void
Perform a drag action (resize or move)
Parameters
- type: string
  The action type to perform
- event: MouseEvent = null
  The event causing the action
Returns void
Inherited from DraggableDialog.dragAction
- Defined in ts/ui/dialog/DraggableDialog.ts:797

`Protected`endDrag

endDrag(): void
End a dragging operation

Returns void
Inherited from DraggableDialog.endDrag
- Defined in ts/ui/dialog/DraggableDialog.ts:1071

`Protected`escKey

escKey(event: KeyboardEvent): void
Handle the Escape key
Parameters
- event: KeyboardEvent
  The key event to handle
Returns void
Inherited from DraggableDialog.escKey
- Defined in ts/ui/dialog/DraggableDialog.ts:946

`Protected`getWH

getWH(): void
Cache the current width and height values.

Returns void
Inherited from DraggableDialog.getWH
- Defined in ts/ui/dialog/DraggableDialog.ts:1063

`Protected`helpDialog

helpDialog(adaptor: ADAPTOR, event: Event): void
Display the dialog help message
Parameters
- adaptor: ADAPTOR
  The DOM adaptor to use
- event: Event
  The event that triggered the help
Returns void
Inherited from DraggableDialog.helpDialog
- Defined in ts/ui/dialog/DraggableDialog.ts:1110

`Protected`html

html(args: DialogArgs): HTMLDialogElement
Create the HTML for the dialog layout
Parameters
- args: DialogArgs
  The data describing the dialog
Returns HTMLDialogElement
The dialog node
Inherited from DraggableDialog.html
- Defined in ts/ui/dialog/DraggableDialog.ts:550

`Protected`inDialog

inDialog(event: MouseEvent): boolean
Check if an event is inside the dialog.
Parameters
- event: MouseEvent
  The event to check
Returns boolean
True if the event is in the dialog, false if in the background
Inherited from DraggableDialog.inDialog
- Defined in ts/ui/dialog/DraggableDialog.ts:1132

`Protected`init

init(adaptor: ADAPTOR): void
Create the stylesheet, if it hasn't already been done
Parameters
- adaptor: ADAPTOR
  The DOM adaptor to use
Returns void
Inherited from DraggableDialog.init
- Defined in ts/ui/dialog/DraggableDialog.ts:534

`Protected`KeyDown

KeyDown(event: KeyboardEvent): void
Handle a keydown event
Parameters
- event: KeyboardEvent
  The key event to handle
Returns void
Inherited from DraggableDialog.KeyDown
- Defined in ts/ui/dialog/DraggableDialog.ts:933

`Protected`mKey

mKey(event: KeyboardEvent): void
Start or stop moving the dialog via arrow keys
Parameters
- event: KeyboardEvent
  The key event to handle
Returns void
Inherited from DraggableDialog.mKey
- Defined in ts/ui/dialog/DraggableDialog.ts:967

`Protected`MouseDown

MouseDown(event: MouseEvent): void
Handle a mousedown event
Parameters
- event: MouseEvent
  The mouse event to handle
Returns void
Inherited from DraggableDialog.MouseDown
- Defined in ts/ui/dialog/DraggableDialog.ts:857

`Protected`MouseMove

MouseMove(event: MouseEvent): void
Handle a mousemove event
Parameters
- event: MouseEvent
  The mouse event to handle
Returns void
Inherited from DraggableDialog.MouseMove
- Defined in ts/ui/dialog/DraggableDialog.ts:897

`Protected`MouseUp

MouseUp(event: MouseEvent): void
Handle a mouseup event
Parameters
- event: MouseEvent
  The mouse event to handle
Returns void
Inherited from DraggableDialog.MouseUp
- Defined in ts/ui/dialog/DraggableDialog.ts:911

`Protected`selectAll

selectAll(): void
Select the content of the dialog for copying

Returns void
Inherited from DraggableDialog.selectAll
- Defined in ts/ui/dialog/DraggableDialog.ts:1020

`Protected`sKey

sKey(event: KeyboardEvent): void
Start or stop sizing the dialog via arrow keys
Parameters
- event: KeyboardEvent
  The key event to handle
Returns void
Inherited from DraggableDialog.sKey
- Defined in ts/ui/dialog/DraggableDialog.ts:977

`Protected`startDrag

startDrag(event: MouseEvent): void
Start dragging for a move or resize action.
Parameters
- event: MouseEvent
  The mousedown event starting the drag
Returns void
Inherited from DraggableDialog.startDrag
- Defined in ts/ui/dialog/DraggableDialog.ts:1043

`Protected`stop

stop(event: Event): void
Stop event propagation
Parameters
- event: Event
  The event that is to be stopped
Returns void
Inherited from DraggableDialog.stop
- Defined in ts/ui/dialog/DraggableDialog.ts:1146

`Protected`Visibility

Visibility(): void
Close the dialog if the pages becomes hidden (e.g., moving foreward or backward in the window's history).

Returns void
Inherited from DraggableDialog.Visibility
- Defined in ts/ui/dialog/DraggableDialog.ts:922

`Static`post

post(args: DialogArgs): DraggableDialog
Create and display a dialog with the given args
Parameters
- args: DialogArgs
  The data describing the dialog
Returns DraggableDialog
The dialog instance
- Defined in ts/ui/dialog/InfoDialog.ts:38

Class InfoDialog

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns InfoDialog

Properties

Protectedaction

Protectedactions

Protectedbackground

Protectedcontent

Protecteddialog

Protecteddragging

Protectedevents

Protectedh

ProtectedminH

ProtectedminW

Protectedmode

Protectednode

ProtectednoDrag

Protectedtitle

Protectedtx

Protectedty

Protectedw

Protectedx

Protectedy

StaticclassName

Staticid

StaticstyleId

Staticstyles

Methods

ProtectedactionKey

Parameters

Returns void

ProtectedaKey

Parameters

Returns void

ProtectedarrowKey

Parameters

Returns void

attach

Returns void

ProtectedcloseDialog

Parameters

Returns void

copyToClipboard

Returns void

ProtecteddragAction

Parameters

Returns void

ProtectedendDrag

Returns void

ProtectedescKey

Parameters

Returns void

ProtectedgetWH

Returns void

ProtectedhelpDialog

Parameters

Returns void

Protectedhtml

Parameters

Returns HTMLDialogElement

ProtectedinDialog

Parameters

Returns boolean

Protectedinit

Parameters

Returns void

ProtectedKeyDown

Parameters

Returns void

ProtectedmKey

Parameters

Returns void

ProtectedMouseDown

`Protected`action

`Protected`actions

`Protected`background

`Protected`content

`Protected`dialog

`Protected`dragging

`Protected`events

`Protected`h

`Protected`minH

`Protected`minW

`Protected`mode

`Protected`node

`Protected`noDrag

`Protected`title

`Protected`tx

`Protected`ty

`Protected`w

`Protected`x

`Protected`y

`Static`className

`Static`id

`Static`styleId

`Static`styles

`Protected`actionKey

`Protected`aKey

`Protected`arrowKey

`Protected`closeDialog

`Protected`dragAction

`Protected`endDrag

`Protected`escKey

`Protected`getWH

`Protected`helpDialog

`Protected`html

`Protected`inDialog

`Protected`init

`Protected`KeyDown

`Protected`mKey

`Protected`MouseDown

`Protected`MouseMove

`Protected`MouseUp

`Protected`selectAll

`Protected`sKey

`Protected`startDrag

`Protected`stop

`Protected`Visibility

`Static`post