Package de.xima.fc.plugin.models.config

Class PluginConfigGroupItem

java.lang.Object

de.xima.fc.plugin.models.config.AConfigParam

de.xima.fc.plugin.models.config.PluginConfigGroupItem

All Implemented Interfaces:

IBasicConfigParam, IPluginConfigParam, Serializable

public class PluginConfigGroupItem
extends AConfigParam
implements IPluginConfigParam, Serializable

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface de.xima.fc.plugin.config.IPluginConfigParam

IPluginConfigParam.EPluginParamBehavior

Field Summary

Fields inherited from class de.xima.fc.plugin.models.config.AConfigParam

crypticValue, defaultValue, dependentMandatoryParamNames, description, mandatory, name, nameEditable

Constructor Summary

Constructors

Constructor	Description
PluginConfigGroupItem(String groupingName)
PluginConfigGroupItem(String groupingName, String description)

Method Summary

Modifier and Type	Method	Description
IPluginConfigParam.EPluginParamBehavior	getBehavior()	Liefert das Aussage, wie der Parameter innerhalb der Pluginlogik interprertiert wird, also ob es sich um einen Input- oder Output-Parameter handelt.
boolean	isGroupItem()	Legt fest, ob der Parameter als Gruppierungüberschrift dient.

Methods inherited from class de.xima.fc.plugin.models.config.AConfigParam

addDependentMandatoryParamName, equals, getDefaultValue, getDependentMandatoryParamNames, getDescription, getName, hashCode, isCrypticValue, isMandatory, isNameEditable, setCrypticValue, setDefaultValue, setDependentMandatoryParamNames, setDescription, setMandatory, setName, setNameEditable, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.xima.fc.plugin.config.IBasicConfigParam

getDefaultValue, getDependentMandatoryParamNames, getDescription, getDisplayName, getName, isCrypticValue, isMandatory, isNameEditable

Constructor Details

PluginConfigGroupItem

public PluginConfigGroupItem(String groupingName)

PluginConfigGroupItem

public PluginConfigGroupItem(String groupingName,
 String description)

Method Details

getBehavior

public IPluginConfigParam.EPluginParamBehavior getBehavior()

Description copied from interface: IPluginConfigParam

Liefert das Aussage, wie der Parameter innerhalb der Pluginlogik interprertiert wird, also ob es sich um einen Input- oder Output-Parameter handelt.

Specified by:

getBehavior in interface IPluginConfigParam

Returns:

Enum vom Typ IPluginConfigParam.EPluginParamBehavior

isGroupItem

public boolean isGroupItem()

Description copied from interface: IBasicConfigParam

Legt fest, ob der Parameter als Gruppierungüberschrift dient. Dann hat er folgende Eigenschaften:

• - er ist nicht editierbar
• - er kann nicht gelöscht werden
• - er wird nicht validiert

Specified by:

isGroupItem in interface IBasicConfigParam

Overrides:

isGroupItem in class AConfigParam

Returns:

true wenn es sich bei dem zugrundeliegenden Element um ein Strukturierungselement handelt, sonst false