org.opencms.configuration.preferences

Class CmsElementViewPreference

java.lang.Object

org.opencms.configuration.preferences.A_CmsPreference

org.opencms.configuration.preferences.CmsBuiltinPreference

org.opencms.configuration.preferences.CmsElementViewPreference

All Implemented Interfaces:

I_CmsPreference

Direct Known Subclasses:

CmsExplorerElementViewPreference

public class CmsElementViewPreference
extends CmsBuiltinPreference

Element view 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 and Description
static java.lang.String	EXPLORER_PREFERENCE_NAME Preference name for the explorer.
static java.lang.String	PREFERENCE_NAME The preference name.

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

m_basic, m_hidden

Constructor Summary

Constructors

Constructor and Description
CmsElementViewPreference(java.lang.String propName) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
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.

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

Field Detail

PREFERENCE_NAME

public static final java.lang.String PREFERENCE_NAME

The preference name.

See Also:

Constant Field Values

EXPLORER_PREFERENCE_NAME

public static final java.lang.String EXPLORER_PREFERENCE_NAME

Preference name for the explorer.

See Also:

Constant Field Values

Constructor Detail

CmsElementViewPreference

public CmsElementViewPreference(java.lang.String propName)

Constructor.

Parameters:

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

Method Detail

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