Package org.opencms.jsp.util
Class CmsSettingDefinitionWrapper
java.lang.Object
org.opencms.jsp.util.CmsSettingDefinitionWrapper
Wrapper used to access element setting definition information in JSP code.
-
Constructor Summary
ConstructorsConstructorDescriptionCmsSettingDefinitionWrapper(CmsObject cms, CmsXmlContentProperty settingDef, CmsMacroResolver resolver) Creates a new instance. -
Method Summary
Modifier and TypeMethodDescriptionGets the default value.Gets the description.Gets the description key.Gets the display name.Gets the display name key.Tries to interpret the widget configuration as a select option configuration and returns the list of select options if this succeeds, and null otherwise.Gets the property name.Gets the visibility.Gets the widget.Gets the widget config.toString()
-
Constructor Details
-
CmsSettingDefinitionWrapper
public CmsSettingDefinitionWrapper(CmsObject cms, CmsXmlContentProperty settingDef, CmsMacroResolver resolver) Creates a new instance.- Parameters:
cms- the current CMS contextsettingDef- the raw setting definitionresolver- the macro resolver to use
-
-
Method Details
-
getDefaultValue
Gets the default value.- Returns:
- the default value
-
getDescription
Gets the description.- Returns:
- the description
-
getDescriptionKey
Gets the description key.- Returns:
- the description key
-
getDisplayName
Gets the display name.- Returns:
- the display name
-
getDisplayNameKey
Gets the display name key.- Returns:
- the display name key
-
getParsedSelectOptions
Tries to interpret the widget configuration as a select option configuration and returns the list of select options if this succeeds, and null otherwise.- Returns:
- the list of parsed select options, or null if the widget configuration couldn't be interpreted that way
-
getPropertyName
Gets the property name.- Returns:
- the property name
-
getVisibility
Gets the visibility.- Returns:
- the visibility
-
getWidget
Gets the widget.- Returns:
- the widget
-
getWidgetConfig
Gets the widget config.- Returns:
- the widget config
-
toString
-