Interface I_CmsPreference
-
- All Known Implementing Classes:
A_CmsPreference
,CmsBuiltinPreference
,CmsEditorPreference
,CmsElementViewPreference
,CmsExplorerElementViewPreference
,CmsGalleryShowInvalidDefaultPreference
,CmsHiddenBuiltinPreference
,CmsLanguagePreference
,CmsProjectPreference
,CmsSitePreference
,CmsStartFolderPreference
,CmsStartGallleryPreference
,CmsStartViewPreference
,CmsTimeWarpPreference
,CmsUserDefinedPreference
,CmsWorkplaceModePreference
,CmsWrapperPreference
public interface I_CmsPreference
Interface describing a single preference value which can possibly be edited by the user.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description org.dom4j.Element
createConfigurationItem()
Creates the configuration for this preference.java.lang.String
getDefaultValue()
Gets the default value for the preference.java.lang.String
getName()
Gets the preference name.CmsXmlContentProperty
getPropertyDefinition(CmsObject cms)
Gets the metadata describing how the setting should be edited.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.
-
-
-
Method Detail
-
createConfigurationItem
org.dom4j.Element createConfigurationItem()
Creates the configuration for this preference.- Returns:
- the configuration for this preference
-
getDefaultValue
java.lang.String getDefaultValue()
Gets the default value for the preference.- Returns:
- the default value
-
getName
java.lang.String getName()
Gets the preference name.- Returns:
- the preference name
-
getPropertyDefinition
CmsXmlContentProperty getPropertyDefinition(CmsObject cms)
Gets the metadata describing how the setting should be edited.- Parameters:
cms
- the current CMS context- Returns:
- the metadata for the client which describes how the setting should be edited
-
getTab
java.lang.String getTab()
Gets the preference tab.- Returns:
- the preference tab
-
getValue
java.lang.String getValue(CmsDefaultUserSettings userSettings)
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
-
isDisabled
boolean isDisabled(CmsObject cms)
Returns true if the preference is disabled.- Parameters:
cms
- the current CMS context- Returns:
- true if the preference is disabled
-
setValue
void setValue(CmsDefaultUserSettings settings, java.lang.String value)
Sets the value of the preference in a CmsDefaultUserSettings instance.- Parameters:
settings
- the settings used to store the preference valuevalue
- the new value
-
-