Business App Leitfaden für Anpassungen

13.1. Klassen

WidgetBase

Interne Basis von das Widget System. Stellt basis, überschreibare Funktionalität für die Entwicklung von Widgets. Überschreibare Methoden für Widget Entwicklern:

  • IsValid für die Validierung des Widgets in der Konfiguration,
  • SkipRender für den Fall, dass unter Umstände das Widget nicht gerendert sein soll,
  • GetStyleString für die Inline Style eines Widgets,
  • GetCssClass um eine Css Klasse auf höchstes Niveau in der Widgets HTML zu setzen,
  • GetTSClassName um eine angepasste .ts Klasse für das Widget zu setzen,
    • GetControlName um den im Designer angezeigten Namen des Widgets zu setzen,
    • GetWidgetTitle um den in der Seite angezeigten Titel des Widgets zu setzen,
    • GetWidgetTitleFallback um den Fallback des in der Seite angezeigten Titels des Widgets zu setzen,
    • GetWidgetTitleOrFallback ruft GetWidgetTitle aber liefert ein Fallback Wert (GetWidgetTitleFallback), wenn GetWidgetTitle leer oder null zurück liefert,
  • GetUISetting um Benutzerspezifische UI Widget Einstellungen zu lesen,
  • SetUISetting um Benutzerspezifische UI Widget Einstellungen zu speichern,
  • GetUISettingValueForUserOrConfig um Benutzerspezifische UI Widget Einstellungen zu lesen oder aus der Konfiguration, wenn es keine Benutzerspezifisches Wert gibt,
  • GetControllerParameters um spezifischen Parameters für den Controller zu setzen,
  • CanBeMultiInstance um zu setzen ob oder wann kann das Widget multiinstanz sein. Wenn diese Funktion true zurückliefert kann unter Umständen das Widget als multiinstanz konfiguriert.

Widget Ausrichtungen

WidgetBase beinhaltet auch die Definitionen zur vertikalen und horizontalen Ausrichtung. Werden die beiden Feldern konfiguriert, erhält das Widget entsprechende CSS-Klassen. In der Regel sind diese aber nicht ausreichend. Die Ausrichtung des eigenen Inhaltes muss man entsprechend den Einstellungen mithilfe eigener CSS-Klassen selbst sicherstellen.

LayoutWidget

LayoutWidget erbt von WidgetBase und wird für Widgets, die als Container anderen Widgets gedacht sind und eine Struktur in der Seite definieren. Zum Beispiel die Zeile und Spalten Widgets.

LayoutWidget bereitet die Funktionalität für das SkipRender von Widgets, indem alle die unterliegenden Widgets überprüft werden.

Widget

Widget erbt von WidgetBase und wird die Basis für alle die Widgets, die für die Anzeige gedacht sind. Zum Beispiel ein NavigationMenuWidget oder ein GoogleMapsWidget.

DataWidget

Widgets können Daten von der Seite oder anderen Widgets konsumieren. Dafür soll das Widget von der Klasse DataWidget erben und mittels WidgetParameterDefinition definieren, welche Parameter Typen das Widget lesen kann. Mehr dazu im Kapitel Parameter und im Kapitel Parameter konsumieren.

OrmDataWidget

Erbt von DataWidget. Widgets, die OrmWidgetParameter konsumieren, erben von dieser Klasse.