Thema dieser Dokumentation / Das FirstSpirit 5 Modul- / Komponenten-Modell / Der Komponenten-<components>-Deskriptor-Teil / Komponenten-Deskriptoren und spezielle Eigenschaften / Gadget-Spezifikation

Gadget-Spezifikation

Eine SwingGadget-Implementierung stellt eine Eingabekomponente (SwingGadget) inklusive GOM-Implementierung und Factory-Klassen zur Verfügung, über die es möglich ist, den SiteArchitect um eigene Eingabemöglichkeiten zu erweitern. SwingGadgets werden als Public-Komponente im Deskriptor eingebunden, erhalten über die Gadget-Spezifikation (siehe <class>) jedoch erweiterte Konfigurationsmöglichkeiten:

<public>
<name>CUSTOM_TEXTAREA</name>
<displayname>My Texteditor</displayname>
<description>FirstSpirit Swing Gadget Editor .</description>
<class>de.espirit.firstspirit.module.GadgetSpecification</class>
<configuration>
<gom>
de.espirit.firstspirit.opt.examples.gadgettextarea.GomCustomTextarea
</gom>
<factory>
de.espirit.firstspirit.opt.examples.gadgettextarea
.CustomTextareaSwingGadgetFactory
</factory>
<value>
de.espirit.firstspirit.opt.examples.gadgettextarea.TextareaValueFactory
</value>
<scope data="yes" content="yes" link="yes"/>
</configuration>
<resources>
<resource>lib/gadget-textarea-example-@VERSION@.jar</resource>
</resources>
</public>

Eigenschaft

Beschreibung

<name>
Mandatory

Definiert den Namen, über den die Komponente in FirstSpirit als Public-Komponente erreichbar ist.

<displayname>

Optionaler Anzeigename für die Komponente. Ist kein Anzeigename definiert, wird in allen FirstSpirit-Oberflächen der technische Name (<name>) der Komponente angezeigt.

<class>
Mandatory

Klasse, die für die Konfiguration des SwingGadgets verantwortlich ist; diese ist für Gadgets immer de.espirit.firstspirit.module.GadgetSpecification. Die Angaben unter <configuration> bilden die Grundlage für die Konfiguration dieser Klasse.

<configuration>
Mandatory

Die Struktur bzw. die Darstellung eines SwingGadgets wird bestimmt durch die zugehörige GOM-Implementierung (XML-Beschreibung) und die zugehörigen Factory-Klassen (instanziert eine neue grafische Repräsentation des Editors). Diese werden innerhalb der <configuration>-Tags angegeben:

  • <gom></gom> Klasse, die für die XML-Beschreibung der Eingabekomponente benötigt wird.
  • <factory></factory> Factory-Klasse, die für die Instanzierung einer neuen grafischen Darstellung des SwingGadgets benötigt wird.
  • Ist der Editor zusätzlich ein ValueHolder muss außerdem in <value></value> die Factory-Klasse angegeben werden, die für die Behandlung der Werte eines SwingGadgets verantwortlich ist.


Innerhalb der <configuration>-Tags kann außerdem der Gültigkeitsbereich der Eingabekomponente innerhalb des FirstSpirit SiteArchitects definiert werden.

  • <scope/> Über die Attribute data, content, link und unresticted kann definiert werden, in welchem Vorlagenbereich eine Eingabekomponente (SwingGadget) verwendet werden darf:
    • data="yes": Eingabekomponente kann innerhalb einer Seiten- und/oder Absatzvorlage verwendet werden.
    • content="yes": Eingabekomponente kann innerhalb einer Tabellenvorlage verwendet werden.
    • link="yes": Eingabekomponente kann innerhalb einer Verweisvorlage verwendet werden.
    • unrestricted="yes": Es gibt keine Einschränkungen bei der Verwendung der Eingabekomponente.

<resource>
Mandatory

Die SwingGadget-eigenen Ressourcen. Jede SwingGadget-Komponente muss zwingend seine “eigenen” Klassen als Ressourcen in Form eines JARs enthalten.

  • version Aktuelle Version (optional)
  • minVersion Minimal kompatible Version (optional)
  • maxVersion Maximal kompatible Version (optional)

  

© 2005 - 2021 e-Spirit AG | Alle Rechte vorbehalten. | FirstSpirit 2021-10 | Datenschutz | Impressum | Kontakt