Package org.opencms.jsp.util

Class CmsSettingDefinitionWrapper

java.lang.Object

org.opencms.jsp.util.CmsSettingDefinitionWrapper

All Implemented Interfaces:

I_CmsInfoWrapper

public class CmsSettingDefinitionWrapper
extends Object
implements I_CmsInfoWrapper

Wrapper used to access element setting definition information in JSP code.

Constructor Summary

Constructors

Constructor	Description
CmsSettingDefinitionWrapper(CmsObject cms, CmsXmlContentProperty settingDef, Function<Locale,CmsMacroResolver> resolverProvider)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
String	getDefaultValue()	Gets the default value.
String	getDescription()	Gets the description.
String	getDescription(Locale locale)	Gets the localized description for a particular locale.
String	getDescriptionKey()	Gets the description key.
String	getDescriptionRaw()	Gets the raw description configured for the setting.
String	getDisplayName()	Gets the display name.
String	getDisplayNameKey()	Gets the display name key.
String	getDisplayNameRaw()	Gets the raw configured display name.
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.
String	getPropertyName()	Gets the property name.
String	getVisibility()	Gets the visibility.
String	getWidget()	Gets the widget.
String	getWidgetConfig()	Gets the widget config.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.jsp.util.I_CmsInfoWrapper

getDescription

Constructor Details

CmsSettingDefinitionWrapper

public CmsSettingDefinitionWrapper(CmsObject cms,
 CmsXmlContentProperty settingDef,
 Function<Locale,CmsMacroResolver> resolverProvider)

Creates a new instance.

Parameters:

cms - the current CMS context

settingDef - the raw setting definition

resolverProvider - provides macro resolvers for a particular locale

Method Details

getDefaultValue

public String getDefaultValue()

Gets the default value.

Returns:

the default value

getDescription

public String getDescription()

Gets the description.

Specified by:

getDescription in interface I_CmsInfoWrapper

Returns:

the description

getDescription

public String getDescription(Locale locale)

Gets the localized description for a particular locale.

Specified by:

getDescription in interface I_CmsInfoWrapper

Parameters:

locale - the locale

Returns:

the localized description

getDescriptionKey

public String getDescriptionKey()

Gets the description key.

Specified by:

getDescriptionKey in interface I_CmsInfoWrapper

Returns:

the description key

getDescriptionRaw

public String getDescriptionRaw()

Gets the raw description configured for the setting.

Specified by:

getDescriptionRaw in interface I_CmsInfoWrapper

Returns:

the raw description

getDisplayName

public String getDisplayName()

Gets the display name.

Returns:

the display name

getDisplayNameKey

public String getDisplayNameKey()

Gets the display name key.

Returns:

the display name key

getDisplayNameRaw

public String getDisplayNameRaw()

Gets the raw configured display name.

Returns:

the raw display name

getParsedSelectOptions

public 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 String getPropertyName()

Gets the property name.

Returns:

the property name

getVisibility

public String getVisibility()

Gets the visibility.

Returns:

the visibility

getWidget

public String getWidget()

Gets the widget.

Returns:

the widget

getWidgetConfig

public String getWidgetConfig()

Gets the widget config.

Returns:

the widget config

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()