Module: sdw/templates/widgets/widgetController

Dieses Modul definiert die Klasse Tree

Egenschaften:

  1. Suche
  2. Insert/Updat/Delete
  3. Kontextmenü
  4. Drag and Drop
Author:
  • sdw.systems
Source:
See:
Author:
  • sdw.systems
Source:
See:

Requires

Members

(private) canvas

Source:

(private) canvas

Source:

contextMenueItemControls

Properties:
Name Type Description
Assoziativer Array.<Object>

Array der MenuItems die das Kontextmenü bilden. Identifier ist die ID die bei der Definition des contextMenueItems-Arrays mitgegeben werden, i.A. wohl UUIDs

Source:

contextMenueItemControls

Properties:
Name Type Description
Array Array.<Object>

der MenuItems die das Kontextmenü bilden

Source:

(private) contextMenueItems

Source:

contextMenueItems

Properties:
Name Type Description
Array Array.<Object>

der MenuItem-Objekte mit default-label, id (i.a. UUID), action (eine Konstante aus SDWConst.menuActionX) und iconClass (eine Konstante aus this.iconClass)

Source:

(private) debug

Source:

(private) debug

Source:

(private) delegate

Source:

(private) delegate

Source:

hasContextMenue

Properties:
Name Type Description
hasContextMenue Boolean

falls true wurd ein Kontextmenü verwendet, sonst false

Source:

(private) hasContextMenue

Source:

hasDefaultContextMenue

Properties:
Name Type Description
hasDefaultContextMenue Boolean

falls true, wird das Kontextmenü mit allen MenüItems verwendet. Falls false, muss die abgeleitete Klasse createContextMenue explizit aufrufen und dabei einen Array von Actions übergeben. In dem Fall werden nur für dieses Actions Menuitems erzeugt

Source:

(private) hasDefaultContextMenue

Source:

(private) languagePack

Source:

(private) languagePack

Source:

(private) metadata

Source:

(private) metadata

Source:

moduleName

Properties:
Name Type Description
moduleName String

Name des Moduls aus lokaler Konstante

Source:

moduleName

Properties:
Name Type Description
moduleName String

Name des Moduls aus lokaler Konstante

Source:

Methods

_onClickContextmenue_(evt)

Interner Handler für den Klick-Event auf ein Kontextmenüitem.

Parameters:
Name Type Description
evt Object

Das Event-Objekt

Source:

_onClickContextmenue_(evt)

Interner Handler für den Klick-Event auf ein Kontextmenüitem. Holt die gewünschte Action aus this.contextMenueItems anhand der ID des angeklickten MenuItems raus und ruft damit zusätzlich zum Event parametrisiert this.onClickContextmenueWithEvent auf. this.onClickContextmenueWithEvent sollte von den abgeleiteten Klassen überschrieben werden um dann auch was sinnvolles zu machen.

Parameters:
Name Type Description
evt Object

Das Event-Objekt

Source:

_onOpenContextMenue_(evt)

Interner Handler für den Rechtsklick-Event der das Kontextmenü öffnet.

Parameters:
Name Type Description
evt Object

Das Event-Objekt

Source:

_onOpenContextMenue_(evt)

Interner Handler für den Rechtsklick-Event der das Kontextmenü öffnet. Disabled alle Optionen des Defaultcontextmenüs und ruft dann this.onOpenContextMenueWithEvent auf. this.onOpenContextMenueWithEvent sollte von den abgeleiteten Klassen überschrieben werden. Aufgabe der spezifischen Implementierungen ist es, aus dem Event die jeweiligen fachlichen Objekte rauszuholen auf die drauf geklickt worden ist um zu entscheiden, welche Kontextmenüitems aktiv sind und wie diese beschriftet werdne.

Parameters:
Name Type Description
evt Object

Das Event-Objekt

Source:

constructor(args)

Der Konstruktor stellt alle Argumente innerhalb der Klasse unter this.argument zur Verfügung.

Parameters:
Name Type Description
args Object

Argumentobjekt

Properties
Name Type Description
debug Boolean

Debugflag

metadata module:sdw/metadata

Zeiger auf das Metadatenobjekt des Applikationscontainers

languagePack module:sdw/languagePack

Zeiger auf das I18N Objekt des Applikationscontainers

delegate Object

Zeiger auf Das Objekt das die Callbacks dieser Klasse verarbeitet

canvas module:dijit/layout/ContentPane

Zeiger auf den ContentPane, in dem dieser tree dargestellt werden soll. Falls canvas null ist, muss sich der delegate um die Darstellung kümmern, ansonsten wird in der Methode createGUI() das content-Attribut des Canvas auf den den Tree gesetzt.

autoExpand Boolean

True, falls der Tree initial vollständig aufgeklappt sein soll

queryRootItemParams Object

Parameter der initialen Query des RootItems, default ist {"level":"0"}

childrenAttrs Array.<String>

Liste der Attribute, die als Kindobjekte interpretiert werden, deafult ist ["children"]

hasContextMenue Boolean

True, falls der Tree ein Kontextmenü haben soll

hasDefaultContextMenue Boolean

True, falls der Tree ein Default-Kontextmenü haben soll

contextMenueItems Array.<Object>

Array der Custom-KontextmenüItems

Properties
Name Type Description
label String

Label des KontextmenüItems

id String

Id des KontextmenüItems

iconClass String

CSS-Iconklasse des KontextmenüItems

Source:

constructor(args)

Der Konstruktor stellt alle Argumente innerhalb der Klasse unter this.argument zur Verfügung.

Parameters:
Name Type Description
args Object

Argumentobjekt

Properties
Name Type Description
debug Boolean

Debugflag

metadata module:sdw/metadata

Zeiger auf das Metadatenobjekt des Applikationscontainers

languagePack module:sdw/languagePack

Zeiger auf das I18N Objekt des Applikationscontainers

delegate Object

Zeiger auf Das Objekt das die Callbacks dieser Klasse verarbeitet

canvas module:dijit/layout/ContentPane

Zeiger auf den ContentPane, in dem dieser tree dargestellt werden soll. Falls canvas null ist, muss sich der delegate um die Darstellung kümmern, ansonsten wird in der Methode createGUI() das content-Attribut des Canvas auf den den Tree gesetzt.

autoExpand Boolean

True, falls der Tree initial vollständig aufgeklappt sein soll

queryRootItemParams Object

Parameter der initialen Query des RootItems, default ist {"level":"0"}

childrenAttrs Array.<String>

Liste der Attribute, die als Kindobjekte interpretiert werden, deafult ist ["children"]

hasContextMenue Boolean

True, falls der Tree ein Kontextmenü haben soll

hasDefaultContextMenue Boolean

True, falls der Tree ein Default-Kontextmenü haben soll

contextMenueItems Array.<Object>

Array der Custom-KontextmenüItems

Properties
Name Type Description
label String

Label des KontextmenüItems

id String

Id des KontextmenüItems

iconClass String

CSS-Iconklasse des KontextmenüItems

Source:

createContextMenue(actions)

Baut das Kontextmenü zusammen. Basis ist this.contextMenueItems, ein Array von Objekten. Zentrales Modell ist this.contextMenueItemControls, ein assoziatives Array, das den IDs der contextMenueItems ein Zeiger auf das menuitem-Dijit zuweist. Da die ID auch die ID des DOM-Objektes ist kann über diesen Array direkt auf die Definition zugegriffen werden, insbesondere um die Art der Action festzustellen.

Parameters:
Name Type Description
actions Array.<String>

Array von action-Konstanten. Nur für diese wird ein KontextmenuItem erzeugt.

Source:

createContextMenue()

Baut das Kontextmenü zusammen.

Source:

dispose()

Gibt die Resourcen frei und löscht den tree. Kann von den abgeleiteten Klassen überschrieben werden, diese Implementierung muss aber als letzter Aufruf aufgerufen werden.

Source:

dispose()

Gibt die Resourcen frei und löscht den tree. Kann von den abgeleiteten Klassen überschrieben werden, diese Implementierung muss aber als letzter Aufruf aufgerufen werden.

Source:

getMenueItemLabel()

Gibt den Objektnamen zur Benennung des Menueitems des Kontextmenü zurück. Das ist der Label des Objektes, auf das mit der rechten Maustaste geklickt wurde. Muss von den abgeleiteten Klassen überschrieben werden.

Source:

getMenueItemLabel()

Gibt den Objektnamen zur Benennung des Menueitems des Kontextmenü zurück. Das ist der Label des Objektes, auf das mit der rechten Maustaste geklickt wurde. Muss von den abgeleiteten Klassen überschrieben werden.

Source:

onClickContextmenueWithEvent(evt, domId)

Kann von den abgeleiteten Klassen überschrieben werden um auf den Event zu reagieren. Diese Implementierg gibt nur einen Hinweis aus das sie nicht überschrieben wurde.

Parameters:
Name Type Description
evt Object

Das Event-Objekt

domId Integer

ID des Menüitems auf das geklickt wurde.

Source:

onClickContextmenueWithEvent(evt, domId)

Kann von den abgeleiteten Klassen überschrieben werden um auf den Event zu reagieren. Diese Implementierg gibt nur einen Hinweis aus das sie nicht überschrieben wurde.

Parameters:
Name Type Description
evt Object

Das Event-Objekt

domId Integer

ID des Menüitems auf das geklickt wurde.

Source:

onOpenContextMenueWithEvent(treeItem, treeNode)

Kann von den abgeleiteten Klassen überschrieben werden um auf den Event zu reagieren. Diese Implementierg gibt nur einen Hinweis aus das sie nicht überschrieben wurde.

Parameters:
Name Type Description
treeItem Object

Das treeItem, auf das geklickt wurde

treeNode Object

Der zum treeItem passende treeNode

Source:

onOpenContextMenueWithEvent(treeItem, treeNode)

Kann von den abgeleiteten Klassen überschrieben werden um auf den Event zu reagieren. Diese Implementierg gibt nur einen Hinweis aus das sie nicht überschrieben wurde.

Parameters:
Name Type Description
treeItem Object

Das treeItem, auf das geklickt wurde

treeNode Object

Der zum treeItem passende treeNode

Source:

setContextMenueItemActive()

Source:

setContextMenueItemActive()

Source:

setDefaultContextMenueItem(action, label, active)

Setzt Label und aktiv-Flag des ContextmenüItems mit der Action action

Parameters:
Name Type Description
action String

Die Action identifiziert ein MenuItem des Kontextmenüs. Welcher welche ist wird bei der Definition des this.contextMenueItems-Arrays festgelegt

label String

Optinaler Label. Wird der weggelassen wird für die bekannten Actions ein default-Label verwendet.

active Boolean

true, falls das MenuItem des Kontextmenüs anklickbar sein soll, sonst false

Source:

setProperties()

Kann von den abgeleiteten Klassen überschrieben werden um weitere Eigenschaften zu setzen. Diese Implementierg gibt nur einen Hinweis aus das sie nicht überschrieben wurde.

Source:

setProperties()

Kann von den abgeleiteten Klassen überschrieben werden um weitere Eigenschaften zu setzen. Diese Implementierg gibt nur einen Hinweis aus das sie nicht überschrieben wurde.

Source:

Dieses Modul definiert die Klasse Tree

Egenschaften:

  1. Suche
  2. Insert/Updat/Delete
  3. Kontextmenü
  4. Drag and Drop
Author:
  • sdw.systems
Source:
See:
Author:
  • sdw.systems
Source:
See:

Requires

Members

(private) canvas

Source:

(private) canvas

Source:

contextMenueItemControls

Properties:
Name Type Description
Assoziativer Array.<Object>

Array der MenuItems die das Kontextmenü bilden. Identifier ist die ID die bei der Definition des contextMenueItems-Arrays mitgegeben werden, i.A. wohl UUIDs

Source:

contextMenueItemControls

Properties:
Name Type Description
Array Array.<Object>

der MenuItems die das Kontextmenü bilden

Source:

(private) contextMenueItems

Source:

contextMenueItems

Properties:
Name Type Description
Array Array.<Object>

der MenuItem-Objekte mit default-label, id (i.a. UUID), action (eine Konstante aus SDWConst.menuActionX) und iconClass (eine Konstante aus this.iconClass)

Source:

(private) debug

Source:

(private) debug

Source:

(private) delegate

Source:

(private) delegate

Source:

hasContextMenue

Properties:
Name Type Description
hasContextMenue Boolean

falls true wurd ein Kontextmenü verwendet, sonst false

Source:

(private) hasContextMenue

Source:

hasDefaultContextMenue

Properties:
Name Type Description
hasDefaultContextMenue Boolean

falls true, wird das Kontextmenü mit allen MenüItems verwendet. Falls false, muss die abgeleitete Klasse createContextMenue explizit aufrufen und dabei einen Array von Actions übergeben. In dem Fall werden nur für dieses Actions Menuitems erzeugt

Source:

(private) hasDefaultContextMenue

Source:

(private) languagePack

Source:

(private) languagePack

Source:

(private) metadata

Source:

(private) metadata

Source:

moduleName

Properties:
Name Type Description
moduleName String

Name des Moduls aus lokaler Konstante

Source:

moduleName

Properties:
Name Type Description
moduleName String

Name des Moduls aus lokaler Konstante

Source:

Methods

_onClickContextmenue_(evt)

Interner Handler für den Klick-Event auf ein Kontextmenüitem.

Parameters:
Name Type Description
evt Object

Das Event-Objekt

Source:

_onClickContextmenue_(evt)

Interner Handler für den Klick-Event auf ein Kontextmenüitem. Holt die gewünschte Action aus this.contextMenueItems anhand der ID des angeklickten MenuItems raus und ruft damit zusätzlich zum Event parametrisiert this.onClickContextmenueWithEvent auf. this.onClickContextmenueWithEvent sollte von den abgeleiteten Klassen überschrieben werden um dann auch was sinnvolles zu machen.

Parameters:
Name Type Description
evt Object

Das Event-Objekt

Source:

_onOpenContextMenue_(evt)

Interner Handler für den Rechtsklick-Event der das Kontextmenü öffnet.

Parameters:
Name Type Description
evt Object

Das Event-Objekt

Source:

_onOpenContextMenue_(evt)

Interner Handler für den Rechtsklick-Event der das Kontextmenü öffnet. Disabled alle Optionen des Defaultcontextmenüs und ruft dann this.onOpenContextMenueWithEvent auf. this.onOpenContextMenueWithEvent sollte von den abgeleiteten Klassen überschrieben werden. Aufgabe der spezifischen Implementierungen ist es, aus dem Event die jeweiligen fachlichen Objekte rauszuholen auf die drauf geklickt worden ist um zu entscheiden, welche Kontextmenüitems aktiv sind und wie diese beschriftet werdne.

Parameters:
Name Type Description
evt Object

Das Event-Objekt

Source:

constructor(args)

Der Konstruktor stellt alle Argumente innerhalb der Klasse unter this.argument zur Verfügung.

Parameters:
Name Type Description
args Object

Argumentobjekt

Properties
Name Type Description
debug Boolean

Debugflag

metadata module:sdw/metadata

Zeiger auf das Metadatenobjekt des Applikationscontainers

languagePack module:sdw/languagePack

Zeiger auf das I18N Objekt des Applikationscontainers

delegate Object

Zeiger auf Das Objekt das die Callbacks dieser Klasse verarbeitet

canvas module:dijit/layout/ContentPane

Zeiger auf den ContentPane, in dem dieser tree dargestellt werden soll. Falls canvas null ist, muss sich der delegate um die Darstellung kümmern, ansonsten wird in der Methode createGUI() das content-Attribut des Canvas auf den den Tree gesetzt.

autoExpand Boolean

True, falls der Tree initial vollständig aufgeklappt sein soll

queryRootItemParams Object

Parameter der initialen Query des RootItems, default ist {"level":"0"}

childrenAttrs Array.<String>

Liste der Attribute, die als Kindobjekte interpretiert werden, deafult ist ["children"]

hasContextMenue Boolean

True, falls der Tree ein Kontextmenü haben soll

hasDefaultContextMenue Boolean

True, falls der Tree ein Default-Kontextmenü haben soll

contextMenueItems Array.<Object>

Array der Custom-KontextmenüItems

Properties
Name Type Description
label String

Label des KontextmenüItems

id String

Id des KontextmenüItems

iconClass String

CSS-Iconklasse des KontextmenüItems

Source:

constructor(args)

Der Konstruktor stellt alle Argumente innerhalb der Klasse unter this.argument zur Verfügung.

Parameters:
Name Type Description
args Object

Argumentobjekt

Properties
Name Type Description
debug Boolean

Debugflag

metadata module:sdw/metadata

Zeiger auf das Metadatenobjekt des Applikationscontainers

languagePack module:sdw/languagePack

Zeiger auf das I18N Objekt des Applikationscontainers

delegate Object

Zeiger auf Das Objekt das die Callbacks dieser Klasse verarbeitet

canvas module:dijit/layout/ContentPane

Zeiger auf den ContentPane, in dem dieser tree dargestellt werden soll. Falls canvas null ist, muss sich der delegate um die Darstellung kümmern, ansonsten wird in der Methode createGUI() das content-Attribut des Canvas auf den den Tree gesetzt.

autoExpand Boolean

True, falls der Tree initial vollständig aufgeklappt sein soll

queryRootItemParams Object

Parameter der initialen Query des RootItems, default ist {"level":"0"}

childrenAttrs Array.<String>

Liste der Attribute, die als Kindobjekte interpretiert werden, deafult ist ["children"]

hasContextMenue Boolean

True, falls der Tree ein Kontextmenü haben soll

hasDefaultContextMenue Boolean

True, falls der Tree ein Default-Kontextmenü haben soll

contextMenueItems Array.<Object>

Array der Custom-KontextmenüItems

Properties
Name Type Description
label String

Label des KontextmenüItems

id String

Id des KontextmenüItems

iconClass String

CSS-Iconklasse des KontextmenüItems

Source:

createContextMenue(actions)

Baut das Kontextmenü zusammen. Basis ist this.contextMenueItems, ein Array von Objekten. Zentrales Modell ist this.contextMenueItemControls, ein assoziatives Array, das den IDs der contextMenueItems ein Zeiger auf das menuitem-Dijit zuweist. Da die ID auch die ID des DOM-Objektes ist kann über diesen Array direkt auf die Definition zugegriffen werden, insbesondere um die Art der Action festzustellen.

Parameters:
Name Type Description
actions Array.<String>

Array von action-Konstanten. Nur für diese wird ein KontextmenuItem erzeugt.

Source:

createContextMenue()

Baut das Kontextmenü zusammen.

Source:

dispose()

Gibt die Resourcen frei und löscht den tree. Kann von den abgeleiteten Klassen überschrieben werden, diese Implementierung muss aber als letzter Aufruf aufgerufen werden.

Source:

dispose()

Gibt die Resourcen frei und löscht den tree. Kann von den abgeleiteten Klassen überschrieben werden, diese Implementierung muss aber als letzter Aufruf aufgerufen werden.

Source:

getMenueItemLabel()

Gibt den Objektnamen zur Benennung des Menueitems des Kontextmenü zurück. Das ist der Label des Objektes, auf das mit der rechten Maustaste geklickt wurde. Muss von den abgeleiteten Klassen überschrieben werden.

Source:

getMenueItemLabel()

Gibt den Objektnamen zur Benennung des Menueitems des Kontextmenü zurück. Das ist der Label des Objektes, auf das mit der rechten Maustaste geklickt wurde. Muss von den abgeleiteten Klassen überschrieben werden.

Source:

onClickContextmenueWithEvent(evt, domId)

Kann von den abgeleiteten Klassen überschrieben werden um auf den Event zu reagieren. Diese Implementierg gibt nur einen Hinweis aus das sie nicht überschrieben wurde.

Parameters:
Name Type Description
evt Object

Das Event-Objekt

domId Integer

ID des Menüitems auf das geklickt wurde.

Source:

onClickContextmenueWithEvent(evt, domId)

Kann von den abgeleiteten Klassen überschrieben werden um auf den Event zu reagieren. Diese Implementierg gibt nur einen Hinweis aus das sie nicht überschrieben wurde.

Parameters:
Name Type Description
evt Object

Das Event-Objekt

domId Integer

ID des Menüitems auf das geklickt wurde.

Source:

onOpenContextMenueWithEvent(treeItem, treeNode)

Kann von den abgeleiteten Klassen überschrieben werden um auf den Event zu reagieren. Diese Implementierg gibt nur einen Hinweis aus das sie nicht überschrieben wurde.

Parameters:
Name Type Description
treeItem Object

Das treeItem, auf das geklickt wurde

treeNode Object

Der zum treeItem passende treeNode

Source:

onOpenContextMenueWithEvent(treeItem, treeNode)

Kann von den abgeleiteten Klassen überschrieben werden um auf den Event zu reagieren. Diese Implementierg gibt nur einen Hinweis aus das sie nicht überschrieben wurde.

Parameters:
Name Type Description
treeItem Object

Das treeItem, auf das geklickt wurde

treeNode Object

Der zum treeItem passende treeNode

Source:

setContextMenueItemActive()

Source:

setContextMenueItemActive()

Source:

setDefaultContextMenueItem(action, label, active)

Setzt Label und aktiv-Flag des ContextmenüItems mit der Action action

Parameters:
Name Type Description
action String

Die Action identifiziert ein MenuItem des Kontextmenüs. Welcher welche ist wird bei der Definition des this.contextMenueItems-Arrays festgelegt

label String

Optinaler Label. Wird der weggelassen wird für die bekannten Actions ein default-Label verwendet.

active Boolean

true, falls das MenuItem des Kontextmenüs anklickbar sein soll, sonst false

Source:

setProperties()

Kann von den abgeleiteten Klassen überschrieben werden um weitere Eigenschaften zu setzen. Diese Implementierg gibt nur einen Hinweis aus das sie nicht überschrieben wurde.

Source:

setProperties()

Kann von den abgeleiteten Klassen überschrieben werden um weitere Eigenschaften zu setzen. Diese Implementierg gibt nur einen Hinweis aus das sie nicht überschrieben wurde.

Source: