js.Dialog

Utility Functions

These are some global functions that are used by js.Dialog:

Content: ⊞⇅⊟

• Dialog Registry
  • _registry
  • getById
  • register
  • unregister
• Cancellation
  • cancel
  • cancelAll

Dialog Registry:

The Dialog Registry is an Hash-Array in which all currently open dialogs (yes, you can have more than one open at a time) are stored. Keys for the Hash are always the unique ids that are also stored in the dialog's uniqueId property. The registry itself as well as all its functions should be treated as private, and they are listed here for documentation only:

Dialog._registry

The actual storage space for the dialog objects.

Type: Hash

Dialog.getById

Returns the dialog which has a particular uid or null if it wasn’t found.

Parameters: Integer: uid (required)

Returns: Dialog.core

Dialog.register

Registers a dialog in the registry.

Parameters: Dialog.core: dc (required)

Returns: void

Dialog.unregister

Removes a dialog from the registry and the DOM-tree.

Parameters: Integer: uid (required)

Returns: void

Cancellation:

There are also two functions for cancelling dialogs programmatically:

Dialog.cancel

Cancels a dialog. The effect will be the same as if you click on the closebox or activate the Cancel-button (button0).

Parameters: Integer: uid (required)

Returns: void

Dialog.cancelAll

Cancels all open dialogs.

Parameters: none

Returns: void