Class BaseToolbar

A base class for realisation of toolbars

Source : file toolbars/baseToolbar/BaseToolbar.js at line 40

Constructor

new BaseToolbar ( )

The constructor

Source : file toolbars/baseToolbar/BaseToolbar.js at line 237

Public methods

addCssClass ( cssClass )

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

Source : file toolbars/baseToolbar/BaseToolbar.js at line 354

Parameters

Name Type Description
cssClass String

The css class to add

addToolbarItem ( toolbarItem )

Add a ToolbarItem on the collection of ToolbarItems

Source : file toolbars/baseToolbar/BaseToolbar.js at line 345

Parameters

Name Type Description
toolbarItem ToolbarItem

An object with data to configure the button

createUI ( headerText, position )

Create the toolbar container and header

Source : file toolbars/baseToolbar/BaseToolbar.js at line 279

Parameters

Name Type Description
headerText String

The text to display on the header of the toolbar

position TOOLBAR_POSITION

The position of the toolbar on the screen

hide ( )

Hide the toolbar

Source : file toolbars/baseToolbar/BaseToolbar.js at line 245

Private properties

#buttonHTMLElementClickEL : ButtonHTMLElementClickEL

The click event listener for the buttons

Source : file toolbars/baseToolbar/BaseToolbar.js at line 82

#buttonHTMLElementTouchEL : ButtonHTMLElementTouchEL

The touch event listener for the buttons

Source : file toolbars/baseToolbar/BaseToolbar.js at line 89

#buttonsHTMLElement : HTMLElement

The HTML element that contains the buttons

Source : file toolbars/baseToolbar/BaseToolbar.js at line 54

#buttonsHTMLElementTouchEL : ButtonsHTMLElementTouchEL

The touch event listener for the buttons container

Source : file toolbars/baseToolbar/BaseToolbar.js at line 75

#buttonsHTMLElementWheelEL : ButtonsHTMLElementWheelEL

The wheel event listener for the buttons container

Source : file toolbars/baseToolbar/BaseToolbar.js at line 68

#isShow : Boolean

A boolean saving the the current state of the toolbar

Source : file toolbars/baseToolbar/BaseToolbar.js at line 96

#lastMouseEventTimestamp : Number

The timestamp of the last mouseenter or click event

Source : file toolbars/baseToolbar/BaseToolbar.js at line 118

#timerId : Number

Timer id for the mouse leave event

Source : file toolbars/baseToolbar/BaseToolbar.js at line 61

#toolbarHTMLElement : HTMLElement

The main HTMLElement of the toolbar

Source : file toolbars/baseToolbar/BaseToolbar.js at line 47

#toolbarItemsContainer : ToolbarItemsContainer

An object with the ToolbarItems array. Needed to have an object to share with EL.

Source : file toolbars/baseToolbar/BaseToolbar.js at line 103

Private getters and setters

readonly static get #MOUSE_EVENT_MAX_DELAY : Number

The max delay between a mouseenter and a click event to consider the two events as a single event

Source : file toolbars/baseToolbar/BaseToolbar.js at line 111

Private methods

#addButton ( toolbarItem, index )

Add a button to the toolbar

Source : file toolbars/baseToolbar/BaseToolbar.js at line 126

Parameters

Name Type Description
toolbarItem ToolbarItem

The toolbar item for witch the button will be created

index Number

The position of the toolbar item in the #toolbarItemsContainer.toolbarItemsArray

#show ( )

Show the toolbar

Source : file toolbars/baseToolbar/BaseToolbar.js at line 146

#toolbarHTMLElementClickEL ( mouseEvent )

Click on the toolbar event listener. It's needed for touch devices where the mouseenter EL don't work. Remember that toolbars are global objects never deleted, so we can have EL as simple member methods

Source : file toolbars/baseToolbar/BaseToolbar.js at line 184

Parameters

Name Type Description
mouseEvent Event

The trigered event

#toolbarHTMLElementMouseEnterEL ( mouseEvent )

Mouse enter on the toolbar event listener Remember that toolbars are global objects never deleted, so we can have EL as simple member methods

Source : file toolbars/baseToolbar/BaseToolbar.js at line 202

Parameters

Name Type Description
mouseEvent Event

The trigered event

#toolbarHTMLElementMouseLeaveEL ( )

Mouse leave the toolbar event listener Remember that toolbars are global objects never deleted, so we can have EL as simple member methods

Source : file toolbars/baseToolbar/BaseToolbar.js at line 227