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 java.lang.String
PREFERENCE_NAME
The preference name.static java.lang.String
WIDGET_CONFIG
Widget configuration.-
Fields inherited from class org.opencms.configuration.preferences.CmsBuiltinPreference
m_basic, m_hidden
-
-
Constructor Summary
Constructors Constructor Description CmsWorkplaceModePreference(java.lang.String propName)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDefaultValue()
Gets the default value for the preference.java.lang.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
-
-
-
-
Field Detail
-
PREFERENCE_NAME
public static final java.lang.String PREFERENCE_NAME
The preference name.- See Also:
- Constant Field Values
-
WIDGET_CONFIG
public static final java.lang.String WIDGET_CONFIG
Widget configuration.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsWorkplaceModePreference
public CmsWorkplaceModePreference(java.lang.String propName)
Constructor.- Parameters:
propName
- the name of the bean property used to access this preference
-
-
Method Detail
-
getDefaultValue
public java.lang.String getDefaultValue()
Description copied from interface:I_CmsPreference
Gets the default value for the preference.- Specified by:
getDefaultValue
in interfaceI_CmsPreference
- Overrides:
getDefaultValue
in classCmsBuiltinPreference
- Returns:
- the default value
- See Also:
CmsBuiltinPreference.getDefaultValue()
-
getNiceName
public java.lang.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 classCmsBuiltinPreference
- 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 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:
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 interfaceI_CmsPreference
- Overrides:
isDisabled
in classA_CmsPreference
- Parameters:
cms
- the current CMS context- Returns:
- true if the preference is disabled
- See Also:
A_CmsPreference.isDisabled(CmsObject)
-
-