Package org.opencms.jsp.util
Class CmsSettingDefinitionWrapper
- java.lang.Object
-
- org.opencms.jsp.util.CmsSettingDefinitionWrapper
-
public class CmsSettingDefinitionWrapper extends java.lang.Object
Wrapper used to access element setting definition information in JSP code.
-
-
Constructor Summary
Constructors Constructor Description CmsSettingDefinitionWrapper(CmsObject cms, CmsXmlContentProperty settingDef, CmsMacroResolver resolver)
Creates a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDefaultValue()
Gets the default value.java.lang.String
getDescription()
Gets the description.java.lang.String
getDescriptionKey()
Gets the description key.java.lang.String
getDisplayName()
Gets the display name.java.lang.String
getDisplayNameKey()
Gets the display name key.java.util.List<CmsSelectWidgetOption>
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.java.lang.String
getPropertyName()
Gets the property name.java.lang.String
getVisibility()
Gets the visibility.java.lang.String
getWidget()
Gets the widget.java.lang.String
getWidgetConfig()
Gets the widget config.java.lang.String
toString()
-
-
-
Constructor Detail
-
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 Detail
-
getDefaultValue
public java.lang.String getDefaultValue()
Gets the default value.- Returns:
- the default value
-
getDescription
public java.lang.String getDescription()
Gets the description.- Returns:
- the description
-
getDescriptionKey
public java.lang.String getDescriptionKey()
Gets the description key.- Returns:
- the description key
-
getDisplayName
public java.lang.String getDisplayName()
Gets the display name.- Returns:
- the display name
-
getDisplayNameKey
public java.lang.String getDisplayNameKey()
Gets the display name key.- Returns:
- the display name key
-
getParsedSelectOptions
public java.util.List<CmsSelectWidgetOption> 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
public java.lang.String getPropertyName()
Gets the property name.- Returns:
- the property name
-
getVisibility
public java.lang.String getVisibility()
Gets the visibility.- Returns:
- the visibility
-
getWidget
public java.lang.String getWidget()
Gets the widget.- Returns:
- the widget
-
getWidgetConfig
public java.lang.String getWidgetConfig()
Gets the widget config.- Returns:
- the widget config
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
- See Also:
Object.toString()
-
-