Typescript - Gedys CXM: Leitfaden für Anpassungen

Widget.ts

Ist die Basis für die Widget Funktionalitäten im Client und bietet die Möglichkeit an, manche davon anzupassen.

SetWidgetState

Widgets haben einen Status, der „NotLoaded“, „UnLoaded“, „Loading“, „Loaded“, „Blocked” oder „Error” sein kann. Was für einen Status ein Widget hat, hängt von dem Laden des Widgets ab und wird automatisch gesetzt. Die Funktion SetWidgetState kann aufgerufen werden, um unter Umstände den Status vom Widget zu ändern. Zum Beispiel bei Fehlern.

TriggerParameterChangedEvent

Wenn das Widget einen bestimmten Parameter bereitstellt, triggert diese Funktion das UI Event WidgetParameterUpdated.

OnParameterExternallyChanged

Wenn ein Widget den konsumierten Parameter ändert, muss diese Methode aus dem bereitstellenden Widget aufgerufen werden. Beispiel: Maske ändert den Datensatz und ruft diese Funktion auf. Um einem Listen Widget zu informieren. Das Listen Widget reagiert darauf und triggert das UI Event, damit andere konsumierende Widgets auch auf die Änderung reagieren können.

ReadSourceParameterJsonString

Wenn das Widget einen Parameter braucht, liefert diese Funktion den Parameter in einer JSON formatierte String aus der Quelle zurück.

GetAllProvidedParameterJsonString

Wenn das Widget einen Parameter mit Namen bereitstellt, wird diese Funktion eine Liste, die den Parameter beinhaltet, in einer JSON formatierte String aus der Quelle zurückliefern. Wenn das Widget multiinstanz ist, beinhaltet die Liste die Parameter von alle Instanzen des Widgets.

GetProvidedParameter

Wenn das Widget einen Parameter von Typ T bereitstellt, wird diese Funktion das entsprechende Objekt zurückliefern.

SetProvidedParameter

Wenn das Widget einen Parameter von Typ T bereitstellt, wird diese Funktion das als Funktionparameter gegebene Objekt als Parameter vom Widget setzen und ein entsprechende UI Event triggern, damit andere Widgets sich aktualisieren können, um die neuen Daten zu nutzen.

OnParameterChanged

Funktion die aufgerufen wird, wenn das Parameter, das das Widget nutzt, aktualisiert worden ist.

AddWidgetAction

Fügt eine Aktion in der Widget UI hinzu. Die Aktionen werden oben rechts angezeigt, wenn ein Benutzer den Maus über das Widget zieht. Basis Aktionen und überschreibare Funktionalität sind:

Refresh

Läd das Widget neu.

Collapse

Verstecken oder anzeigen des Widgets. Bei einem Widget mit verstecktem Inhalt, wird nur der Titel und die Aktionen angezeigt. Für diese Aktion sind folgende Funktionen überschreibar: BeforeCollapsing / BeforeExpanding, um Code direkt vor der Collapse/Expand Aktion auszuführen, beziehungsweise false zurück zu liefern, um die Aktion abzubrechen; und OnCollapsed / OnExpanded, um Code direkt nach der Collapse/Expand Aktion auszuführen.

Maximize

Zeigt das Widget vergrößert (volle Seite) an, oder in der originalen Große. Für diese Aktion sind folgende Funktionen überschreibar: BeforeMaximizing / BeforeSizeRestoring, um Code direkt vor der Maximize/Restore Aktion auszuführen, beziehungsweise false zurückliefern, um die Aktion abzubrechen; und OnMaximized / OnSizeRestored, um Code direkt nach der Maximize/Restore Aktion auszuführen.

Remove

Schliesst das Widget in der Seite und verschiebt es in den Katalog. Diese Aktion wird nur angezeigt, wenn das Widget entfernt werden kann. Für diese Aktion sind folgende Funktionen überschreibar: BeforeRemoving, um Code direkt vor dem Entfernen auszuführen, beziehungsweise false zurückliefern, um die Aktion abzubrechen; und OnRemoved, um Code direkt nach der Entfernen Aktion auszuführen.

WidgetSettingsDialog

Öffnet einen Dialog in welchem der Benutzer für sich individuelle Einstellungen zur Anzeige des Widgets festlegen kann.

OnWidgetSettingsChanged, um Code nach dem Verändern von WidgetSettings auszuführen
OnWidgetSettingsDialogClosed, um Code nach dem Schließen des Dialogs auszuführen

AttachDragAndDropEvents

Werden Widgets per Drag and Drop bewegt, wird diese Event ausgeführt.

Unload

Wenn ein Widget entfernt wird oder der Tab geschlossen wird, wird das Widget auch entladen. Diese Methode bekommt einen Parameter „tabClosing“, womit man erkennen kann in welcher Situation das Entladen stattfinden. Diese Methode erlaubt Widgets zu definieren, was beim Entladen passiert. Hier gehören zum Beispiel Status Variabelen zurückzusetzen oder sich von UI Events zu lösen.

DefaultFocus

Handelt das Setzen des Focus im Widget, wenn das Widget den Vorgabe-Focus in der Seite erhält.

GetUISetting

Liest Benutzerspezifische UI Widget Einstellungen.

SetUISetting

Speichert Benutzerspezifische UI Widget Einstellungen.

Init

Bietet die Möglichkeit an, Code auszuführen als das Widget im Browser initialisiert wird. In diesem Zeitpunkt könnte der Inhalt des Widgets noch nicht gerendert sein.

OnContentLoaded

Bietet die Möglichkeit an, Code auszuführen als der Inhalt des Widgets im Browser geladen ist.

OnParameterSourceRemoved

Bietet die Möglichkeit an, Code auszuführen als das Widget, von dem den Parameter konsumiert wird, entfernt ist.

OnWidgetPreviewClick

Funktion, die bei einem einfachen Klick auf eine Widget-Vorschau ausgeführt wird.

OnWidgetPreviewDblClick

Funktion, die bei einem Doppelklick auf eine Widget-Vorschau ausgeführt wird.

OnWidgetTitleClick

Funktion, die bei einem einfachen Klick auf den Widget-Titel ausgeführt wird.

OnWidgetTitleDblClick