com.liferay.faces.util.context

Class FacesContextHelperWrapper

java.lang.Object

com.liferay.faces.util.context.FacesContextHelperWrapper

All Implemented Interfaces:

FacesContextHelper, javax.faces.FacesWrapper<FacesContextHelper>

@ConsumerType
public abstract class FacesContextHelperWrapper
extends Object
implements FacesContextHelper, javax.faces.FacesWrapper<FacesContextHelper>

Author:

Neil Griffin

Constructor Summary

Constructors

Constructor and Description
FacesContextHelperWrapper()

Method Summary

Modifier and Type	Method and Description
void	addComponentErrorMessage(javax.faces.context.FacesContext facesContext, String clientId, String messageId) Adds the specified key as a message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_ERROR.
void	addComponentErrorMessage(javax.faces.context.FacesContext facesContext, 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) 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	addComponentInfoMessage(javax.faces.context.FacesContext facesContext, String clientId, String messageId) Adds the specified key as a message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_INFO.
void	addComponentInfoMessage(javax.faces.context.FacesContext facesContext, 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) 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	addGlobalErrorMessage(javax.faces.context.FacesContext facesContext, String messageId) Adds the specified key as a global message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_ERROR.
void	addGlobalErrorMessage(javax.faces.context.FacesContext facesContext, 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) 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	addGlobalInfoMessage(javax.faces.context.FacesContext facesContext, String messageId) Adds the specified key as a global message to the FacesContext with severity javax.faces.application.FacesMessage.SEVERITY_INFO.
void	addGlobalInfoMessage(javax.faces.context.FacesContext facesContext, 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) 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	addGlobalSuccessInfoMessage() Adds a global information message to the current FacesContext with "your-request-processed-successfully" key as the messageId.
void	addGlobalSuccessInfoMessage(javax.faces.context.FacesContext facesContext) 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	addGlobalUnexpectedErrorMessage(javax.faces.context.FacesContext facesContext) Adds a global error message to the current FacesContext with "an-unexpected-error-occurred" key as the messageId.
void	addMessage(javax.faces.context.FacesContext facesContext, 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(javax.faces.context.FacesContext facesContext, 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) 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	addScript(javax.faces.context.FacesContext facesContext, Script script) Adds the specified Script to the list of scripts that are to be executed on the client.
void	addScript(javax.faces.context.FacesContext facesContext, String scriptString) Adds the specified script to the list of scripts that are to be executed on the client.
void	addScript(Script script) Adds the specified Script to the list of scripts that are to be executed on the client.
void	addScript(String scriptString) Adds the specified script to the list of scripts that are to be executed on the client.
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
Locale	getLocale(javax.faces.context.FacesContext facesContext) Returns the locale of the viewRoot of the current JSF FacesContext
String	getMessage(javax.faces.context.FacesContext facesContext, Locale locale, String messageId) Returns the message associated with the specified messageId by delegating to the FacesMessageFactory, according to the specified locale.
String	getMessage(javax.faces.context.FacesContext facesContext, 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(javax.faces.context.FacesContext facesContext, String messageId) Returns the message associated with the specified messageId by delegating to the FacesMessageFactory, according to the current locale.
String	getMessage(javax.faces.context.FacesContext facesContext, 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	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.
String	getNamespace(javax.faces.context.FacesContext facesContext) 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) Returns the parent form of the given component or null if no parent form is found.
Object	getRequestAttribute(javax.faces.context.FacesContext facesContext, String name) Returns the value of the request attribute associated with the specified name.
Object	getRequestAttribute(String name) Returns the value of the request attribute associated with the specified name.
String	getRequestContextPath() Returns The request context path.
String	getRequestContextPath(javax.faces.context.FacesContext facesContext) Returns The request context path.
String	getRequestParameter(javax.faces.context.FacesContext facesContext, String name) Retrieves the specified parameter passed as part of the request
String	getRequestParameter(String name) Retrieves the specified parameter passed as part of the request
boolean	getRequestParameterAsBool(javax.faces.context.FacesContext facesContext, String name, boolean defaultValue) Retrieves the specified parameter passed as part of the request as a boolean.
boolean	getRequestParameterAsBool(String name, boolean defaultValue) Retrieves the specified parameter passed as part of the request as a boolean.
int	getRequestParameterAsInt(javax.faces.context.FacesContext facesContext, String name, int defaultValue) Retrieves the specified parameter passed as part of the request as an integer.
int	getRequestParameterAsInt(String name, int defaultValue) Retrieves the specified parameter passed as part of the request as an integer.
long	getRequestParameterAsLong(javax.faces.context.FacesContext facesContext, String name, long 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(javax.faces.context.FacesContext facesContext, String name) Retrieves the specified parameter from the ExternalContext's request parameter map.
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.
Map<String,String>	getRequestParameterMap(javax.faces.context.FacesContext facesContext) 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	getRequestQueryString(javax.faces.context.FacesContext facesContext) Retrieves the value of the original "javax.servlet.forward.query_string" request attribute.
String	getRequestQueryStringParameter(javax.faces.context.FacesContext facesContext, String name) Retrieves the value of the specified parameter name from 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.
List<Script>	getScripts() Returns an immutable list of scripts that were added via the FacesContextHelper.addScript(FacesContext,Script) or FacesContextHelper.addScript(FacesContext,String) method.
List<Script>	getScripts(javax.faces.context.FacesContext facesContext) Returns an immutable list of scripts that were added via the FacesContextHelper.addScript(FacesContext,Script) or FacesContextHelper.addScript(FacesContext,String) method.
Object	getSession(boolean create) Returns the session object associated with the current FacesContext.
Object	getSession(javax.faces.context.FacesContext facesContext, boolean create) Returns the session object associated with the current FacesContext.
Object	getSessionAttribute(javax.faces.context.FacesContext facesContext, String name) Returns the value of the session attribute associated with the specified name.
Object	getSessionAttribute(String name) Returns the value of the session attribute associated with the specified name.
abstract FacesContextHelper	getWrapped()
javax.faces.component.UIComponent	matchComponentInHierarchy(javax.faces.context.FacesContext facesContext, 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	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(javax.faces.context.FacesContext facesContext, String partialClientId) Traverses the component tree associated with the UIViewRoot of this FacesContext 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(javax.faces.context.FacesContext facesContext, String fromAction, String outcome) Sets the current JSF navigation to the specified outcome.
void	navigate(String fromAction, String outcome) Sets the current JSF navigation to the specified outcome.
void	navigateTo(javax.faces.context.FacesContext facesContext, 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	recreateComponentTree(javax.faces.context.FacesContext facesContext) 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(javax.faces.context.FacesContext facesContext, String clientId) clear component tree since input fields will not be refreshed.
void	removeChildrenFromComponentTree(String clientId) clear component tree since input fields will not be refreshed.
void	removeMessages(javax.faces.context.FacesContext facesContext, String clientId) Removes all FacesMessage instances from this FacesContext that are associated with the specified clientId.
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.context.FacesContext facesContext) 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.context.FacesContext facesContext, 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	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.
void	resetView(javax.faces.context.FacesContext facesContext) Causes the current view's component tree to be discarded and re-rendered.
void	resetView(javax.faces.context.FacesContext facesContext, boolean renderResponse) Causes the current view's component tree to be discarded and (optionally) re-rendered.
Object	resolveExpression(javax.faces.context.FacesContext facesContext, String elExpression) Returns the object associated with the specified EL expression.
Object	resolveExpression(String elExpression) Returns the object associated with the specified EL expression.
void	setRequestAttribute(javax.faces.context.FacesContext facesContext, String name, Object value) Sets the value of the a request attribute using the specified name and value.
void	setRequestAttribute(String name, Object value) Sets the value of the a request attribute using the specified name and value.
void	setSessionAttribute(javax.faces.context.FacesContext facesContext, String name, Object value) Sets the value of the a session 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FacesContextHelperWrapper

public FacesContextHelperWrapper()

Method Detail

getWrapped

public abstract FacesContextHelper getWrapped()

Specified by:

getWrapped in interface javax.faces.FacesWrapper<FacesContextHelper>

addComponentErrorMessage

public void addComponentErrorMessage(String clientId,
                                     String messageId)

Description copied from interface: FacesContextHelper

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.

Specified by:

addComponentErrorMessage in interface FacesContextHelper

addComponentErrorMessage

public void addComponentErrorMessage(javax.faces.context.FacesContext facesContext,
                                     String clientId,
                                     String messageId)

Description copied from interface: FacesContextHelper

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.

Specified by:

addComponentErrorMessage in interface FacesContextHelper

addComponentErrorMessage

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

Description copied from interface: FacesContextHelper

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.

Specified by:

addComponentErrorMessage in interface FacesContextHelper

addComponentErrorMessage

public void addComponentErrorMessage(javax.faces.context.FacesContext facesContext,
                                     String clientId,
                                     String messageId,
                                     Object... arguments)

Description copied from interface: FacesContextHelper

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.

Specified by:

addComponentErrorMessage in interface FacesContextHelper

addComponentInfoMessage

public void addComponentInfoMessage(String clientId,
                                    String messageId)

Description copied from interface: FacesContextHelper

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.

Specified by:

addComponentInfoMessage in interface FacesContextHelper

addComponentInfoMessage

public void addComponentInfoMessage(javax.faces.context.FacesContext facesContext,
                                    String clientId,
                                    String messageId)

Description copied from interface: FacesContextHelper

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.

Specified by:

addComponentInfoMessage in interface FacesContextHelper

addComponentInfoMessage

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

Description copied from interface: FacesContextHelper

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.

Specified by:

addComponentInfoMessage in interface FacesContextHelper

addComponentInfoMessage

public void addComponentInfoMessage(javax.faces.context.FacesContext facesContext,
                                    String clientId,
                                    String messageId,
                                    Object... arguments)

Description copied from interface: FacesContextHelper

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.

Specified by:

addComponentInfoMessage in interface FacesContextHelper

addGlobalErrorMessage

public void addGlobalErrorMessage(String messageId)

Description copied from interface: FacesContextHelper

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

Specified by:

addGlobalErrorMessage in interface FacesContextHelper

addGlobalErrorMessage

public void addGlobalErrorMessage(javax.faces.context.FacesContext facesContext,
                                  String messageId)

Description copied from interface: FacesContextHelper

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

Specified by:

addGlobalErrorMessage in interface FacesContextHelper

addGlobalErrorMessage

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

Description copied from interface: FacesContextHelper

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.

Specified by:

addGlobalErrorMessage in interface FacesContextHelper

addGlobalErrorMessage

public void addGlobalErrorMessage(javax.faces.context.FacesContext facesContext,
                                  String messageId,
                                  Object... arguments)

Description copied from interface: FacesContextHelper

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.

Specified by:

addGlobalErrorMessage in interface FacesContextHelper

addGlobalInfoMessage

public void addGlobalInfoMessage(String messageId)

Description copied from interface: FacesContextHelper

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

Specified by:

addGlobalInfoMessage in interface FacesContextHelper

addGlobalInfoMessage

public void addGlobalInfoMessage(javax.faces.context.FacesContext facesContext,
                                 String messageId)

Description copied from interface: FacesContextHelper

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

Specified by:

addGlobalInfoMessage in interface FacesContextHelper

addGlobalInfoMessage

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

Description copied from interface: FacesContextHelper

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.

Specified by:

addGlobalInfoMessage in interface FacesContextHelper

addGlobalInfoMessage

public void addGlobalInfoMessage(javax.faces.context.FacesContext facesContext,
                                 String messageId,
                                 Object... arguments)

Description copied from interface: FacesContextHelper

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.

Specified by:

addGlobalInfoMessage in interface FacesContextHelper

addGlobalSuccessInfoMessage

public void addGlobalSuccessInfoMessage()

Description copied from interface: FacesContextHelper

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

Specified by:

addGlobalSuccessInfoMessage in interface FacesContextHelper

addGlobalSuccessInfoMessage

public void addGlobalSuccessInfoMessage(javax.faces.context.FacesContext facesContext)

Description copied from interface: FacesContextHelper

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

Specified by:

addGlobalSuccessInfoMessage in interface FacesContextHelper

addGlobalUnexpectedErrorMessage

public void addGlobalUnexpectedErrorMessage()

Description copied from interface: FacesContextHelper

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

Specified by:

addGlobalUnexpectedErrorMessage in interface FacesContextHelper

addGlobalUnexpectedErrorMessage

public void addGlobalUnexpectedErrorMessage(javax.faces.context.FacesContext facesContext)

Description copied from interface: FacesContextHelper

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

Specified by:

addGlobalUnexpectedErrorMessage in interface FacesContextHelper

addMessage

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

Description copied from interface: FacesContextHelper

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

Specified by:

addMessage in interface FacesContextHelper

addMessage

public void addMessage(javax.faces.context.FacesContext facesContext,
                       String clientId,
                       javax.faces.application.FacesMessage.Severity severity,
                       String messageId)

Description copied from interface: FacesContextHelper

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

Specified by:

addMessage in interface FacesContextHelper

addMessage

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

Description copied from interface: FacesContextHelper

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

Specified by:

addMessage in interface FacesContextHelper

addMessage

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

Description copied from interface: FacesContextHelper

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

Specified by:

addMessage in interface FacesContextHelper

addScript

public void addScript(Script script)

Description copied from interface: FacesContextHelper

Adds the specified Script to the list of scripts that are to be executed on the client.

Specified by:

addScript in interface FacesContextHelper

Parameters:

script - The script that is to be added.

addScript

public void addScript(String scriptString)

Description copied from interface: FacesContextHelper

Adds the specified script to the list of scripts that are to be executed on the client.

Specified by:

addScript in interface FacesContextHelper

Parameters:

scriptString - The script that is to be added.

addScript

public void addScript(javax.faces.context.FacesContext facesContext,
                      Script script)

Description copied from interface: FacesContextHelper

Adds the specified Script to the list of scripts that are to be executed on the client.

Specified by:

addScript in interface FacesContextHelper

Parameters:

facesContext - The current faces context.

script - The script that is to be added.

addScript

public void addScript(javax.faces.context.FacesContext facesContext,
                      String scriptString)

Description copied from interface: FacesContextHelper

Adds the specified script to the list of scripts that are to be executed on the client.

Specified by:

addScript in interface FacesContextHelper

Parameters:

facesContext - The current faces context.

scriptString - The script that is to be added.

getFacesContext

public javax.faces.context.FacesContext getFacesContext()

Description copied from interface: FacesContextHelper

Gets the underlying/wrapped FacesContext ThreadLocal singleton instance.

Specified by:

getFacesContext in interface FacesContextHelper

getLocale

public Locale getLocale()

Description copied from interface: FacesContextHelper

Returns the locale of the viewRoot of the current JSF FacesContext

Specified by:

getLocale in interface FacesContextHelper

getLocale

public Locale getLocale(javax.faces.context.FacesContext facesContext)

Description copied from interface: FacesContextHelper

Returns the locale of the viewRoot of the current JSF FacesContext

Specified by:

getLocale in interface FacesContextHelper

getMessage

public String getMessage(String messageId)

Description copied from interface: FacesContextHelper

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

Specified by:

getMessage in interface FacesContextHelper

getMessage

public String getMessage(javax.faces.context.FacesContext facesContext,
                         String messageId)

Description copied from interface: FacesContextHelper

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

Specified by:

getMessage in interface FacesContextHelper

getMessage

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

Description copied from interface: FacesContextHelper

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.

Specified by:

getMessage in interface FacesContextHelper

getMessage

public String getMessage(Locale locale,
                         String messageId)

Description copied from interface: FacesContextHelper

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

Specified by:

getMessage in interface FacesContextHelper

getMessage

public String getMessage(javax.faces.context.FacesContext facesContext,
                         String messageId,
                         Object... arguments)

Description copied from interface: FacesContextHelper

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.

Specified by:

getMessage in interface FacesContextHelper

getMessage

public String getMessage(javax.faces.context.FacesContext facesContext,
                         Locale locale,
                         String messageId)

Description copied from interface: FacesContextHelper

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

Specified by:

getMessage in interface FacesContextHelper

getMessage

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

Description copied from interface: FacesContextHelper

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.

Specified by:

getMessage in interface FacesContextHelper

getMessage

public String getMessage(javax.faces.context.FacesContext facesContext,
                         Locale locale,
                         String messageId,
                         Object... arguments)

Description copied from interface: FacesContextHelper

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.

Specified by:

getMessage in interface FacesContextHelper

getNamespace

public String getNamespace()

Description copied from interface: FacesContextHelper

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

Specified by:

getNamespace in interface FacesContextHelper

getNamespace

public String getNamespace(javax.faces.context.FacesContext facesContext)

Description copied from interface: FacesContextHelper

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

Specified by:

getNamespace in interface FacesContextHelper

getParentForm

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

Description copied from interface: FacesContextHelper

Returns the parent form of the given component or null if no parent form is found.

Specified by:

getParentForm in interface FacesContextHelper

Parameters:

uiComponent - The component whose parent is to be found.

getRequestAttribute

public Object getRequestAttribute(String name)

Description copied from interface: FacesContextHelper

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

Specified by:

getRequestAttribute in interface FacesContextHelper

getRequestAttribute

public Object getRequestAttribute(javax.faces.context.FacesContext facesContext,
                                  String name)

Description copied from interface: FacesContextHelper

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

Specified by:

getRequestAttribute in interface FacesContextHelper

getRequestContextPath

public String getRequestContextPath()

Description copied from interface: FacesContextHelper

Returns The request context path. FacesContext.getExternalContext() ExternalContext.getRequestContextPath()

Specified by:

getRequestContextPath in interface FacesContextHelper

getRequestContextPath

public String getRequestContextPath(javax.faces.context.FacesContext facesContext)

Description copied from interface: FacesContextHelper

Returns The request context path. FacesContext.getExternalContext() ExternalContext.getRequestContextPath()

Specified by:

getRequestContextPath in interface FacesContextHelper

getRequestParameter

public String getRequestParameter(String name)

Description copied from interface: FacesContextHelper

Retrieves the specified parameter passed as part of the request

Specified by:

getRequestParameter in interface FacesContextHelper

getRequestParameter

public String getRequestParameter(javax.faces.context.FacesContext facesContext,
                                  String name)

Description copied from interface: FacesContextHelper

Retrieves the specified parameter passed as part of the request

Specified by:

getRequestParameter in interface FacesContextHelper

getRequestParameterAsBool

public boolean getRequestParameterAsBool(String name,
                                         boolean defaultValue)

Description copied from interface: FacesContextHelper

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".

Specified by:

getRequestParameterAsBool in interface FacesContextHelper

getRequestParameterAsBool

public boolean getRequestParameterAsBool(javax.faces.context.FacesContext facesContext,
                                         String name,
                                         boolean defaultValue)

Description copied from interface: FacesContextHelper

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".

Specified by:

getRequestParameterAsBool in interface FacesContextHelper

getRequestParameterAsInt

public int getRequestParameterAsInt(String name,
                                    int defaultValue)

Description copied from interface: FacesContextHelper

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

Specified by:

getRequestParameterAsInt in interface FacesContextHelper

getRequestParameterAsInt

public int getRequestParameterAsInt(javax.faces.context.FacesContext facesContext,
                                    String name,
                                    int defaultValue)

Description copied from interface: FacesContextHelper

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

Specified by:

getRequestParameterAsInt in interface FacesContextHelper

getRequestParameterAsLong

public long getRequestParameterAsLong(String name,
                                      long defaultValue)

Description copied from interface: FacesContextHelper

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

Specified by:

getRequestParameterAsLong in interface FacesContextHelper

getRequestParameterAsLong

public long getRequestParameterAsLong(javax.faces.context.FacesContext facesContext,
                                      String name,
                                      long defaultValue)

Description copied from interface: FacesContextHelper

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

Specified by:

getRequestParameterAsLong in interface FacesContextHelper

getRequestParameterFromMap

public String getRequestParameterFromMap(String name)

Description copied from interface: FacesContextHelper

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

Specified by:

getRequestParameterFromMap in interface FacesContextHelper

getRequestParameterFromMap

public String getRequestParameterFromMap(javax.faces.context.FacesContext facesContext,
                                         String name)

Description copied from interface: FacesContextHelper

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

Specified by:

getRequestParameterFromMap in interface FacesContextHelper

getRequestParameterMap

public Map<String,String> getRequestParameterMap()

Description copied from interface: FacesContextHelper

Returns the map of request parameters from the ExternalContext.

Specified by:

getRequestParameterMap in interface FacesContextHelper

See Also:

ExternalContext.getRequestParameterMap()

getRequestParameterMap

public Map<String,String> getRequestParameterMap(javax.faces.context.FacesContext facesContext)

Description copied from interface: FacesContextHelper

Returns the map of request parameters from the ExternalContext.

Specified by:

getRequestParameterMap in interface FacesContextHelper

See Also:

ExternalContext.getRequestParameterMap()

getRequestQueryString

public String getRequestQueryString()

Description copied from interface: FacesContextHelper

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

Specified by:

getRequestQueryString in interface FacesContextHelper

getRequestQueryString

public String getRequestQueryString(javax.faces.context.FacesContext facesContext)

Description copied from interface: FacesContextHelper

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

Specified by:

getRequestQueryString in interface FacesContextHelper

getRequestQueryStringParameter

public String getRequestQueryStringParameter(String name)

Description copied from interface: FacesContextHelper

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

Specified by:

getRequestQueryStringParameter in interface FacesContextHelper

getRequestQueryStringParameter

public String getRequestQueryStringParameter(javax.faces.context.FacesContext facesContext,
                                             String name)

Description copied from interface: FacesContextHelper

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

Specified by:

getRequestQueryStringParameter in interface FacesContextHelper

getScripts

public List<Script> getScripts()

Description copied from interface: FacesContextHelper

Returns an immutable list of scripts that were added via the FacesContextHelper.addScript(FacesContext,Script) or FacesContextHelper.addScript(FacesContext,String) method.

Specified by:

getScripts in interface FacesContextHelper

getScripts

public List<Script> getScripts(javax.faces.context.FacesContext facesContext)

Description copied from interface: FacesContextHelper

Returns an immutable list of scripts that were added via the FacesContextHelper.addScript(FacesContext,Script) or FacesContextHelper.addScript(FacesContext,String) method.

Specified by:

getScripts in interface FacesContextHelper

Parameters:

facesContext - The current faces context.

getSession

public Object getSession(boolean create)

Description copied from interface: FacesContextHelper

Returns the session object associated with the current FacesContext.

Specified by:

getSession in interface FacesContextHelper

Parameters:

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

getSession

public Object getSession(javax.faces.context.FacesContext facesContext,
                         boolean create)

Description copied from interface: FacesContextHelper

Returns the session object associated with the current FacesContext.

Specified by:

getSession in interface FacesContextHelper

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

getSessionAttribute

public Object getSessionAttribute(String name)

Description copied from interface: FacesContextHelper

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

Specified by:

getSessionAttribute in interface FacesContextHelper

getSessionAttribute

public Object getSessionAttribute(javax.faces.context.FacesContext facesContext,
                                  String name)

Description copied from interface: FacesContextHelper

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

Specified by:

getSessionAttribute in interface FacesContextHelper

matchComponentInHierarchy

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

Description copied from interface: FacesContextHelper

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

Specified by:

matchComponentInHierarchy in interface FacesContextHelper

matchComponentInHierarchy

public javax.faces.component.UIComponent matchComponentInHierarchy(javax.faces.context.FacesContext facesContext,
                                                                   javax.faces.component.UIComponent parent,
                                                                   String partialClientId)

Description copied from interface: FacesContextHelper

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

Specified by:

matchComponentInHierarchy in interface FacesContextHelper

matchComponentInViewRoot

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

Description copied from interface: FacesContextHelper

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

Specified by:

matchComponentInViewRoot in interface FacesContextHelper

matchComponentInViewRoot

public javax.faces.component.UIComponent matchComponentInViewRoot(javax.faces.context.FacesContext facesContext,
                                                                  String partialClientId)

Description copied from interface: FacesContextHelper

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

Specified by:

matchComponentInViewRoot in interface FacesContextHelper

navigate

public void navigate(String fromAction,
                     String outcome)

Description copied from interface: FacesContextHelper

Sets the current JSF navigation to the specified outcome.

Specified by:

navigate in interface FacesContextHelper

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

navigate

public void navigate(javax.faces.context.FacesContext facesContext,
                     String fromAction,
                     String outcome)

Description copied from interface: FacesContextHelper

Sets the current JSF navigation to the specified outcome.

Specified by:

navigate in interface FacesContextHelper

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

public void navigateTo(String outcome)

Description copied from interface: FacesContextHelper

Sets the current JSF navigation to the specified outcome.

Specified by:

navigateTo in interface FacesContextHelper

Parameters:

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

navigateTo

public void navigateTo(javax.faces.context.FacesContext facesContext,
                       String outcome)

Description copied from interface: FacesContextHelper

Sets the current JSF navigation to the specified outcome.

Specified by:

navigateTo in interface FacesContextHelper

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

recreateComponentTree

public void recreateComponentTree()

Description copied from interface: FacesContextHelper

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.

Specified by:

recreateComponentTree in interface FacesContextHelper

recreateComponentTree

public void recreateComponentTree(javax.faces.context.FacesContext facesContext)

Description copied from interface: FacesContextHelper

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.

Specified by:

recreateComponentTree in interface FacesContextHelper

registerPhaseListener

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

Description copied from interface: FacesContextHelper

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.

Specified by:

registerPhaseListener in interface FacesContextHelper

removeChildrenFromComponentTree

public void removeChildrenFromComponentTree(String clientId)

Description copied from interface: FacesContextHelper

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

Specified by:

removeChildrenFromComponentTree in interface FacesContextHelper

Parameters:

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

removeChildrenFromComponentTree

public void removeChildrenFromComponentTree(javax.faces.context.FacesContext facesContext,
                                            String clientId)

Description copied from interface: FacesContextHelper

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

Specified by:

removeChildrenFromComponentTree in interface FacesContextHelper

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

removeMessages

public void removeMessages(String clientId)

Description copied from interface: FacesContextHelper

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

Specified by:

removeMessages in interface FacesContextHelper

removeMessages

public void removeMessages(javax.faces.context.FacesContext facesContext,
                           String clientId)

Description copied from interface: FacesContextHelper

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

Specified by:

removeMessages in interface FacesContextHelper

removeMessagesForImmediateComponents

public void removeMessagesForImmediateComponents()

Description copied from interface: FacesContextHelper

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.

Specified by:

removeMessagesForImmediateComponents in interface FacesContextHelper

removeMessagesForImmediateComponents

public void removeMessagesForImmediateComponents(javax.faces.context.FacesContext facesContext)

Description copied from interface: FacesContextHelper

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.

Specified by:

removeMessagesForImmediateComponents in interface FacesContextHelper

removeMessagesForImmediateComponents

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

Description copied from interface: FacesContextHelper

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.

Specified by:

removeMessagesForImmediateComponents in interface FacesContextHelper

removeMessagesForImmediateComponents

public void removeMessagesForImmediateComponents(javax.faces.context.FacesContext facesContext,
                                                 javax.faces.component.UIComponent uiComponent)

Description copied from interface: FacesContextHelper

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.

Specified by:

removeMessagesForImmediateComponents in interface FacesContextHelper

removeParentFormFromComponentTree

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

Description copied from interface: FacesContextHelper

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.

Specified by:

removeParentFormFromComponentTree in interface FacesContextHelper

resetView

public void resetView()

Description copied from interface: FacesContextHelper

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

Specified by:

resetView in interface FacesContextHelper

See Also:

FacesContextHelper.resetView(boolean)

resetView

public void resetView(javax.faces.context.FacesContext facesContext)

Description copied from interface: FacesContextHelper

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

Specified by:

resetView in interface FacesContextHelper

See Also:

FacesContextHelper.resetView(boolean)

resetView

public void resetView(boolean renderResponse)

Description copied from interface: FacesContextHelper

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.

Specified by:

resetView in interface FacesContextHelper

Parameters:

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

See Also:

ClearInputComponents

resetView

public void resetView(javax.faces.context.FacesContext facesContext,
                      boolean renderResponse)

Description copied from interface: FacesContextHelper

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.

Specified by:

resetView in interface FacesContextHelper

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

See Also:

ClearInputComponents

resolveExpression

public Object resolveExpression(String elExpression)

Description copied from interface: FacesContextHelper

Returns the object associated with the specified EL expression.

Specified by:

resolveExpression in interface FacesContextHelper

resolveExpression

public Object resolveExpression(javax.faces.context.FacesContext facesContext,
                                String elExpression)

Description copied from interface: FacesContextHelper

Returns the object associated with the specified EL expression.

Specified by:

resolveExpression in interface FacesContextHelper

setRequestAttribute

public void setRequestAttribute(String name,
                                Object value)

Description copied from interface: FacesContextHelper

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

Specified by:

setRequestAttribute in interface FacesContextHelper

setRequestAttribute

public void setRequestAttribute(javax.faces.context.FacesContext facesContext,
                                String name,
                                Object value)

Description copied from interface: FacesContextHelper

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

Specified by:

setRequestAttribute in interface FacesContextHelper

setSessionAttribute

public void setSessionAttribute(String name,
                                Object value)

Description copied from interface: FacesContextHelper

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

Specified by:

setSessionAttribute in interface FacesContextHelper

setSessionAttribute

public void setSessionAttribute(javax.faces.context.FacesContext facesContext,
                                String name,
                                Object value)

Description copied from interface: FacesContextHelper

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

Specified by:

setSessionAttribute in interface FacesContextHelper