com.liferay.faces.util.context
Interface FacesContextHelper

All Known Implementing Classes:

ExtFacesContext, FacesContextHelperWrapper

public interface FacesContextHelper

Author:

Neil Griffin

Method Summary

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 addScript(FacesContext,Script) or addScript(FacesContext,String) method.
List<Script>	getScripts(javax.faces.context.FacesContext facesContext) Returns an immutable list of scripts that were added via the addScript(FacesContext,Script) or 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.
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.

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

addComponentErrorMessage

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

addComponentInfoMessage

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

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.

addGlobalErrorMessage

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.

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

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.

addGlobalInfoMessage

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.

addGlobalSuccessInfoMessage

void addGlobalSuccessInfoMessage()

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

addGlobalSuccessInfoMessage

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.

addGlobalUnexpectedErrorMessage

void addGlobalUnexpectedErrorMessage()

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

addGlobalUnexpectedErrorMessage

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.

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

addMessage

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. Specify clientId=null for global messages.

addScript

void addScript(Script script)

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

Parameters:

script - The script that is to be added.

Since:

3.2

addScript

void addScript(String scriptString)

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

Parameters:

scriptString - The script that is to be added.

Since:

3.2

addScript

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.

Parameters:

facesContext - The current faces context.

script - The script that is to be added.

Since:

3.2

addScript

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.

Parameters:

facesContext - The current faces context.

scriptString - The script that is to be added.

Since:

3.2

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

getLocale

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

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

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

getMessage

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.

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.

getMessage

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.

getNamespace

String getNamespace()

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

getNamespace

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

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)

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

Parameters:

uiComponent - The component whose parent is to be found.

getRequestAttribute

Object getRequestAttribute(String name)

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

getRequestAttribute

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

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

getRequestContextPath

String getRequestContextPath()

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

getRequestContextPath

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

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

getRequestParameter

String getRequestParameter(String name)

Retrieves the specified parameter passed as part of the request

getRequestParameter

String getRequestParameter(javax.faces.context.FacesContext facesContext,
                           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".

getRequestParameterAsBool

boolean getRequestParameterAsBool(javax.faces.context.FacesContext facesContext,
                                  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.

getRequestParameterAsInt

int getRequestParameterAsInt(javax.faces.context.FacesContext facesContext,
                             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.

getRequestParameterAsLong

long getRequestParameterAsLong(javax.faces.context.FacesContext facesContext,
                               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.

getRequestParameterFromMap

String getRequestParameterFromMap(javax.faces.context.FacesContext facesContext,
                                  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()

getRequestParameterMap

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

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.

getRequestQueryString

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

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.

getRequestQueryStringParameter

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.

getScripts

List<Script> getScripts()

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

Since:

3.2

getScripts

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

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

Parameters:

facesContext - The current faces context.

Since:

3.2

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.

getSession

Object getSession(javax.faces.context.FacesContext facesContext,
                  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.

getSessionAttribute

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

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

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.

matchComponentInHierarchy

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.

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.

matchComponentInViewRoot

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.

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

navigate

void navigate(javax.faces.context.FacesContext facesContext,
              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

navigateTo

void navigateTo(javax.faces.context.FacesContext facesContext,
                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.

recreateComponentTree

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

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.

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.

removeChildrenFromComponentTree

void removeChildrenFromComponentTree(javax.faces.context.FacesContext facesContext,
                                     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.

removeMessages

void removeMessages(javax.faces.context.FacesContext facesContext,
                    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.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. 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.

removeMessagesForImmediateComponents

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

resetView

void resetView()

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

See Also:

resetView(boolean)

resetView

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

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

resetView

void resetView(javax.faces.context.FacesContext facesContext,
               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.

resolveExpression

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

Returns the object associated with the specified EL expression.

setRequestAttribute

void setRequestAttribute(String name,
                         Object value)

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

setRequestAttribute

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.

setSessionAttribute

void setSessionAttribute(String name,
                         Object value)

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

setSessionAttribute

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.