Package org.opencms.configuration.preferences

Class CmsBuiltinPreference

java.lang.Object

org.opencms.configuration.preferences.A_CmsPreference

org.opencms.configuration.preferences.CmsBuiltinPreference

All Implemented Interfaces:

I_CmsPreference

Direct Known Subclasses:

CmsElementViewPreference, CmsGalleryShowInvalidDefaultPreference, CmsHiddenBuiltinPreference, CmsLanguagePreference, CmsProjectPreference, CmsSitePreference, CmsStartFolderPreference, CmsStartViewPreference, CmsTimeWarpPreference, CmsWorkplaceModePreference

public class CmsBuiltinPreference
extends A_CmsPreference

Preference subclass for built-in preferences accessed with a getter/setter pair via reflection.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CmsBuiltinPreference.SelectOptions	A bean representing a set of select options.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_basic	True if this is a basic preference.
protected boolean	m_hidden	True if this is a hidden preference.

Constructor Summary

Constructors

Constructor	Description
CmsBuiltinPreference(String propName)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
String	getDefaultValue()	Gets the default value for the preference.
String	getName()	Gets the preference name.
CmsXmlContentProperty	getPropertyDefinition()	Gets the user-independent property configuration.
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, getPropertyDefinition, isDisabled

Methods inherited from class java.lang.Object

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

Field Details

m_basic

protected boolean m_basic

True if this is a basic preference.

m_hidden

protected boolean m_hidden

True if this is a hidden preference.

Constructor Details

CmsBuiltinPreference

public CmsBuiltinPreference(String propName)

Creates a new instance.

Parameters:

propName - the name of the bean property used to access this preference

Method Details

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()

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()

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)