Package org.opencms.configuration.preferences

Class CmsEditorPreference

java.lang.Object

org.opencms.configuration.preferences.A_CmsPreference

org.opencms.configuration.preferences.CmsEditorPreference

All Implemented Interfaces:

I_CmsPreference

public class CmsEditorPreference
extends A_CmsPreference

Preference subclass for preferred editors.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EDITOR_PREFIX	Prefix used for editor preference settings.

Constructor Summary

Constructors

Constructor	Description
CmsEditorPreference(String editorType, String value)

Method Summary

Modifier and Type	Method	Description
String	getDefaultValue()	Gets the default value for the preference.
String	getName()	Gets the preference name.
CmsXmlContentProperty	getPropertyDefinition()	Gets the user-independent property configuration.
String	getTab()	Gets the preference tab.
String	getValue(CmsDefaultUserSettings userSettings)	Reads the value of the preference from a CmsDefaultUserSettings instance .
boolean	isDisabled(CmsObject cms)	Returns true if the preference is disabled.
void	setValue(CmsDefaultUserSettings settings, String value)	Sets the value of the preference in a CmsDefaultUserSettings instance.

Methods inherited from class org.opencms.configuration.preferences.A_CmsPreference

createConfigurationItem, getPropertyDefinition

Methods inherited from class java.lang.Object

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

Field Details

EDITOR_PREFIX

public static final String EDITOR_PREFIX

Prefix used for editor preference settings.

See Also:

• Constant Field Values

Constructor Details

CmsEditorPreference

public CmsEditorPreference(String editorType,
 String value)

Parameters:

editorType - the type for which this is the editor preference

value - the default value

Method Details

getDefaultValue

public String getDefaultValue()

Description copied from interface: I_CmsPreference

Gets the default value for the preference.

Returns:

the default value

See Also:

• I_CmsPreference.getDefaultValue()

getName

public String getName()

Description copied from interface: I_CmsPreference

Gets the preference name.

Returns:

the preference name

See Also:

• I_CmsPreference.getName()

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.

Specified by:

getPropertyDefinition in class A_CmsPreference

Returns:

the property configuration

See Also:

• I_CmsPreference.getPropertyDefinition(org.opencms.file.CmsObject)

getTab

public String getTab()

Description copied from interface: I_CmsPreference

Gets the preference tab.

Returns:

the preference tab

See Also:

• I_CmsPreference.getTab()

getValue

public String getValue(CmsDefaultUserSettings userSettings)

Description copied from interface: I_CmsPreference

Reads the value of the preference from a CmsDefaultUserSettings instance .

Parameters:

userSettings - the user settings from which to read the preference value

Returns:

the preference value

See Also:

• I_CmsPreference.getValue(org.opencms.configuration.CmsDefaultUserSettings)

isDisabled

public boolean isDisabled(CmsObject cms)

Description copied from interface: I_CmsPreference

Returns true if the preference is disabled.

Specified by:

isDisabled in interface I_CmsPreference

Overrides:

isDisabled in class A_CmsPreference

Parameters:

cms - the current CMS context

Returns:

true if the preference is disabled

See Also:

• I_CmsPreference.isDisabled(CmsObject)

setValue

public void setValue(CmsDefaultUserSettings settings,
 String value)

Description copied from interface: I_CmsPreference

Sets the value of the preference in a CmsDefaultUserSettings instance.

Parameters:

settings - the settings used to store the preference value

value - the new value

See Also:

• I_CmsPreference.setValue(org.opencms.configuration.CmsDefaultUserSettings, java.lang.String)