com.liferay.faces.util.context
Interface FacesContextHelper

All Known Implementing Classes:

ExtFacesContext, ExtFacesContextImpl, FacesContextHelperImpl

public interface FacesContextHelper

Author:

Neil Griffin

Method Summary

void	addComponentErrorMessage(String clientId, String messageId) Adds the specified key as a message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_ERROR.
void	addComponentErrorMessage(String clientId, String messageId, Object... arguments) Adds the specified key as a global message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_ERROR and substitutes the specified argument(s) for the tokens in the specified key.
void	addComponentErrorMessage(String clientId, String messageId, Object argument) Adds the specified key as a global message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_ERROR and substitutes the specified argument for the tokens in the specified key.
void	addComponentInfoMessage(String clientId, String messageId) Adds the specified key as a message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_INFO.
void	addComponentInfoMessage(String clientId, String messageId, Object... arguments) Adds the specified key as a global message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_INFO and substitutes the specified argument(s) for the tokens in the specified key.
void	addComponentInfoMessage(String clientId, String messageId, Object argument) Adds the specified key as a global message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_INFO and substitutes the specified argument for the tokens in the specified key.
void	addGlobalErrorMessage(String messageId) Adds the specified key as a global message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_ERROR.
void	addGlobalErrorMessage(String messageId, Object... arguments) Adds the specified key as a global message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_ERROR and substitutes the specified argument(s) for the tokens in the specified key.
void	addGlobalErrorMessage(String messageId, Object argument) Adds the specified key as a global message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_ERROR and substitutes the specified argument for the tokens in the specified key.
void	addGlobalInfoMessage(String messageId) Adds the specified key as a global message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_INFO.
void	addGlobalInfoMessage(String messageId, Object... arguments) Adds the specified key as a global message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_INFO and substitutes the specified argument(s) for the tokens in the specified key.
void	addGlobalInfoMessage(String messageId, Object argument) Adds the specified key as a global message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_INFO and substitutes the specified argument for the tokens in the specified key.
void	addGlobalSuccessInfoMessage() Adds a global information message to the current FacesContext with "your-request-processed-successfully" key as the messageId.
void	addGlobalUnexpectedErrorMessage() Adds a global error message to the current FacesContext with "an-unexpected-error-occurred" key as the messageId.
void	addMessage(String clientId, javax.faces.application.FacesMessage.Severity severity, String messageId) Adds the specified key as a message associated with the UIComponent that has the specified clientId.
void	addMessage(String clientId, javax.faces.application.FacesMessage.Severity severity, String messageId, Object... arguments) Adds the specified key as a message associated with the UIComponent that has the specified clientId.
void	addMessage(String clientId, javax.faces.application.FacesMessage.Severity severity, String messageId, Object argument) Adds the specified key as a message associated with the UIComponent that has the specified clientId.
javax.faces.context.FacesContext	getFacesContext() Gets the underlying/wrapped FacesContext ThreadLocal singleton instance.
Locale	getLocale() Returns the locale of the viewRoot of the current JSF FacesContext
String	getMessage(Locale locale, String messageId) Returns the message associated with the specified messageId by delegating to the FacesMessageFactory, according to the specified locale.
String	getMessage(Locale locale, String messageId, Object... arguments) Returns the message associated with the specified messageId by delegating to the FacesMessageFactory, according to the specified locale and arguments that are to be substituted.
String	getMessage(String messageId) Returns the message associated with the specified messageId by delegating to the FacesMessageFactory, according to the current locale.
String	getMessage(String messageId, Object... arguments) Returns the message associated with the specified messageId by delegating to the FacesMessageFactory, according to the current locale and arguments that are to be substituted.
String	getNamespace() Delegates to the underlying ExternalContext.encodeNamespace(String) method in order to get the application namespace.
javax.faces.component.UIForm	getParentForm(javax.faces.component.UIComponent uiComponent) Return the parent form of the given component.
Object	getRequestAttribute(String name) Returns the value of the request attribute associated with the specified name.
String	getRequestContextPath()
String	getRequestParameter(String name) Retrieves the specified parameter passed as part of the request
boolean	getRequestParameterAsBool(String name, boolean defaultValue) Retrieves the specified parameter passed as part of the request as a boolean.
int	getRequestParameterAsInt(String name, int defaultValue) Retrieves the specified parameter passed as part of the request as an integer.
long	getRequestParameterAsLong(String name, long defaultValue) Retrieves the specified parameter passed as part of the request as an integer.
String	getRequestParameterFromMap(String name) Retrieves the specified parameter from the ExternalContext's request parameter map.
Map<String,String>	getRequestParameterMap() Returns the map of request parameters from the ExternalContext.
String	getRequestQueryString() Retrieves the value of the original "javax.servlet.forward.query_string" request attribute.
String	getRequestQueryStringParameter(String name) Retrieves the value of the specified parameter name from the original "javax.servlet.forward.query_string" request attribute.
Object	getSession(boolean create) Returns the session object associated with the current FacesContext.
Object	getSessionAttribute(String name) Returns the value of the session attribute associated with the specified name.
javax.faces.component.UIComponent	matchComponentInHierarchy(javax.faces.component.UIComponent parent, String partialClientId) Traverses the component tree starting at the specified UIComponent parent and returns the first UIComponent child that contains the specified partialClientId.
javax.faces.component.UIComponent	matchComponentInViewRoot(String partialClientId) Traverses the component tree associated with the UIViewRoot of this FacesContext and returns the first UIComponent child that contains the specified partialClientId.
void	navigate(String fromAction, String outcome) Sets the current JSF navigation to the specified outcome.
void	navigateTo(String outcome) Sets the current JSF navigation to the specified outcome.
void	recreateComponentTree() Delete the whole component tree.
void	registerPhaseListener(javax.faces.event.PhaseListener phaseListener) Register a PhaseListener programatically (instead of in the faces-config.xml).
void	removeChildrenFromComponentTree(String clientId) clear component tree since input fields will not be refreshed.
void	removeMessages(String clientId) Removes all FacesMessage instances from this FacesContext that are associated with the specified clientId.
void	removeMessagesForImmediateComponents() Removes all FacesMessage instances from this FacesContext that are associated with components whose immediate attribute is true.The typical use case for this method is when seemingly bogus messages are added to the FacesContext on components whose immediate attribute is true.
void	removeMessagesForImmediateComponents(javax.faces.component.UIComponent uiComponent) Removes all FacesMessage instances from this FacesContext that are associated with components whose immediate attribute is true.The typical use case for this method is when seemingly bogus messages are added to the FacesContext on components whose immediate attribute is true.
void	removeParentFormFromComponentTree(javax.faces.component.UIComponent uiComponent) Delete the component subtree of a given component.
void	resetView() Causes the current view's component tree to be discarded and re-rendered.
void	resetView(boolean renderResponse) Causes the current view's component tree to be discarded and (optionally) re-rendered.
Object	resolveExpression(String elExpression) Returns the object associated with the specified EL expression.
void	setRequestAttribute(String name, Object value) Sets the value of the a request attribute using the specified name and value.
void	setSessionAttribute(String name, Object value) Sets the value of the a session attribute using the specified name and value.

Method Detail

addComponentErrorMessage

void addComponentErrorMessage(String clientId,
                              String messageId)

Adds the specified key as a message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_ERROR. The message will not be global, rather it will be associated with the javax.faces.component.UIComponent that is associated with the specified clientId.

addComponentErrorMessage

void addComponentErrorMessage(String clientId,
                              String messageId,
                              Object argument)

Adds the specified key as a global message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_ERROR and substitutes the specified argument for the tokens in the specified key. The message will not be global, rather it will be associated with the javax.faces.component.UIComponent that is associated with the specified clientId.

addComponentErrorMessage

void addComponentErrorMessage(String clientId,
                              String messageId,
                              Object... arguments)

Adds the specified key as a global message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_ERROR and substitutes the specified argument(s) for the tokens in the specified key. The message will not be global, rather it will be associated with the javax.faces.component.UIComponent that is associated with the specified clientId.

addComponentInfoMessage

void addComponentInfoMessage(String clientId,
                             String messageId)

Adds the specified key as a message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_INFO. The message will not be global, rather it will be associated with the javax.faces.component.UIComponent that is associated with the specified clientId.

addComponentInfoMessage

void addComponentInfoMessage(String clientId,
                             String messageId,
                             Object argument)

Adds the specified key as a global message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_INFO and substitutes the specified argument for the tokens in the specified key. The message will not be global, rather it will be associated with the javax.faces.component.UIComponent that is associated with the specified clientId.

addComponentInfoMessage

void addComponentInfoMessage(String clientId,
                             String messageId,
                             Object... arguments)

Adds the specified key as a global message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_INFO and substitutes the specified argument(s) for the tokens in the specified key. The message will not be global, rather it will be associated with the javax.faces.component.UIComponent that is associated with the specified clientId.

addGlobalErrorMessage

void addGlobalErrorMessage(String messageId)

Adds the specified key as a global message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_ERROR.

addGlobalErrorMessage

void addGlobalErrorMessage(String messageId,
                           Object argument)

Adds the specified key as a global message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_ERROR and substitutes the specified argument for the tokens in the specified key.

addGlobalErrorMessage

void addGlobalErrorMessage(String messageId,
                           Object... arguments)

Adds the specified key as a global message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_ERROR and substitutes the specified argument(s) for the tokens in the specified key.

addGlobalInfoMessage

void addGlobalInfoMessage(String messageId)

Adds the specified key as a global message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_INFO.

addGlobalInfoMessage

void addGlobalInfoMessage(String messageId,
                          Object argument)

Adds the specified key as a global message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_INFO and substitutes the specified argument for the tokens in the specified key.

addGlobalInfoMessage

void addGlobalInfoMessage(String messageId,
                          Object... arguments)

Adds the specified key as a global message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_INFO and substitutes the specified argument(s) for the tokens in the specified key.

addGlobalSuccessInfoMessage

void addGlobalSuccessInfoMessage()

Adds a global information message to the current FacesContext with "your-request-processed-successfully" key as the messageId.

addGlobalUnexpectedErrorMessage

void addGlobalUnexpectedErrorMessage()

Adds a global error message to the current FacesContext with "an-unexpected-error-occurred" key as the messageId.

addMessage

void addMessage(String clientId,
                javax.faces.application.FacesMessage.Severity severity,
                String messageId)

Adds the specified key as a message associated with the UIComponent that has the specified clientId. Specify clientId=null for global messages.

addMessage

void addMessage(String clientId,
                javax.faces.application.FacesMessage.Severity severity,
                String messageId,
                Object argument)

Adds the specified key as a message associated with the UIComponent that has the specified clientId. Specify clientId=null for global messages.

addMessage

void addMessage(String clientId,
                javax.faces.application.FacesMessage.Severity severity,
                String messageId,
                Object... arguments)

Adds the specified key as a message associated with the UIComponent that has the specified clientId. Specify clientId=null for global messages.

matchComponentInHierarchy

javax.faces.component.UIComponent matchComponentInHierarchy(javax.faces.component.UIComponent parent,
                                                            String partialClientId)

Traverses the component tree starting at the specified UIComponent parent and returns the first UIComponent child that contains the specified partialClientId.

matchComponentInViewRoot

javax.faces.component.UIComponent matchComponentInViewRoot(String partialClientId)

Traverses the component tree associated with the UIViewRoot of this FacesContext and returns the first UIComponent child that contains the specified partialClientId.

navigate

void navigate(String fromAction,
              String outcome)

Sets the current JSF navigation to the specified outcome.

Parameters:

fromAction - The "from action" as specified in a JSF navigation rule. Can be null to if no action is specified in the rule.

outcome - The "from outcome" as specified in a JSF navigation rule

navigateTo

void navigateTo(String outcome)

Sets the current JSF navigation to the specified outcome.

Parameters:

outcome - The "from outcome" as specified in a JSF navigation rule

recreateComponentTree

void recreateComponentTree()

Delete the whole component tree. This causes the tree to be rebuilt the next time it is accessed. This addresses the problem that immediate actions cannot change the values of input components. To clear these values, use this method.

registerPhaseListener

void registerPhaseListener(javax.faces.event.PhaseListener phaseListener)

Register a PhaseListener programatically (instead of in the faces-config.xml). Such a PhaseListener can therefore be controlled by spring and use dependency injection, which is not possible otherwise.

Parameters:

phaseListener -

removeChildrenFromComponentTree

void removeChildrenFromComponentTree(String clientId)

clear component tree since input fields will not be refreshed. See ClearInputComponents for more information.

Parameters:

clientId - all children of the component with this id are cleared.

removeMessages

void removeMessages(String clientId)

Removes all FacesMessage instances from this FacesContext that are associated with the specified clientId.

removeMessagesForImmediateComponents

void removeMessagesForImmediateComponents()

Removes all FacesMessage instances from this FacesContext that are associated with components whose immediate attribute is true.The typical use case for this method is when seemingly bogus messages are added to the FacesContext on components whose immediate attribute is true. This happens because UIInput.processDecodes(javax.faces.context.FacesContext) calls validate() if the the immediate attribute is true.

removeMessagesForImmediateComponents

void removeMessagesForImmediateComponents(javax.faces.component.UIComponent uiComponent)

Removes all FacesMessage instances from this FacesContext that are associated with components whose immediate attribute is true.The typical use case for this method is when seemingly bogus messages are added to the FacesContext on components whose immediate attribute is true. This happens because UIInput.processDecodes(javax.faces.context.FacesContext) calls validate() if the the immediate attribute is true.

removeParentFormFromComponentTree

void removeParentFormFromComponentTree(javax.faces.component.UIComponent uiComponent)

Delete the component subtree of a given component. This causes the subtree to be rebuilt the next time it is accessed. This addresses the problem that immediate actions cannot change the values of input components. To clear these values, use this method.

Parameters:

uiComponent -

resetView

void resetView()

Causes the current view's component tree to be discarded and re-rendered.

See Also:

resetView(boolean)

resetView

void resetView(boolean renderResponse)

Causes the current view's component tree to be discarded and (optionally) re-rendered. This is useful whenever an action causes navigation back to the current view, but the data in the backing bean(s) has changed substantially. The view is rendered as if the user is visiting for the first time.

Parameters:

renderResponse - causes the response to be rendered immediately if true.

See Also:

ClearInputComponents

resolveExpression

Object resolveExpression(String elExpression)

Returns the object associated with the specified EL expression.

getFacesContext

javax.faces.context.FacesContext getFacesContext()

Gets the underlying/wrapped FacesContext ThreadLocal singleton instance.

getLocale

Locale getLocale()

Returns the locale of the viewRoot of the current JSF FacesContext

getMessage

String getMessage(String messageId)

Returns the message associated with the specified messageId by delegating to the FacesMessageFactory, according to the current locale.

getMessage

String getMessage(String messageId,
                  Object... arguments)

Returns the message associated with the specified messageId by delegating to the FacesMessageFactory, according to the current locale and arguments that are to be substituted.

getMessage

String getMessage(Locale locale,
                  String messageId)

Returns the message associated with the specified messageId by delegating to the FacesMessageFactory, according to the specified locale.

getMessage

String getMessage(Locale locale,
                  String messageId,
                  Object... arguments)

Returns the message associated with the specified messageId by delegating to the FacesMessageFactory, according to the specified locale and arguments that are to be substituted.

getNamespace

String getNamespace()

Delegates to the underlying ExternalContext.encodeNamespace(String) method in order to get the application namespace.

getParentForm

javax.faces.component.UIForm getParentForm(javax.faces.component.UIComponent uiComponent)

Return the parent form of the given component.

Parameters:

uiComponent -

Returns:

the parent form or null if no parent form is found.

getRequestAttribute

Object getRequestAttribute(String name)

Returns the value of the request attribute associated with the specified name.

setRequestAttribute

void setRequestAttribute(String name,
                         Object value)

Sets the value of the a request attribute using the specified name and value.

getRequestContextPath

String getRequestContextPath()

Returns:

the request context path. FacesContext.getExternalContext() ExternalContext.getRequestContextPath()

getRequestParameter

String getRequestParameter(String name)

Retrieves the specified parameter passed as part of the request

getRequestParameterAsBool

boolean getRequestParameterAsBool(String name,
                                  boolean defaultValue)

Retrieves the specified parameter passed as part of the request as a boolean. The values "yes", "true", "y", and "1" are accetable values for "TRUE".

getRequestParameterAsInt

int getRequestParameterAsInt(String name,
                             int defaultValue)

Retrieves the specified parameter passed as part of the request as an integer.

getRequestParameterAsLong

long getRequestParameterAsLong(String name,
                               long defaultValue)

Retrieves the specified parameter passed as part of the request as an integer.

getRequestParameterFromMap

String getRequestParameterFromMap(String name)

Retrieves the specified parameter from the ExternalContext's request parameter map.

getRequestParameterMap

Map<String,String> getRequestParameterMap()

Returns the map of request parameters from the ExternalContext.

See Also:

ExternalContext.getRequestParameterMap()

getRequestQueryString

String getRequestQueryString()

Retrieves the value of the original "javax.servlet.forward.query_string" request attribute.

getRequestQueryStringParameter

String getRequestQueryStringParameter(String name)

Retrieves the value of the specified parameter name from the original "javax.servlet.forward.query_string" request attribute.

getSession

Object getSession(boolean create)

Returns the session object associated with the current FacesContext.

Parameters:

create - Flag indicating whether or not a session should be created if it doesn't yet exist.

getSessionAttribute

Object getSessionAttribute(String name)

Returns the value of the session attribute associated with the specified name.

setSessionAttribute

void setSessionAttribute(String name,
                         Object value)

Sets the value of the a session attribute using the specified name and value.