Package org.opencms.jsp.util

Class CmsResourceTypeInfoWrapper

java.lang.Object

org.opencms.jsp.util.CmsResourceTypeInfoWrapper

All Implemented Interfaces:

I_CmsFormatterInfo, I_CmsInfoWrapper

public class CmsResourceTypeInfoWrapper
extends Object
implements I_CmsFormatterInfo

Wrapper for resource type information for use in JSPs.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencms.jsp.util.I_CmsFormatterInfo

I_CmsFormatterInfo.ResolveMode

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DESCRIPTION_KEY_EXTENSION_SUFFIX	Suffix for the description key - by appending it to the key, we get another key that can be used for adding text to the description.

Constructor Summary

Constructors

Constructor	Description
CmsResourceTypeInfoWrapper(CmsJspStandardContextBean context, CmsObject cms, CmsADEConfigData config, I_CmsResourceType type)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
List<CmsFormatterInfoWrapper>	formatterInfoForContainer(String containerType)	Gets the formatter information beans for a specific container type.
String	getDescription()	Gets the type description in the current locale.
String	getDescription(Locale locale)	Gets the description for the type in the given locale.
String	getDescriptionKey()	Returns the localization key for the description if one was used, and null otherwise.
List<String>	getDescriptionKeys()	Gets the keys used for the description text.
String	getDescriptionRaw()	Gets the raw description, without resolving any macros.
Set<String>	getFormatterContainerTypes()	Gets the set of container types configured for any active formatters for this resource type.
List<CmsFormatterInfoWrapper>	getFormatterInfo()	Gets the formatter information beans for all active formatters for this type.
boolean	getIsActive()	Returns true if the type is active in the current sitemap configuration.
boolean	getIsFormatter()	Checks if this wraps a (non-function) formatter.
boolean	getIsFunction()	Checks if this wraps a dynamic function.
boolean	getIsResourceType()	Checks if this wraps a resource type.
String	getName()	Gets the type name.
String	getNiceName()	Gets the user-readable nice name of the type in the current locale.
String	getNiceNameKey()	Gets the localization key for the nice name, if one was used, or null otherwise.
String	getNiceNameRaw()	Gets the raw nice name, without resolving any macros.
String	niceName(Locale locale)	Gets the nice name of the type in the given locale.

Methods inherited from class java.lang.Object

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

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

getDescription

Field Details

DESCRIPTION_KEY_EXTENSION_SUFFIX

public static final String DESCRIPTION_KEY_EXTENSION_SUFFIX

Suffix for the description key - by appending it to the key, we get another key that can be used for adding text to the description.

See Also:

• Constant Field Values

Constructor Details

CmsResourceTypeInfoWrapper

public CmsResourceTypeInfoWrapper(CmsJspStandardContextBean context,
 CmsObject cms,
 CmsADEConfigData config,
 I_CmsResourceType type)

Creates a new instance.

Parameters:

context - the standard context bean

cms - the current CMS context

config - the current sitemap configuration

type - the type to wrap

Method Details

formatterInfoForContainer

public List<CmsFormatterInfoWrapper> formatterInfoForContainer(String containerType)

Gets the formatter information beans for a specific container type.

Parameters:

containerType - the container type

Returns:

the formatter information

getDescription

public String getDescription()

Gets the type description in the current locale.

Specified by:

getDescription in interface I_CmsInfoWrapper

Returns:

the type description

getDescription

public String getDescription(Locale locale)

Gets the description for the type in the given locale.

Specified by:

getDescription in interface I_CmsInfoWrapper

Parameters:

locale - the locale to use

Returns:

the type description

getDescriptionKey

public String getDescriptionKey()

Description copied from interface: I_CmsInfoWrapper

Returns the localization key for the description if one was used, and null otherwise.

Specified by:

getDescriptionKey in interface I_CmsInfoWrapper

Returns:

the localization key

See Also:

• I_CmsInfoWrapper.getDescriptionKey()

getDescriptionKeys

public List<String> getDescriptionKeys()

Gets the keys used for the description text.

Returns:

the list of description keys

getDescriptionRaw

public String getDescriptionRaw()

Description copied from interface: I_CmsInfoWrapper

Gets the raw description, without resolving any macros.

Specified by:

getDescriptionRaw in interface I_CmsInfoWrapper

Returns:

the raw description

See Also:

• I_CmsInfoWrapper.getDescriptionRaw()

getFormatterContainerTypes

public Set<String> getFormatterContainerTypes()

Gets the set of container types configured for any active formatters for this resource type.

Returns:

the set of container types for formatters

getFormatterInfo

public List<CmsFormatterInfoWrapper> getFormatterInfo()

Gets the formatter information beans for all active formatters for this type.

Returns:

the formatter information beans

getIsActive

public boolean getIsActive()

Returns true if the type is active in the current sitemap configuration.

Specified by:

getIsActive in interface I_CmsFormatterInfo

Returns:

true if the type is active

getIsFormatter

public boolean getIsFormatter()

Description copied from interface: I_CmsFormatterInfo

Checks if this wraps a (non-function) formatter.

Specified by:

getIsFormatter in interface I_CmsFormatterInfo

Returns:

true if this wraps a normal formatter

See Also:

• I_CmsFormatterInfo.getIsFormatter()

getIsFunction

public boolean getIsFunction()

Description copied from interface: I_CmsFormatterInfo

Checks if this wraps a dynamic function.

Specified by:

getIsFunction in interface I_CmsFormatterInfo

Returns:

true if this wraps a dynamic function

See Also:

• I_CmsFormatterInfo.getIsFunction()

getIsResourceType

public boolean getIsResourceType()

Description copied from interface: I_CmsFormatterInfo

Checks if this wraps a resource type.

Specified by:

getIsResourceType in interface I_CmsFormatterInfo

Returns:

true if this is a resource type

See Also:

• I_CmsFormatterInfo.getIsResourceType()

getName

public String getName()

Gets the type name.

Specified by:

getName in interface I_CmsFormatterInfo

Returns:

the type name

getNiceName

public String getNiceName()

Gets the user-readable nice name of the type in the current locale.

Specified by:

getNiceName in interface I_CmsFormatterInfo

Returns:

the nice name

getNiceNameKey

public String getNiceNameKey()

Description copied from interface: I_CmsFormatterInfo

Gets the localization key for the nice name, if one was used, or null otherwise.

Specified by:

getNiceNameKey in interface I_CmsFormatterInfo

Returns:

the localization key

See Also:

• I_CmsFormatterInfo.getNiceNameKey()

getNiceNameRaw

public String getNiceNameRaw()

Description copied from interface: I_CmsFormatterInfo

Gets the raw nice name, without resolving any macros.

Specified by:

getNiceNameRaw in interface I_CmsFormatterInfo

Returns:

the raw nice name

See Also:

• I_CmsFormatterInfo.getNiceNameRaw()

niceName

public String niceName(Locale locale)

Gets the nice name of the type in the given locale.

Specified by:

niceName in interface I_CmsFormatterInfo

Parameters:

locale - the locale to use

Returns:

the nice name for the type