Uses of Class
org.opencms.i18n.CmsMessages

Packages that use CmsMessages

Package	Description
org.opencms.db.log	This package contains the implementation classes for the DB log.
org.opencms.i18n	Classes to handle internalization (i18n) and locale selection in OpenCms.
org.opencms.jsp	The implementation of the OpenCms JSP tag library, with some additional utility classes to help in JSP scriplet code and navigation building.
org.opencms.jsp.util	Utility classes to be used for JSP pages.
org.opencms.main	Provides the main OpenCms "operating system".
org.opencms.relations	Classes to represent and validate the internal and external links/relations of resources in the OpenCms VFS.
org.opencms.report	Classes used to generate the OpenCms reports, which are displayed during publish, import, export etc.
org.opencms.ui	General code for the Vaadin UI
org.opencms.ui.editors.messagebundle	The data bindings and logic for the translator editor.
org.opencms.util	Utility functions for String manipulation and other often used tasks.
org.opencms.widgets	Contains the widget implementations, these are GUI elements used in editors and dialogs of the OpenCms workplace.
org.opencms.workplace	The base classes for the OpenCms Workplace (standard dialog, tab dialog, report based dialog) and the Workplace configuration classes are located here.
org.opencms.workplace.editors.directedit	Used to control the generation of the HTML for the "direct edit" buttons.
org.opencms.xml	Basic XML functionality and utilities used by OpenCms to maintain XML documents and content.
org.opencms.xml.content	Contains functions for structured content storage using XML, commonly called "XML content" in OpenCms.

Uses of CmsMessages in org.opencms.db.log

Methods in org.opencms.db.log with parameters of type CmsMessages

Modifier and Type	Method and Description
java.lang.String	CmsLogEntryType.getLocalizedName(CmsMessages messages) Returns a localized name for the given log entry type.

Uses of CmsMessages in org.opencms.i18n

Subclasses of CmsMessages in org.opencms.i18n

Modifier and Type	Class and Description
class	CmsMultiMessages Provides access to the localized messages for several resource bundles simultaneously.

Methods in org.opencms.i18n that return CmsMessages

Modifier and Type	Method and Description
CmsMessages	A_CmsMessageBundle.getBundle()
CmsMessages	I_CmsMessageBundle.getBundle() Returns the localized message bundle wrapped in this instance initialized with the OpenCms default locale.
CmsMessages	A_CmsMessageBundle.getBundle(java.util.Locale locale)
CmsMessages	I_CmsMessageBundle.getBundle(java.util.Locale locale) Returns the localized message bundle wrapped in this instance initialized with the provided locale.

Methods in org.opencms.i18n that return types with arguments of type CmsMessages

Modifier and Type	Method and Description
java.util.List<CmsMessages>	CmsMultiMessages.getMessages() Returns the list of all individual message objects in this multi message instance.

Methods in org.opencms.i18n with parameters of type CmsMessages

Modifier and Type	Method and Description
void	CmsMultiMessages.addMessages(CmsMessages messages) Adds a messages instance to this multi message bundle.

Method parameters in org.opencms.i18n with type arguments of type CmsMessages

Modifier and Type	Method and Description
void	CmsMultiMessages.addMessages(java.util.List<CmsMessages> messages) Adds a list a messages instances to this multi message bundle.

Uses of CmsMessages in org.opencms.jsp

Methods in org.opencms.jsp that return CmsMessages

Modifier and Type	Method and Description
CmsMessages	CmsJspActionElement.getMessages(java.lang.String bundleName, java.util.Locale locale) Generates an initialized instance of CmsMessages for convenient access to localized resource bundles.
CmsMessages	CmsJspActionElement.getMessages(java.lang.String bundleName, java.lang.String language) Generates an initialized instance of CmsMessages for convenient access to localized resource bundles.
CmsMessages	CmsJspActionElement.getMessages(java.lang.String bundleName, java.lang.String language, java.lang.String defaultLanguage) Generates an initialized instance of CmsMessages for convenient access to localized resource bundles.
CmsMessages	CmsJspActionElement.getMessages(java.lang.String bundleName, java.lang.String language, java.lang.String country, java.lang.String variant, java.lang.String defaultLanguage) Generates an initialized instance of CmsMessages for convenient access to localized resource bundles.

Uses of CmsMessages in org.opencms.jsp.util

Methods in org.opencms.jsp.util that return CmsMessages

Modifier and Type	Method and Description
protected CmsMessages	CmsJspStatusBean.getMessages() Returns the initialized messages object to read localized messages from.

Methods in org.opencms.jsp.util with parameters of type CmsMessages

Modifier and Type	Method and Description
protected void	CmsJspStatusBean.setMessages(CmsMessages messages) Sets the initialized messages object to read localized messages from.

Uses of CmsMessages in org.opencms.main

Methods in org.opencms.main that return CmsMessages

Modifier and Type	Method and Description
CmsMessages	CmsShell.getMessages() Returns the localized messages object for the current user.

Uses of CmsMessages in org.opencms.relations

Methods in org.opencms.relations with parameters of type CmsMessages

Modifier and Type	Method and Description
java.lang.String	CmsRelationType.getLocalizedName(CmsMessages messages) Returns a localized name for the given relation type.

Uses of CmsMessages in org.opencms.report

Methods in org.opencms.report that return CmsMessages

Modifier and Type	Method and Description
protected CmsMessages	A_CmsReport.getMessages() Returns the default report message bundle.

Uses of CmsMessages in org.opencms.ui

Methods in org.opencms.ui that return CmsMessages

Modifier and Type	Method and Description
static CmsMessages	CmsVaadinUtils.getWpMessagesForCurrentLocale() Gets the workplace messages for the current locale.

Methods in org.opencms.ui with parameters of type CmsMessages

Modifier and Type	Method and Description
static void	CmsVaadinUtils.readAndLocalizeDesign(com.vaadin.ui.Component component, CmsMessages messages, java.util.Map<java.lang.String,java.lang.String> macros) Reads the declarative design for a component and localizes it using a messages object.
protected static void	CmsVaadinUtils.readAndLocalizeDesign(com.vaadin.ui.Component component, java.io.InputStream designStream, CmsMessages messages, java.util.Map<java.lang.String,java.lang.String> macros) Reads the given design and resolves the given macros and localizations.

Uses of CmsMessages in org.opencms.ui.editors.messagebundle

Methods in org.opencms.ui.editors.messagebundle with parameters of type CmsMessages

Modifier and Type	Method and Description
CmsMessageBundleEditorModel.ConfigurableMessages	CmsMessageBundleEditorModel.getConfigurableMessages(CmsMessages defaultMessages, java.util.Locale locale) Returns the configured bundle, or the provided default bundle.

Constructors in org.opencms.ui.editors.messagebundle with parameters of type CmsMessages

Constructor and Description
ConfigurableMessages(CmsMessages defaultMessages, java.util.Locale locale, java.lang.String configuredBundle) Default constructor.

Uses of CmsMessages in org.opencms.util

Fields in org.opencms.util declared as CmsMessages

Modifier and Type	Field and Description
protected CmsMessages	CmsMacroResolver.m_messages The messages resource bundle to resolve localized keys with.

Methods in org.opencms.util with parameters of type CmsMessages

Modifier and Type	Method and Description
static java.lang.String	CmsMacroResolver.resolveMacros(java.lang.String input, CmsObject cms, CmsMessages messages) Resolves the macros in the given input using the provided parameters.
CmsMacroResolver	CmsMacroResolver.setMessages(CmsMessages messages) Provides a set of CmsMessages to this macro resolver, required to resolve localized macros.

Uses of CmsMessages in org.opencms.widgets

Methods in org.opencms.widgets that return CmsMessages

Modifier and Type	Method and Description
CmsMessages	A_CmsWidget.CmsDummyWidgetDialog.getMessages()
CmsMessages	I_CmsWidgetDialog.getMessages() Returns a messages object used to render localized keys for the widget dialog.

Methods in org.opencms.widgets with parameters of type CmsMessages

Modifier and Type	Method and Description
protected void	CmsHtmlWidget.addEmbeddedGalleryOptions(JSONObject result, CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale) Adds the configuration for embedded gallery widgets the the JSON object.
static java.lang.String	CmsCalendarWidget.calendarInit(CmsMessages messages, java.lang.String inputFieldId, java.lang.String triggerButtonId, java.lang.String align, boolean singleClick, boolean weekNumbers, boolean mondayFirst, java.lang.String dateStatusFunc, boolean showTime) Generates the HTML to initialize the JavaScript calendar element on the end of a page.
protected JSONObject	CmsAdeImageGalleryWidget.getAdditionalGalleryInfo(CmsObject cms, java.lang.String resource, CmsMessages messages, I_CmsWidgetParameter param)
protected JSONObject	CmsAdeDownloadGalleryWidget.getAdditionalGalleryInfo(CmsObject cms, java.lang.String resource, CmsMessages messages, I_CmsWidgetParameter param)
protected abstract JSONObject	A_CmsAdeGalleryWidget.getAdditionalGalleryInfo(CmsObject cms, java.lang.String resource, CmsMessages messages, I_CmsWidgetParameter param) Returns additional widget information encapsulated in a JSON object.
protected JSONObject	CmsVfsImageWidget.getAdditionalGalleryInfo(CmsObject cms, java.lang.String resource, CmsMessages messages, I_CmsWidgetParameter param)
static long	CmsCalendarWidget.getCalendarDate(CmsMessages messages, java.lang.String dateString, boolean useTime) Creates the time in milliseconds from the given parameter.
static java.lang.String	CmsCalendarWidget.getCalendarLocalizedTime(java.util.Locale locale, CmsMessages messages, long timestamp) Returns the given timestamp as String formatted in a localized pattern.
java.lang.String	CmsSelectGroupWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsPrincipalWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	A_CmsSelectWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsColorpickerWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsPasswordWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	I_CmsADEWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue contentValue, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale) Returns the configuration string for the ADE content editor widget.
java.lang.String	CmsLocalizationWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsHtmlWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsDisplayWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsTypeComboWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsCategoryWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsMultiSelectGroupWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsTextareaWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsGroupWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	A_CmsFormatterWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	A_CmsAdeGalleryWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsSerialDateWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue contentValue, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsLocationPickerWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsOrgUnitWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	A_CmsGalleryWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsCheckboxWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsVfsFileWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsDisplayTypeSelectWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsDependentSelectWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsInputWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsCalendarWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.util.List<java.lang.String>	I_CmsImageWidgetDynamicConfiguration.getFormatValues(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param, java.util.List<CmsSelectWidgetOption> selectFormat, java.util.List<java.lang.String> formatValues) Returns the matching format values for the given format select options.
protected java.util.Map<java.lang.String,java.lang.String>	A_CmsAdeGalleryWidget.getGalleryOpenParams(CmsObject cms, CmsMessages messages, I_CmsWidgetParameter param, java.lang.String resource, long hashId) Returns the required gallery open parameters.
protected java.util.Map<java.lang.String,java.lang.String>	CmsVfsImageWidget.getGalleryOpenParams(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param, java.lang.String resource, long hashId)
protected JSONObject	CmsVfsFileWidget.getJsonConfig(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale) Gets the JSON configuration.
protected JSONObject	A_CmsAdeGalleryWidget.getJSONConfig(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale) Returns the gallery widget configuration as a JSON object.
java.lang.String	I_CmsImageWidgetDynamicConfiguration.getStartup(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param) Returns the required information for the initial image list to load.
java.lang.String	I_CmsGalleryWidgetDynamicConfiguration.getStartup(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param) Returns the required information for the initial item list to load.
java.lang.String	I_CmsImageWidgetDynamicConfiguration.getType(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param) Returns the type of the initial image list to load, either gallery or category.
java.lang.String	I_CmsGalleryWidgetDynamicConfiguration.getType(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param) Returns the type of the initial item list to load, either gallery or category.
protected CmsVfsImageWidgetConfiguration	CmsAdeImageGalleryWidget.getWidgetConfiguration(CmsObject cms, CmsMessages messages, I_CmsWidgetParameter param)
protected CmsGalleryWidgetConfiguration	A_CmsAdeGalleryWidget.getWidgetConfiguration(CmsObject cms, CmsMessages messages, I_CmsWidgetParameter param) Returns the widget configuration.
protected void	CmsVfsImageWidgetConfiguration.init(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param, java.lang.String configuration) Initializes the widget configuration using the given configuration string.
protected void	CmsGalleryWidgetConfiguration.init(CmsObject cms, CmsMessages messages, I_CmsWidgetParameter param, java.lang.String configuration) Initializes the widget configuration using the given configuration string.
protected java.util.List<CmsSelectWidgetOption>	CmsSelectGroupWidget.parseSelectOptions(CmsObject cms, CmsMessages messages, I_CmsWidgetParameter param) Returns the list of configured select options, parsing the configuration String if required.
protected java.util.List<CmsSelectWidgetOption>	CmsMultiSelectGroupWidget.parseSelectOptions(CmsObject cms, CmsMessages messages, I_CmsWidgetParameter param)

Constructors in org.opencms.widgets with parameters of type CmsMessages

Constructor and Description
CmsDummyWidgetDialog(java.util.Locale locale, CmsMessages message) Constructor.
CmsGalleryWidgetConfiguration(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param, java.lang.String configuration) Generates an initialized configuration for the gallery item widget using the given configuration string.
CmsVfsImageWidgetConfiguration(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param, java.lang.String configuration) Generates an initialized configuration for the image widget using the given configuration string.

Uses of CmsMessages in org.opencms.workplace

Subclasses of CmsMessages in org.opencms.workplace

Modifier and Type	Class and Description
class	CmsWorkplaceMessages Provides access to the localized messages for the OpenCms workplace.

Methods in org.opencms.workplace that return CmsMessages

Modifier and Type	Method and Description
CmsMessages	CmsWorkplace.getMessages() Returns the current used message object.

Methods in org.opencms.workplace with parameters of type CmsMessages

Modifier and Type	Method and Description
protected void	CmsWorkplace.addMessages(CmsMessages messages) Auxiliary method for initialization of messages.

Uses of CmsMessages in org.opencms.workplace.editors.directedit

Fields in org.opencms.workplace.editors.directedit declared as CmsMessages

Modifier and Type	Field and Description
protected CmsMessages	A_CmsDirectEditProvider.m_messages Used to access the editor messages.

Uses of CmsMessages in org.opencms.xml

Subclasses of CmsMessages in org.opencms.xml

Modifier and Type	Class and Description
class	CmsXmlMessages The xml messages overwrite some methods of the general CmsMessages class to get keys from an individual configuration file.

Methods in org.opencms.xml that return CmsMessages

Modifier and Type	Method and Description
CmsMessages	CmsXmlMessages.getMessages() Returns the messages.

Methods in org.opencms.xml with parameters of type CmsMessages

Modifier and Type	Method and Description
void	CmsXmlMessages.setMessages(CmsMessages messages) Sets the messages.

Constructors in org.opencms.xml with parameters of type CmsMessages

Constructor and Description
CmsXmlMessages(CmsMessages messages, java.lang.String configurationFileName, java.lang.String pathPrefix, java.util.Locale locale) Constructor, with parameters.

Uses of CmsMessages in org.opencms.xml.content

Methods in org.opencms.xml.content that return CmsMessages

Modifier and Type	Method and Description
CmsMessages	CmsDefaultXmlContentHandler.getMessages(java.util.Locale locale)
CmsMessages	I_CmsXmlContentHandler.getMessages(java.util.Locale locale) Returns the CmsMessages that are used to resolve localized keys for the given locale in this content handler.