Package org.opencms.configuration.preferences

Class CmsPreferenceData

java.lang.Object

org.opencms.configuration.preferences.CmsPreferenceData

public class CmsPreferenceData
extends Object

Bean representing the configurable attributes for a preference.

Constructor Summary

Constructors

Constructor	Description
CmsPreferenceData(String name, String value, CmsXmlContentProperty prop, String tab)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
String	getDefaultValue()	Gets the default value for the preference.
String	getName()	Gets the name of the preference.
CmsXmlContentProperty	getPropertyDefinition()	Gets the preference definition.
String	getTab()	Gets the tab on which the preference should be displayed.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsPreferenceData

public CmsPreferenceData(String name,
 String value,
 CmsXmlContentProperty prop,
 String tab)

Creates a new instance.

Parameters:

name - the preference name

value - the preference value

prop - the preference configuration

tab - the tab on which to display the preference

Method Details

getDefaultValue

public String getDefaultValue()

Gets the default value for the preference.

Returns:

the default value for the preference

getName

public String getName()

Gets the name of the preference.

Returns:

the preference name

getPropertyDefinition

public CmsXmlContentProperty getPropertyDefinition()

Gets the preference definition.

Returns:

the preference definition

getTab

public String getTab()

Gets the tab on which the preference should be displayed.

Returns:

the tab on which the preference should be displayed