Module: sdw/templates/application/splitPerspective

Dieses Modul definiert die Klasse SplitPerspective. Eine einfache Basisklasse um davon Perspektiven abzuleiten, die im OutlinePane, also im linken Bereich 2 getrennte Sichten in einer 1:n Manier brauchen. Im oberen Bereich kann sowas wie eine Suche implementiert werden, im unteren Bereich wird ein TabContainer zur Verfügung gestellt um z.B. unterschiedliche Suchergebnisse als separate Tabs darzustellen. Jeder Tab kann z.B. einen Tree beinhalten um die Suchergebnisse darzustellen.

Author:
  • sdw.systems
Source:
See:

Extends

Members

(private, inner) application

Source:

(inner) borderContainer

Properties:
Name Type Description
borderContainer dijit/layout/BorderContainer

Äußere Umhüllung aller GIU-Objekte im Outline-Pane der Perspektive

Source:

(inner) contentPaneBottom

Properties:
Name Type Description
contentPaneBottom dijit/layout/ContentPane

Pane für den unteren Bereich des Splitperspective

Source:

(inner) contentPaneTop

Properties:
Name Type Description
contentPaneTop dijit/layout/ContentPane

Pane für den oberen Bereich des Splitperspective

Source:

(inner) datasets

Properties:
Name Type Description
datasets Array.<Object>

Array von Datasets um das GUI des oberen Panes zu bauen. Kann leer sein

Source:

(private, inner) debug

Source:

(private, inner) deferred

Source:

(inner) heightTopPane

Properties:
Name Type Description
heightTopPane Number

Höhe des oberen Panes in Pixeln, kann von den abgeleiteten Klassen überschrieben werden

Source:

(private, inner) languagePack

Source:

(private, inner) metadata

Source:

(inner) moduleName

Properties:
Name Type Description
moduleName String

Name des Moduls aus lokaler Konstante

Source:

(inner) openTab

Properties:
Name Type Description
openTab dijit/layout/ContentPane

Zeiger auf den aktuell sichtbaren Tab des Tabcontainers im contentPaneBottom

Source:

(private, inner) outlinePane

Source:

(inner) tabContainer

Properties:
Name Type Description
tabContainer dijit/layout/TabContainer

Tabcontainer im unteren Pane, also im contentPaneBottom

Source:

(inner) tabs

Properties:
Name Type Description
tabs Array.<Object>

Metadaten für die Tabs im Tabcontainer im unteren Pane, also im contentPaneBottom. Initial ist der Array leer, es gibt also keine Tabe im Tabcontainer

Source:

(inner) view

Properties:
Name Type Description
view Object

Offener View aus der ViewTabPane-Darstellung

Source:

Methods

(inner) addOrSelectTab()

Prüft, ob es den tab mit dem angegebenen Namen bereits gibt. Wenn ja, wird dieser in den Vordergrund geholt, wenn nicht wird er neu angelegt. Neu angelegte Tabs sind immer im Vordergrund.

Source:

(inner) addTreeTab(treeClass, name, label, createOnce, closable, onPaneIsReady, opcodePopulatePane, oidPopulatePane, additionalCommandArgs)

Fügt einen neuen Tab in den Tabcontainer ein. Der Tab enthält einen Tree, dessen Modulname mit übergeben wird. Erzeugt ein neuen Objekt der Klasse sdw/templates/widgets/treeControllerTab. Dieses wird in das Metadaten-Objekt this.tabs eingehängt. Das treeTab-Objekt hat einen Zeiger auf ein contentPane-Objekt, welches sein Canvas ist und den Baum beinhaltet. Dieses ContentPane-Objekt wird in den TabContainer eingehängt.

Parameters:
Name Type Description
treeClass String

Der Modulname der Treeklasse, wird von dojo.require als Classloader geladen

name String

Der interne Name des Tabs, also die ID anhand der Tab identifiziert werden kann

label String

Der Label des Tabs, also der im Reiter angezeigte Name

createOnce Boolean

True, falls der Tab nur einmal gerendert wird, false falls der Tab bei jedem inDenVordergrundHolen neu gerendert wird um Änderungen zu reflektieren

closable Boolean

True, falls der Tab geschlossen werden kann, false falls nicht

onPaneIsReady Callback

Callback-Methode die aufgerufen wird, wenn der neue Pane fertig gerendert und eingehöngt ist

opcodePopulatePane OPCODE

Opcode mit dem der Inhalt des Trees von der API angefordert wird

oidPopulatePane OID

OID mit der der Inhalt des Trees von der API angefordert wird

additionalCommandArgs Object

Zusätzliche Argument für das Command-Objekt für das Holen des Inhalts des Trees von der API

Source:

(inner) closeTab()

Schließt den Tab mit dem angegebenen Namen und löscht auch die Metadaten aus dem tabs-Array

Source:

(inner) constructor()

Constructor Initialisiert datasets, ruft this.createDatasets() auf, initialisiert tabs und ruft danach this.createGUI() und zuletzt constructorHasFinished auf falls der Callback übergeben wurde.

Source:

(inner) createBottomPane()

Baut den BottomPane als TabContainer.

Source:

(inner) createDatasetGUI()

Wird von createGUI aufgerufen falls das dataset-Array nicht leer ist und renderd das GUI durch Darstellung der im dataset beschriebenen GUI-Objekte

Source:

(inner) createDatasets()

Standardimplementierung, macht gar nichts. Kann von den abgeleiteten Klassen überschrieben werden um das dataset-Objekt zu füllen. Wird vom Konstruktor aufgerufen.

Source:

(inner) createGUI()

Baut das GUI. Zuerst der umgebende BorderContainer, dann den contentPaneTop und den contentPaneBottom. Beide Panes rufen Methoden auf um ihrem Content zu setzen, this.createTopPane und this.createBottomPane. Der BorderContainer wird als Inhalt von this.outlinePane gesetzt, siehe Basisklasse.

Source:

(inner) createMarkup()

Methodenstub, kann von den abgeleiteten Klassen überschrieben werden. Diese Implementierung gibt nur eine Warnung aus dass sie nicht überschrieben wurde.

Source:

(inner) createStandardGUI()

Wird von createGUI aufgerufen falls das dataset-Array leer ist und ruft wiederum this.createMarkup auf. Diese Methode kann von den abgeleiteten Klassen überschrieben werden um Markup bereitzustellen das das GUI repräsentiert.

Source:

(inner) createTopPane()

Baut den TopPane entweder durch Aufurf von this.createDatasetGUI falls der Dataset-Array nicht leer ist. Dazu kann die abgeleitet Klasse die Methode createDatasets überschreiben. Falls this.datasets leer ist wird this.createStandardGUI aufgerufen.

Source:

(inner) getTab(name) → {module:sdw/templates/widgets/treeControllerTab}

Gibt den Tab mit dem Namen (der Id) name zurück.

Parameters:
Name Type Description
name String

Der Name des Tabs, der zurückgegeben werden soll

Source:
Returns:

Das tab-Metadatenobjekt

Type
module:sdw/templates/widgets/treeControllerTab

(inner) hasTab(name) → {Boolean}

Prüft, ob der TabContainer im BottomPane einen Tab mit dem Namen (der Id) name hat.

Parameters:
Name Type Description
name String

Der Name des Tabs, der geprüft werden soll

Source:
Returns:

true, falls der Tabcontainer einen Tab dieses Namens hat, sonst false.

Type
Boolean

(inner) onChangeTab(oldPane, newPane)

Diese Methode kann in den abgeleiteten Klassen überschrieben werden um auf das Ereignis des Pane- und somit des TabWechsels zu reagieren. Die Argumente sind der alte und der neue Pane Pure virtual, gibt lediglich eine Warnung aus falls diese Methode von der abgeleiteten Klasse nicht korrekt überschrieben wurde

Parameters:
Name Type Description
oldPane module:dijit/layout/ContentPane

Zeiger auf den alten Pane mit der alten Perspektive

newPane module:dijit/layout/ContentPane

Zeiger auf den neuen Pane mit der neuen Perspektive

Source:

(inner) onRenderingComplete()

Methodenstub, kann von den abgeleiteten Klassen überschrieben werden. Diese Implementierung gibt nur eine Warnung aus dass sie nicht überschrieben wurde.

Source:

(inner) removeApplicationInactive()

Löscht alle Resourcen einschließlich aller Tabs (lLassen und GUI)

Source:

(inner) selectTab()

Holt den Tab mit dem angegebenen Namen in den Vordergrund

Source:

(inner) selectTreeItems(klasse, query)

Highlighted alle TreeItems in allen TreeTabs.

Parameters:
Name Type Description
klasse String

Ausprägung des Klasse-Attributes der zu selektierenden treeItems

query Object

Selektion, query für die Suche auf dem treeStore

Source:

(inner) setProperties()

Methodenstub, kann von den abgeleiteten Klassen überschrieben werden. Diese Implementierung gibt nur eine Warnung aus dass sie nicht überschrieben wurde.

Source:

(inner) updateTreeNodeFlag()

Deprecated. Setzt das flag-Attribut des Treenodes und erzeugt so ein anderes Icon. Umstellen auf Klassen

Source: