Package org.opencms.configuration.preferences

Class CmsWorkplaceModePreference

java.lang.Object

org.opencms.configuration.preferences.A_CmsPreference

org.opencms.configuration.preferences.CmsBuiltinPreference

org.opencms.configuration.preferences.CmsWorkplaceModePreference

All Implemented Interfaces:

I_CmsPreference

public class CmsWorkplaceModePreference
extends CmsBuiltinPreference

Workplace mode preference configuration.

Nested Class Summary

Nested classes/interfaces inherited from class org.opencms.configuration.preferences.CmsBuiltinPreference

CmsBuiltinPreference.SelectOptions

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFERENCE_NAME	The preference name.
static final String	WIDGET_CONFIG	Widget configuration.

Fields inherited from class org.opencms.configuration.preferences.CmsBuiltinPreference

m_basic, m_hidden

Constructor Summary

Constructors

Constructor	Description
CmsWorkplaceModePreference(String propName)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getDefaultValue()	Gets the default value for the preference.
String	getNiceName()	Gets the nice name key.
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 org.opencms.configuration.preferences.CmsBuiltinPreference

getName, getTab, getValue, setValue

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

createConfigurationItem

Methods inherited from class java.lang.Object

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

Field Details

PREFERENCE_NAME

public static final String PREFERENCE_NAME

The preference name.

See Also:

• Constant Field Values

WIDGET_CONFIG

public static final String WIDGET_CONFIG

Widget configuration.

See Also:

• Constant Field Values

Constructor Details

CmsWorkplaceModePreference

public CmsWorkplaceModePreference(String propName)

Constructor.

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.

Specified by:

getDefaultValue in interface I_CmsPreference

Overrides:

getDefaultValue in class CmsBuiltinPreference

Returns:

the default value

See Also:

• CmsBuiltinPreference.getDefaultValue()

getNiceName

public String getNiceName()

Gets the nice name key.

Returns:

the nice name key

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.

Overrides:

getPropertyDefinition in class CmsBuiltinPreference

Returns:

the property configuration

See Also:

• CmsBuiltinPreference.getPropertyDefinition()

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:

• A_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 interface I_CmsPreference

Overrides:

isDisabled in class A_CmsPreference

Parameters:

cms - the current CMS context

Returns:

true if the preference is disabled

See Also:

• A_CmsPreference.isDisabled(CmsObject)