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 java.lang.String
EDITOR_PREFIX
Prefix used for editor preference settings.
-
Constructor Summary
Constructors Constructor Description CmsEditorPreference(java.lang.String editorType, java.lang.String value)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDefaultValue()
Gets the default value for the preference.java.lang.String
getName()
Gets the preference name.CmsXmlContentProperty
getPropertyDefinition()
Gets the user-independent property configuration.java.lang.String
getTab()
Gets the preference tab.java.lang.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, java.lang.String value)
Sets the value of the preference in a CmsDefaultUserSettings instance.-
Methods inherited from class org.opencms.configuration.preferences.A_CmsPreference
createConfigurationItem, getPropertyDefinition
-
-
-
-
Field Detail
-
EDITOR_PREFIX
public static final java.lang.String EDITOR_PREFIX
Prefix used for editor preference settings.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsEditorPreference
public CmsEditorPreference(java.lang.String editorType, java.lang.String value)
- Parameters:
editorType
- the type for which this is the editor preferencevalue
- the default value
-
-
Method Detail
-
getDefaultValue
public java.lang.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 java.lang.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 classA_CmsPreference
- Returns:
- the property configuration
- See Also:
I_CmsPreference.getPropertyDefinition(org.opencms.file.CmsObject)
-
getTab
public java.lang.String getTab()
Description copied from interface:I_CmsPreference
Gets the preference tab.- Returns:
- the preference tab
- See Also:
I_CmsPreference.getTab()
-
getValue
public java.lang.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 interfaceI_CmsPreference
- Overrides:
isDisabled
in classA_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, java.lang.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 valuevalue
- the new value- See Also:
I_CmsPreference.setValue(org.opencms.configuration.CmsDefaultUserSettings, java.lang.String)
-
-