Class Messages
- All Implemented Interfaces:
I_CmsMessageBundle
Additionally two utility methods for localization in the context of
TagSupport
implementations of the org.opencms.jsp
package are provided .
The javax.servlet.jsp.tagext.TagSupport
API constraint only allows to throw
certain Exception
types which forbids to use CmsException
which will be localized with the current user's locale at the time the request is evaluated.
At the same time TagSupport
implementations may use their member
pageContext
to get the CmsObject
and therefore the user request's
locale.
These methods provided here factor out the localization of exception messages and return Strings
for the org.opencms.jsp
pacakge.
- Since:
- 9.0.0
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Message constant for key in the resource bundle.static final String
Message constant for key in the resource bundle.static final String
Message constant for key in the resource bundle.static final String
Message constant for key in the resource bundle.static final String
Message constant for key in the resource bundle.static final String
Message constant for key in the resource bundle.static final String
Message constant for key in the resource bundle.static final String
Message constant for key in the resource bundle.static final String
Message constant for key in the resource bundle.static final String
Message constant for key in the resource bundle.static final String
Message constant for key in the resource bundle.static final String
Message constant for key in the resource bundle.static final String
Message constant for key in the resource bundle.static final String
Message constant for key in the resource bundle.static final String
Message constant for key in the resource bundle.static final String
Message constant for key in the resource bundle.static final String
Message constant for key in the resource bundle.static final String
Message constant for key in the resource bundle.static final String
Message constant for key in the resource bundle.static final String
Message constant for key in the resource bundle. -
Method Summary
Modifier and TypeMethodDescriptionstatic I_CmsMessageBundle
get()
Returns an instance of this localized message accessor.Returns the bundle name for this OpenCms package.static String
getLocalizedMessage
(CmsMessageContainer container, javax.servlet.jsp.PageContext context) Returns the String for the given CmsMessageContainer localized to the current user's locale if available or to the default locale else.static String
getLocalizedMessage
(CmsMessageContainer container, javax.servlet.ServletRequest request) Returns the String for the given CmsMessageContainer localized to the current user's locale if available or to the default locale else.static String
getLocalizedMessage
(CmsMessageContainer container, CmsObject cms) Returns the String for the given CmsMessageContainer localized to the current user's locale if available or to the default locale else.Methods inherited from class org.opencms.i18n.A_CmsMessageBundle
container, container, container, container, container, getBundle, getBundle, getOpenCmsMessageBundles, toString
-
Field Details
-
ERR_DATE_SERIES_HANDLER_ADD_EXCEPTION_FAILED_0
Message constant for key in the resource bundle.- See Also:
-
ERR_DATE_SERIES_HANDLER_ADD_EXCEPTION_FAILED_MISSING_DATE_0
Message constant for key in the resource bundle.- See Also:
-
ERR_DATE_SERIES_HANDLER_INVALID_DELETE_OPTION_1
Message constant for key in the resource bundle.- See Also:
-
ERR_DATE_SERIES_HANDLER_EXTRACT_CONTENT_FAILED_0
Message constant for key in the resource bundle.- See Also:
-
ERR_DATE_SERIES_HANDLER_EXTRACT_CONTENT_FAILED_MISSING_DATE_0
Message constant for key in the resource bundle.- See Also:
-
ERR_DATE_SERIES_HANDLER_INVALID_EDIT_OPTION_1
Message constant for key in the resource bundle.- See Also:
-
GUI_CLICK_TO_ADD_ELEMENT_TO_EMPTY_LIST_0
Message constant for key in the resource bundle.- See Also:
-
GUI_DATE_SERIES_HANDLER_EDIT_DIALOG_HEADING_0
Message constant for key in the resource bundle.- See Also:
-
GUI_DATE_SERIES_HANDLER_EDIT_DIALOG_INFO_1
Message constant for key in the resource bundle.- See Also:
-
GUI_DATE_SERIES_HANDLER_EDIT_OPTION_SERIES_0
Message constant for key in the resource bundle.- See Also:
-
GUI_DATE_SERIES_HANDLER_EDIT_OPTION_SERIES_HELP_ACTIVE_0
Message constant for key in the resource bundle.- See Also:
-
GUI_DATE_SERIES_HANDLER_EDIT_OPTION_INSTANCE_1
Message constant for key in the resource bundle.- See Also:
-
GUI_DATE_SERIES_HANDLER_EDIT_OPTION_INSTANCE_HELP_ACTIVE_1
Message constant for key in the resource bundle.- See Also:
-
GUI_DATE_SERIES_HANDLER_EDIT_OPTION_INSTANCE_HELP_INACTIVE_1
Message constant for key in the resource bundle.- See Also:
-
GUI_DATE_SERIES_HANDLER_DELETE_DIALOG_HEADING_0
Message constant for key in the resource bundle.- See Also:
-
GUI_DATE_SERIES_HANDLER_DELETE_DIALOG_INFO_1
Message constant for key in the resource bundle.- See Also:
-
GUI_DATE_SERIES_HANDLER_DELETE_OPTION_SERIES_0
Message constant for key in the resource bundle.- See Also:
-
GUI_DATE_SERIES_HANDLER_DELETE_OPTION_SERIES_HELP_ACTIVE_0
Message constant for key in the resource bundle.- See Also:
-
GUI_DATE_SERIES_HANDLER_DELETE_OPTION_INSTANCE_1
Message constant for key in the resource bundle.- See Also:
-
GUI_DATE_SERIES_HANDLER_DELETE_OPTION_INSTANCE_HELP_ACTIVE_1
Message constant for key in the resource bundle.- See Also:
-
-
Method Details
-
get
Returns an instance of this localized message accessor.- Returns:
- an instance of this localized message accessor
-
getLocalizedMessage
Returns the String for the given CmsMessageContainer localized to the current user's locale if available or to the default locale else.This method is needed for localization of non-
CmsException
instances that have to be thrown here due to API constraints (javax.servlet.jsp).- Parameters:
container
- A CmsMessageContainer containing the message to localize.cms
- theCmsObject
belonging to the current user (e.g. obtained withCmsFlexController.getCmsObject(ServletRequest)
).- Returns:
- the String for the given CmsMessageContainer localized to the current user's locale if available or to the default locale else.
-
getLocalizedMessage
public static String getLocalizedMessage(CmsMessageContainer container, javax.servlet.jsp.PageContext context) Returns the String for the given CmsMessageContainer localized to the current user's locale if available or to the default locale else.This method is needed for localization of non-
CmsException
instances that have to be thrown here due to API constraints (javax.servlet.jsp).- Parameters:
container
- A CmsMessageContainer containing the message to localize.context
- The page context that is known to any callingTagSupport
instance (memberpageContext
).- Returns:
- the String for the given CmsMessageContainer localized to the current user's locale if available or to the default locale else.
-
getLocalizedMessage
public static String getLocalizedMessage(CmsMessageContainer container, javax.servlet.ServletRequest request) Returns the String for the given CmsMessageContainer localized to the current user's locale if available or to the default locale else.This method allows a static method (
CmsJspTagInfo.infoTagAction(String, javax.servlet.http.HttpServletRequest)
) that has nopageContext
in scope to lookup the locale at request time.- Parameters:
container
- A CmsMessageContainer containing the message to localize.request
- The current request.- Returns:
- the String for the given CmsMessageContainer localized to the current user's locale if available or to the default locale else.
- See Also:
-
getBundleName
Returns the bundle name for this OpenCms package.- Returns:
- the bundle name for this OpenCms package
-