Package org.opencms.jsp.util

Class CmsFormatterInfoWrapper

java.lang.Object

org.opencms.jsp.util.CmsFormatterInfoWrapper

All Implemented Interfaces:

I_CmsFormatterInfo, I_CmsInfoWrapper

public class CmsFormatterInfoWrapper
extends Object
implements I_CmsFormatterInfo

Wrapper class for accessing formatter information from JSPs.

Nested Class Summary

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

I_CmsFormatterInfo.ResolveMode

Constructor Summary

Constructors

Constructor	Description
CmsFormatterInfoWrapper(CmsObject cms, CmsADEConfigData config, I_CmsFormatterBean formatter)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
String	description(Locale locale)	Gets the description of the formatter in the given locale.
List<String>	getContainerTypes()	Gets the matching container types.
String	getDefinition()	Gets the path of the formatter definition XML file.
String	getDescription()	Gets the localized description.
String	getDescriptionKey()	Returns the localization key for the description if one was used, and null otherwise.
String	getDescriptionRaw()	Gets the raw description, without resolving any macros.
String	getDisplay()	Gets the display type of the formatter.
boolean	getIsActive()	Checks if this is active.
boolean	getIsDetailFormatter()	Checks if the formatter is a detail formatter.
boolean	getIsDisplayFormatter()	Checks if the formatter is a display formatter.
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	getJsp()	Gets the JSP path.
String	getKey()	Gets the formatter key.
static CmsMacroResolver	getMacroResolverForFormatter(CmsObject cms, I_CmsFormatterBean formatter)	Prepares the macro resolver to use for formatter info / setting info beans.
int	getMaxWidth()	Gets the maximum container width.
int	getMinWidth()	Gets the minimum container width.
String	getName()	Gets the name.
String	getNiceName()	Gets the user-readable formatter name.
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.
int	getRank()	Returns the rank of the formatter.
List<CmsSettingDefinitionWrapper>	getSettings()	Gets a list of wrapper beans for the element setting definitions.
List<String>	getTypes()	Gets the resource types.
String	niceName(Locale locale)	Gets the nice name of the formatter in the given locale.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsFormatterInfoWrapper

public CmsFormatterInfoWrapper(CmsObject cms,
 CmsADEConfigData config,
 I_CmsFormatterBean formatter)

Creates a new instance.

Parameters:

cms - the CMS context

config - the sitemap configuration

formatter - the formatter bean to wrap

Method Details

getMacroResolverForFormatter

public static CmsMacroResolver getMacroResolverForFormatter(CmsObject cms,
 I_CmsFormatterBean formatter)

Prepares the macro resolver to use for formatter info / setting info beans.

Parameters:

cms - the CMS context to use

formatter - the formatter bean

Returns:

the macro resolver to sue

description

public String description(Locale locale)

Gets the description of the formatter in the given locale.

Specified by:

description in interface I_CmsFormatterInfo

Parameters:

locale - the locale to use

Returns:

the description

getContainerTypes

public List<String> getContainerTypes()

Gets the matching container types.

Returns:

the container types the formatter fits into

getDefinition

public String getDefinition()

Gets the path of the formatter definition XML file.

Returns:

the path of the formatter definition XML file

getDescription

public String getDescription()

Gets the localized description.

Specified by:

getDescription in interface I_CmsInfoWrapper

Returns:

the 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()

getDescriptionRaw

public String getDescriptionRaw()

Gets the raw description, without resolving any macros.

Specified by:

getDescriptionRaw in interface I_CmsInfoWrapper

Returns:

the raw description

getDisplay

public String getDisplay()

Gets the display type of the formatter.

Returns:

the display type of the formatter

getIsActive

public boolean getIsActive()

Description copied from interface: I_CmsFormatterInfo

Checks if this is active.

Specified by:

getIsActive in interface I_CmsFormatterInfo

Returns:

true if this is active

See Also:

• I_CmsFormatterInfo.getIsActive()

getIsDetailFormatter

public boolean getIsDetailFormatter()

Checks if the formatter is a detail formatter.

Returns:

true if the formatter is a detail formatter

getIsDisplayFormatter

public boolean getIsDisplayFormatter()

Checks if the formatter is a display formatter.

Returns:

true if the formatter is a display formatter

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()

getJsp

public String getJsp()

Gets the JSP path.

Returns:

the JSP path

getKey

public String getKey()

Gets the formatter key.

Returns:

the formatter key

getMaxWidth

public int getMaxWidth()

Gets the maximum container width.

Returns:

the maximum container width

getMinWidth

public int getMinWidth()

Gets the minimum container width.

Returns:

the minimum container width

getName

public String getName()

Description copied from interface: I_CmsFormatterInfo

Gets the name.

Specified by:

getName in interface I_CmsFormatterInfo

Returns:

the name

See Also:

• I_CmsFormatterInfo.getName()

getNiceName

public String getNiceName()

Gets the user-readable formatter name.

Specified by:

getNiceName in interface I_CmsFormatterInfo

Returns:

the user-readable name

getNiceNameKey

public String getNiceNameKey()

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

getNiceNameRaw

public String getNiceNameRaw()

Gets the raw nice name, without resolving any macros.

Specified by:

getNiceNameRaw in interface I_CmsFormatterInfo

Returns:

the raw nice name

getRank

public int getRank()

Returns the rank of the formatter.

Returns:

the rank

getSettings

public List<CmsSettingDefinitionWrapper> getSettings()

Gets a list of wrapper beans for the element setting definitions.

Returns:

the element setting definition wrappers

getTypes

public List<String> getTypes()

Gets the resource types.

Returns:

the resource types

niceName

public String niceName(Locale locale)

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

Specified by:

niceName in interface I_CmsFormatterInfo

Parameters:

locale - the locale to use

Returns:

the nice name of the formatter