Package org.opencms.configuration.preferences

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(String name, String value, CmsXmlContentProperty prop, String tab)	Creates a new instance.

Method Summary

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.
String	getDefaultValue()	Gets the default value for the preference.
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.
String	getTab()	Gets the preference tab.
String	getValue(CmsDefaultUserSettings userSettings)	Reads the value of the preference from a CmsDefaultUserSettings instance .
void	setValue(CmsDefaultUserSettings settings, String value)	Sets the value of the preference in a CmsDefaultUserSettings instance.

Methods inherited from class org.opencms.configuration.preferences.A_CmsPreference

createConfigurationItem, isDisabled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CmsUserDefinedPreference

public CmsUserDefinedPreference(String name,
 String value,
 CmsXmlContentProperty prop,
 String tab)

Creates a new instance.

Parameters:

name - the preference name

value - the preference value

prop - the bean containing the widget configuration for the preference

tab - the tab on which to display the widget

Method Details

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 data

elem - the element in which the attributes should be created

getDefaultValue

public 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 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 interface I_CmsPreference

Overrides:

getPropertyDefinition in class A_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 String getTab()

Description copied from interface: I_CmsPreference

Gets the preference tab.

Returns:

the preference tab

See Also:

• I_CmsPreference.getTab()

getValue

public 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,
 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 value

value - 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 class A_CmsPreference

Returns:

the property configuration

See Also:

• A_CmsPreference.getPropertyDefinition()