Package org.opencms.jsp.util

Interface I_CmsFormatterInfo

All Superinterfaces:

I_CmsInfoWrapper

All Known Implementing Classes:

CmsFormatterInfoWrapper, CmsResourceTypeInfoWrapper

public interface I_CmsFormatterInfo
extends I_CmsInfoWrapper

Common interface for accessing formatter / resource type infos in JSPs.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	I_CmsFormatterInfo.ResolveMode	Mode which controls whether / how localized strings should be resolved.

Method Summary

Modifier and Type	Method	Description
String	description(Locale l)	Gets the description in the given locale.
boolean	getIsActive()	Checks if this is active.
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 name.
String	getNiceName()	Gets the nice name for 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 l)	Gets the nice name in the given locale.

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

getDescription, getDescriptionKey, getDescriptionRaw

Method Details

description

String description(Locale l)

Gets the description in the given locale.

Parameters:

l - the locale to use

Returns:

the description

getIsActive

boolean getIsActive()

Checks if this is active.

Returns:

true if this is active

getIsFormatter

boolean getIsFormatter()

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

Returns:

true if this wraps a normal formatter

getIsFunction

boolean getIsFunction()

Checks if this wraps a dynamic function.

Returns:

true if this wraps a dynamic function

getIsResourceType

boolean getIsResourceType()

Checks if this wraps a resource type.

Returns:

true if this is a resource type

getName

String getName()

Gets the name.

Returns:

the name

getNiceName

String getNiceName()

Gets the nice name for the current locale.

Returns:

the nice name for the current locale

getNiceNameKey

String getNiceNameKey()

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

Returns:

the localization key

getNiceNameRaw

String getNiceNameRaw()

Gets the raw nice name, without resolving any macros.

Returns:

the raw nice name

niceName

String niceName(Locale l)

Gets the nice name in the given locale.

Parameters:

l - the locale to use

Returns:

the nice name for the locale