Class A_CmsPreference
- java.lang.Object
-
- org.opencms.configuration.preferences.A_CmsPreference
-
- All Implemented Interfaces:
I_CmsPreference
- Direct Known Subclasses:
CmsBuiltinPreference
,CmsEditorPreference
,CmsStartGallleryPreference
,CmsUserDefinedPreference
public abstract class A_CmsPreference extends java.lang.Object implements I_CmsPreference
Abstract superclass for preferences.
-
-
Constructor Summary
Constructors Constructor Description A_CmsPreference()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description org.dom4j.Element
createConfigurationItem()
Creates the configuration for this preference.protected abstract CmsXmlContentProperty
getPropertyDefinition()
Gets the user-independent property configuration.CmsXmlContentProperty
getPropertyDefinition(CmsObject cms)
Gets the metadata describing how the setting should be edited.boolean
isDisabled(CmsObject cms)
Returns true if the preference is disabled.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.opencms.configuration.preferences.I_CmsPreference
getDefaultValue, getName, getTab, getValue, setValue
-
-
-
-
Constructor Detail
-
A_CmsPreference
public A_CmsPreference()
-
-
Method Detail
-
createConfigurationItem
public org.dom4j.Element createConfigurationItem()
Description copied from interface:I_CmsPreference
Creates the configuration for this preference.- Specified by:
createConfigurationItem
in interfaceI_CmsPreference
- Returns:
- the configuration for this preference
- See Also:
I_CmsPreference.createConfigurationItem()
-
getPropertyDefinition
public CmsXmlContentProperty getPropertyDefinition(CmsObject cms)
Description copied from interface:I_CmsPreference
Gets the metadata describing how the setting should be edited.- Specified by:
getPropertyDefinition
in interfaceI_CmsPreference
- Parameters:
cms
- the current CMS context- Returns:
- the metadata for the client which describes how the setting should be edited
- See Also:
I_CmsPreference.getPropertyDefinition(org.opencms.file.CmsObject)
-
isDisabled
public boolean isDisabled(CmsObject cms)
Description copied from interface:I_CmsPreference
Returns true if the preference is disabled.- Specified by:
isDisabled
in interfaceI_CmsPreference
- Parameters:
cms
- the current CMS context- Returns:
- true if the preference is disabled
- See Also:
I_CmsPreference.isDisabled(CmsObject)
-
getPropertyDefinition
protected abstract CmsXmlContentProperty getPropertyDefinition()
Gets the user-independent property configuration.This is what is used to write the preference back to the workplace configuration.
- Returns:
- the property configuration
-
-