Zusammenfassung

• Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Inhalt

...	...	@@ -22,42 +22,42 @@
22	22
23	23	Die Schnittstelle bietet folgende Methodesignaturen:
24	24
25		-* **//public Map<String, IBundleConfigParam> getConfigProperties(IPluginResourceHelper resHelper, Locale currentLocale)//**
26		-
27		-=== Methode: //getConfigProperties// ===
28		-
29		-Dient zur Konfiguration von Eigenschaftswerten, die allen Java-Klassen innerhalb des Plugin-Bundles zur Verfügung stehen sollen.
30		-
31		-==== Übergabewerte: ====
32		-
33		-
34		-; IPluginResourceHelper
35		-: Objekte zum Zugriff auf die im Plugin-Bundle enthaltenen Datei-Ressourcen.
36		-; Locale
37		-: Das für den aktuell angemeldeten Nutzer festgelegte //Locale//-Objekt (enthält Informationen zur Sprache und Region).
	25	+{{panel title="{{code language='java'~}~}Map<String, IBundleConfigParam> getConfigProperties(IPluginResourceHelper resHelper, Locale currentLocale){{/code~}~}" triggerable="true" fullwidth="true"}}
	26	+(((
	27	+Die Methode //getConfigProperties// dient zur Konfiguration von Eigenschaftswerten, die allen Java-Klassen innerhalb des Plugin-Bundles zur Verfügung stehen sollen.
	28	+)))
	29	+**Übergabewerte:**
	30	+(((
	31	+* **IPluginResourceHelper**
	32	+** Objekte zum Zugriff auf die im Plugin-Bundle enthaltenen Datei-Ressourcen.
	33	+* **Locale**
	34	+** Das für den aktuell angemeldeten Nutzer festgelegte //Locale//-Objekt (enthält Informationen zur Sprache und Region).
38	38	Dieses kann zum Ermitteln von sprachabhängigen Texten verwendet werden.
	36	+)))
39	39
40		-==== Rückgabewerte: ====
41		-
42		-
	38	+**Rückgabewerte:**
	39	+(((
43	43	Die Methode muss ein Objekt vom Typ //java.util.Map// mit Value-Objekten vom Typ //IBundleConfigParam// zurückliefern.
44	44	Es existieren zwei mögliche Implementierung von //IBundleConfigParam//:
	42	+)))
45	45
46		-; BundleConfigGroupItem
47		-: Dieses Element kann zur Strukturierung der Listendarstellung in der Oberfläche von {{formcycle case="dat"/}} verwendet werden.
48		-; BundleConfigParam
49		-: Dient zur Definition eines Bundle-Properties. Ein Objekt definiert die folgenden Eigenschaften:
50		-: //name//
51		-:: Der Name oder Zugriffsschlüssel einer Property.
52		-: //description//
53		-:: Beschreibung zu einer Property. Wird per //Mouseover// über den //Property//-Namen in der Oberfläche eingeblendet. Kann verwendet werden, um dem Nutzer des Plugins nähere Information zur Verwendung oder möglicher Wertebereiche des Parameters anzuzeigen.
54		-: //mandatory//
55		-:: Legt fest, ob der Parameter in der Oberfläche als Pflichtparameter dargestellt wird und ein Validierung auf Vorhandensein eines Wertes beim Abspeichern durchgeführt wird.
56		-: //crypticValue//
57		-:: Legt fest, ob der Wert der Property wie bei einem Passwordfeld maskiert werden soll. Standardwert ist {{code}}false{{/code}}.
58		-: //defaultValue//
59		-:: Ermöglicht die Festlegung eines Defaultwertes durch den Entwickler. Standardwert ist {{code}}null{{/code}}.
	44	+* **BundleConfigGroupItem**
	45	+** Dieses Element kann zur Strukturierung der Listendarstellung in der Oberfläche von {{formcycle case="dat"/}} verwendet werden.
	46	+* **BundleConfigParam**
	47	+** Dient zur Definition eines Bundle-Properties. Ein Objekt definiert die folgenden Eigenschaften:
	48	+**: //name//
	49	+**:: Der Name oder Zugriffsschlüssel einer Property.
	50	+**: //description//
	51	+**:: Beschreibung zu einer Property. Wird per //Mouseover// über den //Property//-Namen in der Oberfläche eingeblendet. Kann verwendet werden, um dem Nutzer des Plugins nähere Information zur Verwendung oder möglicher Wertebereiche des Parameters anzuzeigen.
	52	+**: //mandatory//
	53	+**:: Legt fest, ob der Parameter in der Oberfläche als Pflichtparameter dargestellt wird und ein Validierung auf Vorhandensein eines Wertes beim Abspeichern durchgeführt wird.
	54	+**: //crypticValue//
	55	+**:: Legt fest, ob der Wert der Property wie bei einem Passwordfeld maskiert werden soll. Standardwert ist {{code}}false{{/code}}.
	56	+**: //defaultValue//
	57	+**:: Ermöglicht die Festlegung eines Defaultwertes durch den Entwickler. Standardwert ist {{code}}null{{/code}}.
60	60
	59	+{{/panel}}
	60	+
61	61	== Implementierungsbeispiel ==
62	62
63	63	Das nachfolgende Codebeispiel zeigt eine mögliche Implementierung: