Class CmsStartViewPreference
- java.lang.Object
-
- org.opencms.configuration.preferences.A_CmsPreference
-
- org.opencms.configuration.preferences.CmsBuiltinPreference
-
- org.opencms.configuration.preferences.CmsStartViewPreference
-
- All Implemented Interfaces:
I_CmsPreference
public class CmsStartViewPreference extends CmsBuiltinPreference
Preference for the start site.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.opencms.configuration.preferences.CmsBuiltinPreference
CmsBuiltinPreference.SelectOptions
-
-
Field Summary
-
Fields inherited from class org.opencms.configuration.preferences.CmsBuiltinPreference
m_basic, m_hidden
-
-
Constructor Summary
Constructors Constructor Description CmsStartViewPreference(java.lang.String name)
Creates a new instance.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description CmsXmlContentProperty
getPropertyDefinition()
Gets the user-independent property configuration.CmsXmlContentProperty
getPropertyDefinition(CmsObject cms)
Gets the metadata describing how the setting should be edited.static CmsBuiltinPreference.SelectOptions
getViewSelectOptions(CmsObject cms, java.lang.String value)
Gets the select options for the view selector.boolean
isDisabled(CmsObject cms)
Returns true if the preference is disabled.-
Methods inherited from class org.opencms.configuration.preferences.CmsBuiltinPreference
getDefaultValue, getName, getTab, getValue, setValue
-
Methods inherited from class org.opencms.configuration.preferences.A_CmsPreference
createConfigurationItem
-
-
-
-
Constructor Detail
-
CmsStartViewPreference
public CmsStartViewPreference(java.lang.String name)
Creates a new instance.- Parameters:
name
- the preference name
-
-
Method Detail
-
getViewSelectOptions
public static CmsBuiltinPreference.SelectOptions getViewSelectOptions(CmsObject cms, java.lang.String value)
Gets the select options for the view selector.- Parameters:
cms
- the CMS contextvalue
- the current value- Returns:
- the select options
-
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:
A_CmsPreference.getPropertyDefinition(org.opencms.file.CmsObject)
-
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(org.opencms.file.CmsObject)
-
-