Module: sdw/templates/widgets/toolbar

Dieses Modul definiert die Klasse Toolbar

Author:
  • sdw.systems
Source:
See:

Requires

  • module:sdw/util
  • module:sdw/const
  • module:sdw/command
  • module:dijit/Toolbar
  • module:dijit/ToolbarSeparator
  • module:dijit/form/Button
  • module:dijit/form/DropDownButton
  • module:dijit/Menu
  • module:dijit/MenuItem

Members

(private) contentPaneToolbar

Source:

(private) debug

Source:

(private) delegate

Source:

(private) languagePack

Source:

moduleName

Properties:
Name Type Description
moduleName String

Name des Moduls aus lokaler Konstante

Source:

toolbarButtons

Properties:
Name Type Description
toolbarButtons Object

Assoziativer Array der den UUIDs als id der Buttons eine Konstante zuweist

Source:

toolbarButtonsArray

Properties:
Name Type Description
toolbarButtonsArray Object

Ergebnis des Aufrufs der Methode getToolbarButtons

Source:

Methods

_onClickToolbarButtonWithDomId_(domId)

Wird von onClickToolbarButtonWithEvt aufgerufen und versucht den Clickevent auf den Button mit der übergebenen DomId zu verarbeiten. Dazu wird geprüft, ob ein Delegate-Objekt existiert und ob dieses eine onClickToolbarButton(domId)-Methode hat. Wenn ja, wird diese aufgerufen. Als Ergebnis wird ein Boolean erwartet der anzeigt, ob der Event verarbeitet wurde. Falls das nicht der Fall ist wird onClickToolbarButton(domId) lokal aufgerufen in der Hoffnung, dass eine abgeleitete Klasse diese Methode überschrieben hat.

Parameters:
Name Type Description
domId String

Eine Konstante die angibt, welcher Button gedrückt worden ist

Source:

_onClickToolbarButtonWithEvt_(evt)

Callback, der von den Toolbarbuttons aufgerufen wird falls drauf geklickt worden ist. Übersetzt das Ecentobjekt in die DomdId des geklickten Buttons und ruft damit parametrisiert die Methode onClickToolbarButtonWithDomId auf.

Parameters:
Name Type Description
evt Object

Das Eventobjekt

Source:

constructor(args, delegate)

Der Konstruktor stellt alle Argumente innerhalb der Klasse unter this.argument zur Verfügung. Danach wird setProperties() aufgerufen um abgeleiteten Klassen nochmals Gelegenheit zu geben Eigenschaften zu setzen. Der Array toolbarButtons wird initialisiert Das lokale toolBar-Objekt wird gebaut mit this.toolBar=this.createToolbar(this.getToolbarButtons()); Die Toolbar wird in den ContentPane eingehängt

Parameters:
Name Type Description
args Object

Argumentobjekt

Properties
Name Type Description
debug Boolean

Debugflag

languagePack module:sdw/languagePack

Zeiger auf das I18N Objekt des Applikationscontainers

viewPane module:dijit/layout/ContentPane

Zeiger auf den ContentPane, in dem dieser toolbar dargestellt werden soll.

delegate Object

Zeiger auf ein delegate-Objekt, welches die Methode onClickToolbarButton(domId) implementiert. Optional, wenn es kein delegate gibt muss eine abgeleitete Klasse diese Methode implementieren.

Source:

createToolbar(toolbarButtons)

Erzeugt die Toolbar als dijit/Toolbar nach Maßgabe des toolbarButtons-Objektes welches die Nethode createToolbar() zurückgibt.

Parameters:
Name Type Description
toolbarButtons Array.<Object>

Array der Toolbarbutton-Objekte

Properties
Name Type Description
label String

Der auf dem Button angezeigte Label

domId String

Konstante, die den Typ des Buttons festlegt für das spätere dispatchen, z.B. SDWConst.domIdAdd, SDWConst.domIdEdit, SDWConst.domIdRemove usw.

iconClass String

Das auf dem Button angezeigte Icon als css-Klassenangabe

parent String

Für gschachtelte Menüs im DropDownButtonStil die Angabe der domId des Vaterobjektes. Buttons der obersten Ebene müssen in diesem Fall das parent-Objekt auf parent:SDWConst.domIdRoot setzen

Source:

disableAllToolbarButtons()

Alle Toolbarbuttons inaktiv setzen und ausgrauen. Ruft this.disableToolbarButton für alle Buttons auf.

Source:

disableToolbarButton(domId)

Einen Toolbarbutton inaktiv setzen und ausgrauen. FIXME Falls der Button in einem Menü geschachtelt ist soll das Menü auch disabled weren falls es keine weiteren Buttons hat die enabled sind.

Parameters:
Name Type Description
domId String

Eine Konstante die angibt, um welchen Button es sich handelt

Source:

enableToolbarButton(domId)

Einen Toolbarbutton aktiv setzen. Falls dieser in einem Menü verschachtelt ist muss auch das Menü enabled werden.

Parameters:
Name Type Description
domId String

Eine Konstante die angibt, um welchen Button es sich handelt

Source:

getToolbarButtons() → {Object}

Gibt einen Array der Toolbarbuttons zurück. Muss von der aufrufenden Klasse überschrieben werden.

Source:
Returns:

defaultToolBarButtons

Type
Object

onClickToolbarButton(domID) → {Boolean}

Gibt der abgeleiteten Klasse die Möglichkeit auf einen Buttonclick zu reagieren.
Wird nur aufgerufen, wenn die Basisklasse das Event nicht selber bearbeiten kann, d.h. für den Buttontyp der geklickt worden ist keine Standardmethode kennt. Pure virtual, gibt lediglich eine Warnung aus falls diese Methode von der abgeleiteten Klasse nicht korrekt überschrieben wurde

Parameters:
Name Type Description
domID String

Die DomId des Buttons der gedrückt worden ist

Source:
Returns:

Zeigt an, ob der Event verarbeitet werden konnte oder ob ggf. weitere Empfänger angesprochen werden müssen.

Type
Boolean

setProperties()

Gibt der abgeleiteten Klasse neben den Constructor args die Möglichkeit Eigenschaften der Basisklasse zu setzen. Wird vom Konstruktor der Basisklasse aufgerufen. Pure virtual, gibt lediglich eine Warnung aus falls diese Methode von der abgeleiteten Klasse nicht korrekt überschrieben wurde

Source: