Class BaseDialog

Base class used for dialogs

Source : file dialogs/baseDialog/BaseDialog.js at line 42

Constructor

new BaseDialog ( options )

The constructor

Source : file dialogs/baseDialog/BaseDialog.js at line 233

Parameters

Name Type Description
options BaseDialogOptions

The options for the dialog

Public getters and setters

readonly get contentHTMLElements : Array of HTMLElement

An array with the HTMLElements that have to be added in the content of the dialog. Can be overloaded in the derived classes

Source : file dialogs/baseDialog/BaseDialog.js at line 308

readonly get mover : BaseDialogMover

Get the mover object used with this dialog. Create the object if needed. Can be overloaded in the derived classes

Source : file dialogs/baseDialog/BaseDialog.js at line 269

readonly get options : BaseDialogOptions

The options of the dialog box

Source : file dialogs/baseDialog/BaseDialog.js at line 353

readonly get title : String

The title of the dialog. Can be overloaded in the derived classes

Source : file dialogs/baseDialog/BaseDialog.js at line 292

readonly get toolbarHTMLElement : null or HTMLElement

An HTMLElement that have to be added as toolbar for the dialog. Can be overloaded in the derived classes

Source : file dialogs/baseDialog/BaseDialog.js at line 300

Public methods

addCssClass ( cssClass )

Add a css class to the #dialogHTMLElement, so some css settings can be overloaded for a specific dialog

Source : file dialogs/baseDialog/BaseDialog.js at line 360

Parameters

Name Type Description
cssClass String

The css class to add

addToBackground ( backgroundElement )

Add the container to the background.

Source : file dialogs/baseDialog/BaseDialog.js at line 335

Parameters

Name Type Description
backgroundElement HTMLElement

The used background. The background can be the background created by the modal dialogs or the document.body for non modal dialogs

addToDialog ( htmlElement )

Add an element to the container

Source : file dialogs/baseDialog/BaseDialog.js at line 344

Parameters

Name Type Description
htmlElement HTMLElement

The element to add

onCancel ( )

Cancel button handler. Can be overloaded in the derived classes

Source : file dialogs/baseDialog/BaseDialog.js at line 275

onOk ( )

Ok button handler. Can be overloaded in the derived classes

Source : file dialogs/baseDialog/BaseDialog.js at line 283

removeFromBackground ( backgroundElement )

Remove the container from the background

Source : file dialogs/baseDialog/BaseDialog.js at line 325

Parameters

Name Type Description
backgroundElement HTMLElement

The used background. The background can be the background created by the modal dialogs or the document.body for non modal dialogs

show ( )

Show the dialog

Source : file dialogs/baseDialog/BaseDialog.js at line 314

Private properties

#baseDialogMover : BaseDialogMover

BaseDialogMover for drag ond drop and touch operations

Source : file dialogs/baseDialog/BaseDialog.js at line 83

#cancelButton : HTMLElement

The cancel button on the top bar

Source : file dialogs/baseDialog/BaseDialog.js at line 69

#cancelButtonClickEL : CancelButtonClickEL

Cancel button click event listener

Source : file dialogs/baseDialog/BaseDialog.js at line 111

#contentHTMLElement : HTMLElement

The content HTMLElement

Source : file dialogs/baseDialog/BaseDialog.js at line 76

#dialogHTMLElement : HTMLElement

The container HTMLElement of the dialog

Source : file dialogs/baseDialog/BaseDialog.js at line 55

#options : null or Object

Options parameter

Source : file dialogs/baseDialog/BaseDialog.js at line 118

#topBarDragEndEL : TopBarDragEndEL

Top bar drag end event listener

Source : file dialogs/baseDialog/BaseDialog.js at line 97

#topBarDragStartEL : TopBarDragStartEL

Top bar drag start event listener

Source : file dialogs/baseDialog/BaseDialog.js at line 90

#topBarHTMLElement : HTMLElement

The topbar HTMLElement

Source : file dialogs/baseDialog/BaseDialog.js at line 62

#topBarTouchEL : TopBarTouchEL

Top bar touch event listener

Source : file dialogs/baseDialog/BaseDialog.js at line 104

Private methods

#createContentHTMLElement ( )

Create the content HTMLElement

Source : file dialogs/baseDialog/BaseDialog.js at line 203

#createDialogHTMLElement ( )

Create the dialog container

Source : file dialogs/baseDialog/BaseDialog.js at line 124

#createHTML ( )

Create the HTML dialog

Source : file dialogs/baseDialog/BaseDialog.js at line 221

#createToolbarHTMLElement ( )

Create the toolbar HTMLElement

Source : file dialogs/baseDialog/BaseDialog.js at line 187

#createTopBarHTMLElement ( )

Create the top bar

Source : file dialogs/baseDialog/BaseDialog.js at line 140

#destructor ( )

Remove all events listeners and events dispatchers so all references to the dialog are released and finally remove all the htmlElements from the document

Source : file dialogs/baseDialog/BaseDialog.js at line 243