agorum.registry

Die JavaScript-Bibliothek agorum.registry bietet Funktionen zur Registrierung und Verwaltung von Widgets und ihren zugehörigen Funktionen. Sie ermöglicht es Entwicklern, Widgets im System zu registrieren, sie mit einem eindeutigen Namen zu versehen und benutzerdefinierte Funktionen darauf auszuführen.

Die folgenden Hinweise erläutern das rekursive Verhalten der Widgets:

Widgets sind oft in einer baumartigen Struktur organisiert. Ein Container-Widget kann mehrere Kind-Widgets enthalten.
Bei der Registrierung mit register wird das Widget und seine Funktion in einer Art Register als Service eingetragen. Dadurch können Widgets später auf diese Funktion zugreifen.
Um auf verschachtelte Widgets zuzugreifen, wird eine Funktion wie widget.down('<name>') verwendet. Diese Funktion durchläuft die Widget-Hierarchie und sucht rekursiv nach einem Kind-Widget mit dem angegebenen Namen.
Die call-Funktion dient zum Aufruf eines registrierten Services für ein Widget. Wenn ein Widget eine Funktion nicht selbst besitzt, wird im übergeordneten Widget-Container nach der Funktion gesucht, bis das oberste Widget in der Hierarchie erreicht ist. Oberhalb der Widget-Hierarchie könnte als letzter Fallback ein Service in der MetaDB unter folgendem Pfad registriert sein:
```
MAIN_MODULE_MANAGEMENT/customers/agorum.registry/services/
```

Verwendung

Binden Sie die Bibliothek stets am Anfang eines Skripts ein:

let registry = require('/agorum/roi/customers/agorum.registry/js/registry');

Beispiel

let aguila = require('common/aguila');
let registry = require('/agorum/roi/customers/agorum.registry/js/registry');

let widget = aguila.create({
  type: 'agorum.vbox',
  width: 400,
  height: 400,
  items: [
    {
      type: 'agorum.vbox',
      items: [
        {
          type: 'agorum.vbox',
          items: [
            {
              name: 'inner',
              type: 'agorum.vbox',
              items: [],
            },
          ],
        },
      ],
    },
  ],
});

registry.register(widget, 'test', (a, b) => a + b);

console.log('result', registry.call(widget.down('inner'), 'test', 1, 'Hallo'));

widget;

In diesem Beispiel wird:

Ein neues Widget wird erstellt.
Verschachtelte Widgets werden innerhalb des Haupt-Widgets hinzugefügt. Das innerste Widget hat den Namen inner.
Die Methode registry.register wird verwendet, um das erstellte Widget im Registry-System mit einer test-Funktion zu verknüpfen, die eine einfache Addition durchführt.
Die Methode registry.call wird benutzt, um die test-Funktion für das Widget inner aufzurufen.
Das Ergebnis des Aufrufs wird exemplarisch auf der Konsole ausgegeben.

Dieses Beispiel zeigt, wie eine komplexe Widget-Struktur aufgebaut wird und dynamisch mit benutzerdefinierten Funktionen erweitert werden kann. Durch die Verwendung der registry-Funktionen kann auf spezifische Teile des Widgets zugegriffen werden, um maßgeschneiderte Aktionen auszuführen, etwa um die spezifische Geschäftslogik direkt innerhalb der Benutzeroberfläche zu integrieren. Die Verschachtelung von Widgets bietet zudem eine strukturierte Art und Weise, komplexe Oberflächen zu gestalten, wobei jedes Widget seine Funktionalität und sein Verhalten einer übergeordneten Regelstruktur anpassen kann.

Funktionen

register

Registriert ein Widget mit einem eindeutigen Namen und einer zugehörigen Funktion im Registry-System.

Syntax

registry.register(widget, service, fn);

Parameter

Parameter	Beschreibung	Pflicht	Standard
widget	Das zu registrierende Widget.	ja	–
service	Der eindeutige Name des Services, unter dem das Widget registriert wird.	ja
fn	Die Funktion, die mit dem Widget verknüpft wird.	ja

Beispiel

let registry = require('/agorum/roi/customers/agorum.registry/js/registry');

// Registers a widget with the name 'test' and an addition function
registry.register(widget, 'test', (a, b) => a + b);

Verwendung

Diese Funktion verwenden Sie, wenn Sie ein Widget mit einer eigenen Funktion im Registry-System erfassen und später darauf zugreifen möchten.

call

Ruft eine registrierte Funktion für ein bestimmtes Widget auf, übergibt die erforderlichen Parameter, und gibt das Ergebnis der Funktionsausführung zurück.

Syntax

registry.call(widget, service, ...params);

Parameter

Parameter	Beschreibung	Pflicht	Standard
widget	Das Widget, für das die Funktion aufgerufen wird.	ja	–
service	Der Name des registrierten Service.	ja
params	Eine beliebige Anzahl von Parametern, die an die Funktion übergeben werden.	nein

Beispiel

let result = registry.call(widget.down('inner'), 'test', 1, 'Hallo');
console.log('result', result); // Output: result 1Hallo

Rückgabewerte

Der Rückgabewert ist das Ergebnis der ausgeführten Funktion. Im oben gezeigten Beispiel würde dies eine String-Konkatenation sein, da '1' und 'Hallo' als Strings interpretiert werden.

Verwendung

Diese Funktion verwenden Sie, um eine zuvor registrierte Funktion für ein Widget auszuführen und das Ergebnis zu erhalten. Sie eignet sich besonders, wenn Logik für Widgets dynamisch beibehalten werden soll.

Exceptions

Zu dieser Funktion existieren keine spezifischen Exceptions. Stellen Sie sicher, dass die Funktion ordnungsgemäß registriert ist, bevor call aufgerufen wird, um unerwartetes Verhalten zu vermeiden.