Class CmsUserDefinedPreference
- java.lang.Object
-
- org.opencms.configuration.preferences.A_CmsPreference
-
- org.opencms.configuration.preferences.CmsUserDefinedPreference
-
- All Implemented Interfaces:
I_CmsPreference
public class CmsUserDefinedPreference extends A_CmsPreference
Subclass for user-defined preferences.
-
-
Constructor Summary
Constructors Constructor Description CmsUserDefinedPreference(java.lang.String name, java.lang.String value, CmsXmlContentProperty prop, java.lang.String tab)
Creates a new instance.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static void
fillAttributes(CmsPreferenceData pref, org.dom4j.Element elem)
Helper method used to create the configuration attributes for a CmsPreferenceData bean.java.lang.String
getDefaultValue()
Gets the default value for the preference.java.lang.String
getName()
Gets the preference name.protected CmsXmlContentProperty
getPropertyDefinition()
Gets the user-independent property configuration.CmsXmlContentProperty
getPropertyDefinition(CmsObject cms)
Gets the metadata describing how the setting should be edited.java.lang.String
getTab()
Gets the preference tab.java.lang.String
getValue(CmsDefaultUserSettings userSettings)
Reads the value of the preference from a CmsDefaultUserSettings instance .void
setValue(CmsDefaultUserSettings settings, java.lang.String value)
Sets the value of the preference in a CmsDefaultUserSettings instance.-
Methods inherited from class org.opencms.configuration.preferences.A_CmsPreference
createConfigurationItem, isDisabled
-
-
-
-
Constructor Detail
-
CmsUserDefinedPreference
public CmsUserDefinedPreference(java.lang.String name, java.lang.String value, CmsXmlContentProperty prop, java.lang.String tab)
Creates a new instance.- Parameters:
name
- the preference namevalue
- the preference valueprop
- the bean containing the widget configuration for the preferencetab
- the tab on which to display the widget
-
-
Method Detail
-
fillAttributes
public static void fillAttributes(CmsPreferenceData pref, org.dom4j.Element elem)
Helper method used to create the configuration attributes for a CmsPreferenceData bean.- Parameters:
pref
- the preference dataelem
- the element in which the attributes should be created
-
getDefaultValue
public java.lang.String getDefaultValue()
Description copied from interface:I_CmsPreference
Gets the default value for the preference.- Returns:
- the default value
- See Also:
I_CmsPreference.getDefaultValue()
-
getName
public java.lang.String getName()
Description copied from interface:I_CmsPreference
Gets the preference name.- Returns:
- the preference name
- See Also:
I_CmsPreference.getName()
-
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
- Overrides:
getPropertyDefinition
in classA_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)
-
getTab
public java.lang.String getTab()
Description copied from interface:I_CmsPreference
Gets the preference tab.- Returns:
- the preference tab
- See Also:
I_CmsPreference.getTab()
-
getValue
public java.lang.String getValue(CmsDefaultUserSettings userSettings)
Description copied from interface:I_CmsPreference
Reads the value of the preference from a CmsDefaultUserSettings instance .- Parameters:
userSettings
- the user settings from which to read the preference value- Returns:
- the preference value
- See Also:
I_CmsPreference.getValue(org.opencms.configuration.CmsDefaultUserSettings)
-
setValue
public void setValue(CmsDefaultUserSettings settings, java.lang.String value)
Description copied from interface:I_CmsPreference
Sets the value of the preference in a CmsDefaultUserSettings instance.- Parameters:
settings
- the settings used to store the preference valuevalue
- the new value- See Also:
I_CmsPreference.setValue(org.opencms.configuration.CmsDefaultUserSettings, java.lang.String)
-
getPropertyDefinition
protected CmsXmlContentProperty getPropertyDefinition()
Description copied from class:A_CmsPreference
Gets the user-independent property configuration.This is what is used to write the preference back to the workplace configuration.
- Specified by:
getPropertyDefinition
in classA_CmsPreference
- Returns:
- the property configuration
- See Also:
A_CmsPreference.getPropertyDefinition()
-
-