org.apache.myfaces.commons.util
Class MessageUtils
java.lang.Object
org.apache.myfaces.commons.util.MessageUtils
public final class MessageUtils
- extends java.lang.Object
Utility class to support multilingual FacesMessages using ResourceBundles.
Standard messages are stored at DEFAULT_BUNDLE
.
The summary of the message is stored at the requested key value. The detail
of the message is stored at <messageId>_detail.
- Version:
- $Revision: 676268 $ $Date: 2008-07-13 02:45:56 -0500 (Sun, 13 Jul 2008) $
- Author:
- Thomas Spiegl (latest modification by $Author: skitching $), Manfred Geiler, Sean Schofield, Stpehan Strittmatter
- See Also:
FacesMessage
,
ResourceBundle
Method Summary |
static void |
addMessage(javax.faces.application.FacesMessage.Severity severity,
java.lang.String messageId,
java.lang.Object[] args)
|
static void |
addMessage(javax.faces.application.FacesMessage.Severity severity,
java.lang.String messageId,
java.lang.Object[] args,
javax.faces.context.FacesContext facesContext)
|
static void |
addMessage(javax.faces.application.FacesMessage.Severity severity,
java.lang.String messageId,
java.lang.Object[] args,
java.lang.String forClientId)
|
static void |
addMessage(javax.faces.application.FacesMessage.Severity severity,
java.lang.String messageId,
java.lang.Object[] args,
java.lang.String forClientId,
javax.faces.context.FacesContext facesContext)
|
static java.util.Locale |
getCurrentLocale()
|
static java.lang.String |
getLabel(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent component)
|
static javax.faces.application.FacesMessage |
getMessage(javax.faces.context.FacesContext context,
java.lang.String messageId)
|
static javax.faces.application.FacesMessage |
getMessage(javax.faces.context.FacesContext context,
java.lang.String messageId,
java.lang.Object[] params)
|
static javax.faces.application.FacesMessage |
getMessage(javax.faces.application.FacesMessage.Severity severity,
java.lang.String messageId,
java.lang.Object arg)
|
static javax.faces.application.FacesMessage |
getMessage(javax.faces.application.FacesMessage.Severity severity,
java.lang.String messageId,
java.lang.Object[] args)
|
static javax.faces.application.FacesMessage |
getMessage(javax.faces.application.FacesMessage.Severity severity,
java.lang.String messageId,
java.lang.Object[] args,
javax.faces.context.FacesContext facesContext)
|
static javax.faces.application.FacesMessage |
getMessage(javax.faces.application.FacesMessage.Severity severity,
java.lang.String bundleBaseName,
java.lang.String messageId,
java.lang.Object[] params)
|
static javax.faces.application.FacesMessage |
getMessage(java.util.Locale locale,
java.lang.String messageId,
java.lang.Object[] params)
|
static javax.faces.application.FacesMessage |
getMessage(java.util.ResourceBundle bundle,
java.lang.String messageId,
java.lang.Object[] params)
|
static javax.faces.application.FacesMessage |
getMessage(java.lang.String bundleBaseName,
java.util.Locale locale,
java.lang.String messageId,
java.lang.Object[] params)
|
static javax.faces.application.FacesMessage |
getMessage(java.lang.String messageId,
java.lang.Object[] params)
|
static javax.faces.application.FacesMessage |
getMessage(java.lang.String bundleBaseName,
java.lang.String messageId,
java.lang.Object[] params)
|
static java.lang.String |
substituteParams(java.util.Locale locale,
java.lang.String msgtext,
java.lang.Object[] params)
Uses MessageFormat and the supplied parameters to fill in the param placeholders in the String. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
getMessage
public static javax.faces.application.FacesMessage getMessage(javax.faces.application.FacesMessage.Severity severity,
java.lang.String messageId,
java.lang.Object arg)
- Parameters:
severity
- serverity of messagemessageId
- id of messagearg
- arument of message
- Returns:
- generated FacesMessage
getMessage
public static javax.faces.application.FacesMessage getMessage(javax.faces.application.FacesMessage.Severity severity,
java.lang.String messageId,
java.lang.Object[] args)
- Parameters:
severity
- serverity of messagemessageId
- id of messageargs
- aruments of message
- Returns:
- generated FacesMessage
getMessage
public static javax.faces.application.FacesMessage getMessage(javax.faces.application.FacesMessage.Severity severity,
java.lang.String messageId,
java.lang.Object[] args,
javax.faces.context.FacesContext facesContext)
addMessage
public static void addMessage(javax.faces.application.FacesMessage.Severity severity,
java.lang.String messageId,
java.lang.Object[] args)
addMessage
public static void addMessage(javax.faces.application.FacesMessage.Severity severity,
java.lang.String messageId,
java.lang.Object[] args,
javax.faces.context.FacesContext facesContext)
addMessage
public static void addMessage(javax.faces.application.FacesMessage.Severity severity,
java.lang.String messageId,
java.lang.Object[] args,
java.lang.String forClientId)
addMessage
public static void addMessage(javax.faces.application.FacesMessage.Severity severity,
java.lang.String messageId,
java.lang.Object[] args,
java.lang.String forClientId,
javax.faces.context.FacesContext facesContext)
substituteParams
public static java.lang.String substituteParams(java.util.Locale locale,
java.lang.String msgtext,
java.lang.Object[] params)
- Uses
MessageFormat
and the supplied parameters to fill in the param placeholders in the String.
- Parameters:
locale
- The Locale
to use when performing the substitution.msgtext
- The original parameterized String.params
- The params to fill in the String with.
- Returns:
- The updated String.
getMessage
public static javax.faces.application.FacesMessage getMessage(java.lang.String messageId,
java.lang.Object[] params)
getMessage
public static javax.faces.application.FacesMessage getMessage(java.util.Locale locale,
java.lang.String messageId,
java.lang.Object[] params)
getMessage
public static javax.faces.application.FacesMessage getMessage(java.lang.String bundleBaseName,
java.lang.String messageId,
java.lang.Object[] params)
- Parameters:
bundleBaseName
- baseName of ResourceBundle to load localized messagesmessageId
- id of messageparams
- parameters to set at localized message
- Returns:
- generated FacesMessage
getCurrentLocale
public static java.util.Locale getCurrentLocale()
- Returns:
- currently applicable Locale for this request.
getMessage
public static javax.faces.application.FacesMessage getMessage(javax.faces.application.FacesMessage.Severity severity,
java.lang.String bundleBaseName,
java.lang.String messageId,
java.lang.Object[] params)
- Parameters:
severity
- severity of messagebundleBaseName
- baseName of ResourceBundle to load localized messagesmessageId
- id of messageparams
- parameters to set at localized message
- Returns:
- generated FacesMessage
getMessage
public static javax.faces.application.FacesMessage getMessage(java.lang.String bundleBaseName,
java.util.Locale locale,
java.lang.String messageId,
java.lang.Object[] params)
- Parameters:
bundleBaseName
- baseName of ResourceBundle to load localized messageslocale
- current localemessageId
- id of messageparams
- parameters to set at localized message
- Returns:
- generated FacesMessage
getMessage
public static javax.faces.application.FacesMessage getMessage(java.util.ResourceBundle bundle,
java.lang.String messageId,
java.lang.Object[] params)
- Parameters:
bundle
- ResourceBundle to load localized messagesmessageId
- id of messageparams
- parameters to set at localized message
- Returns:
- generated FacesMessage
getMessage
public static javax.faces.application.FacesMessage getMessage(javax.faces.context.FacesContext context,
java.lang.String messageId)
- Parameters:
context
- messageId
-
- Returns:
- generated FacesMessage
getMessage
public static javax.faces.application.FacesMessage getMessage(javax.faces.context.FacesContext context,
java.lang.String messageId,
java.lang.Object[] params)
- Parameters:
context
- messageId
- params
-
- Returns:
- generated FacesMessage
getLabel
public static java.lang.String getLabel(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent component)
Copyright © 2007-2008 The Apache Software Foundation. All Rights Reserved.