Summary

• Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-$services.localization.render("PT.PluginEntwicklung.PluginBundleProperties")
	1	+Plugin bundle properties

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.ximaadmin
	1	+XWiki.gru

Content

...	...	@@ -18,7 +18,7 @@
18	18	By implementing the interface {{jpath path="de.xima.fc.plugin.config.IBundleProperties"/}}, all available options for the plugin will be visible when configuring the plugin in {{formcycle/}}.
19	19	{{/figure}}
20	20
21		-The interface {{jpath path="de.xima.fc.plugin.config.IBundleProperties"/}} contains the method {{code}}getConfigProperties(){{/code}} that can be used to define the available options for the plugins. This method must return a {{code}}Map{{/code}} with values of type {{jpath path="de.xima.fc.plugin.config.IBundleConfigParam"/}}.
	21	+The interface {{jpath path="de.xima.fc.plugin.config.IBundleProperties"/}} contains the method {{code language="none"}}getConfigProperties(){{/code}} that can be used to define the available options for the plugins. This method must return a {{code language="none"}}Map{{/code}} with values of type {{jpath path="de.xima.fc.plugin.config.IBundleConfigParam"/}}.
22	22
23	23	{{formcycle/}} provides two implementing classes of the {{jpath path="de.xima.fc.plugin.config.IBundleConfigParam"/}} interface you can use:
24	24
...	...	@@ -27,8 +27,8 @@
27	27	** {{litem title="name"}}The name used as the key for the property.{{/litem}}
28	28	** {{litem title="description"}}Description for the property. It will be shown when hovering the mouse over the name of the property. Can be used to provide further details on the paramters, or inform the user about allowed values.{{/litem}}
29	29	** {{litem title="isMandatory"}}Whether this property is required and a value must be set.{{/litem}}
30		-** {{litem title="crypticValue"}}Whether the value of the property should be masked, similar to password fields. Defaults to {{code}}false{{/code}}.{{/litem}}
31		-** {{litem title="defaultValue"}}A default value for the property when no value has been specified. Defaults to {{code}}null{{/code}}.{{/litem}}
	30	+** {{litem title="crypticValue"}}Whether the value of the property should be masked, similar to password fields. Defaults to {{code language="none"}}false{{/code}}.{{/litem}}
	31	+** {{litem title="defaultValue"}}A default value for the property when no value has been specified. Defaults to {{code language="none"}}null{{/code}}.{{/litem}}
32	32
33	33	{{panel title="Example for an implementation of IBundleProperties" initial="hidden" triggerable="true"}}
34	34
...	...	@@ -51,13 +51,13 @@
51	51
52	52	== Retrieving bundle properties ==
53	53
54		-By extending the abstract class {{jpath path="de.xima.fc.plugin.abstracts.AFCPlugin"/}}, you can access the values that have been set for the bundle properties. The method {{code}}getProperties(){{/code}} return an object of type //java.util.Properties// that allows you to access the properties.
	54	+By extending the abstract class {{jpath path="de.xima.fc.plugin.abstracts.AFCPlugin"/}}, you can access the values that have been set for the bundle properties. The method {{code language="none"}}getProperties(){{/code}} return an object of type //java.util.Properties// that allows you to access the properties.
55	55
56	56	== Example for using bundle properties ==
57	57
58		-An example taken from the //execute// method of a plugin of type [[IPluginFormPreRender>>doc:IPluginFormPreRender]].
	58	+An example taken from the //execute// method of a plugin of type [[IPluginFormPreRender>>doc:Formcycle.PluginDevelopment.Types.IPluginFormPreRender]].
59	59
60		-Plugins of this type will be executed when opening a form belonging to the same client for which the plugin has been uploaded. To restrict the plugin to certain forms, you can add a bundle property {{code}}activate.form.alias{{/code}} that contains a list of comma separated names of forms the plugin should be run for.
	60	+Plugins of this type will be executed when opening a form belonging to the same client for which the plugin has been uploaded. To restrict the plugin to certain forms, you can add a bundle property {{code language="none"}}activate.form.alias{{/code}} that contains a list of comma separated names of forms the plugin should be run for.
61	61
62	62	The plugin will exit when called for a form not part of that list.
63	63