Package org.opencms.configuration.preferences

Class CmsSitePreference

java.lang.Object

org.opencms.configuration.preferences.A_CmsPreference

org.opencms.configuration.preferences.CmsBuiltinPreference

org.opencms.configuration.preferences.CmsSitePreference

All Implemented Interfaces:

I_CmsPreference

public class CmsSitePreference
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
CmsSitePreference(java.lang.String name)	Creates a new instance.

Method Summary

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 java.lang.String	getSiteSelectOptionsStatic(CmsObject cms, java.util.Locale locale)	Gets the options for the site selector.

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, isDisabled

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsSitePreference

public CmsSitePreference(java.lang.String name)

Creates a new instance.

Parameters:

name - the preference name

Method Detail

getSiteSelectOptionsStatic

public static java.lang.String getSiteSelectOptionsStatic(CmsObject cms,
                                                          java.util.Locale locale)

Gets the options for the site selector.

Parameters:

cms - the CMS context

locale - the locale for the select options

Returns:

the options for the site selector

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:

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