org.ajax4jsf.context
Class AjaxContext

java.lang.Object
  org.ajax4jsf.context.AjaxContext

public abstract class AjaxContext
extends java.lang.Object

Field Summary

static java.lang.String	AJAX_CONTEXT_KEY Key for keep request state information in request-scope attributes.
static java.lang.String	RESPONSE_DATA_KEY
static java.lang.String	SCRIPTS_PARAMETER
static java.lang.String	STYLES_PARAMETER

Constructor Summary

AjaxContext()

Method Summary

abstract void	addComponentToAjaxRender(javax.faces.component.UIComponent component)
abstract void	addComponentToAjaxRender(javax.faces.component.UIComponent base, java.lang.String id)
abstract void	addRegionsFromComponent(javax.faces.component.UIComponent component)
abstract void	addRenderedArea(java.lang.String id)
abstract void	encodeAjaxBegin(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
abstract void	encodeAjaxEnd(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
abstract java.lang.String	getAjaxActionURL()
abstract java.lang.String	getAjaxActionURL(javax.faces.context.FacesContext context)
abstract java.util.Set	getAjaxAreasToRender()
abstract java.util.Set	getAjaxRenderedAreas()
abstract java.util.Map	getCommonAjaxParameters()
static AjaxContext	getCurrentInstance() Get instance of current AJAX Context.
static AjaxContext	getCurrentInstance(javax.faces.context.FacesContext context) Get instance of current AJAX Context.
abstract java.lang.Object	getOncomplete()
abstract java.lang.Object	getResponseData()
abstract java.util.Map	getResponseDataMap()
abstract java.lang.String	getSubmittedRegionClientId(javax.faces.context.FacesContext context)
abstract ViewIdHolder	getViewIdHolder()
abstract boolean	isAjaxRequest()
abstract boolean	isAjaxRequest(javax.faces.context.FacesContext context)
abstract boolean	isSelfRender()
abstract void	processHeadResources(javax.faces.context.FacesContext context)
abstract void	release()
abstract boolean	removeRenderedArea(java.lang.String id)
abstract void	renderAjaxRegion(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, boolean useFilterWriter)
abstract void	renderSubmittedAjaxRegion(javax.faces.context.FacesContext context)
abstract void	renderSubmittedAjaxRegion(javax.faces.context.FacesContext context, boolean useFilterWriter)
abstract void	saveViewState(javax.faces.context.FacesContext context)
abstract void	setAjaxRequest(boolean b)
abstract void	setOncomplete(java.lang.Object oncompleteFunction)
abstract void	setResponseData(java.lang.Object responseData)
abstract void	setSelfRender(boolean b)
abstract void	setViewIdHolder(ViewIdHolder viewIdHolder)

Methods inherited from class java.lang.Object

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

Field Detail

AJAX_CONTEXT_KEY

public static final java.lang.String AJAX_CONTEXT_KEY

Key for keep request state information in request-scope attributes.

See Also:

Constant Field Values

SCRIPTS_PARAMETER

public static final java.lang.String SCRIPTS_PARAMETER

See Also:

Constant Field Values

STYLES_PARAMETER

public static final java.lang.String STYLES_PARAMETER

See Also:

Constant Field Values

RESPONSE_DATA_KEY

public static final java.lang.String RESPONSE_DATA_KEY

See Also:

Constant Field Values

Constructor Detail

AjaxContext

public AjaxContext()

Method Detail

getCommonAjaxParameters

public abstract java.util.Map getCommonAjaxParameters()

getAjaxActionURL

public abstract java.lang.String getAjaxActionURL(javax.faces.context.FacesContext context)

getAjaxActionURL

public abstract java.lang.String getAjaxActionURL()

setResponseData

public abstract void setResponseData(java.lang.Object responseData)

getResponseData

public abstract java.lang.Object getResponseData()

setOncomplete

public abstract void setOncomplete(java.lang.Object oncompleteFunction)

getOncomplete

public abstract java.lang.Object getOncomplete()

setViewIdHolder

public abstract void setViewIdHolder(ViewIdHolder viewIdHolder)

getViewIdHolder

public abstract ViewIdHolder getViewIdHolder()

removeRenderedArea

public abstract boolean removeRenderedArea(java.lang.String id)

addRenderedArea

public abstract void addRenderedArea(java.lang.String id)

getAjaxRenderedAreas

public abstract java.util.Set getAjaxRenderedAreas()

addComponentToAjaxRender

public abstract void addComponentToAjaxRender(javax.faces.component.UIComponent base,
                                              java.lang.String id)

addComponentToAjaxRender

public abstract void addComponentToAjaxRender(javax.faces.component.UIComponent component)

addRegionsFromComponent

public abstract void addRegionsFromComponent(javax.faces.component.UIComponent component)

getAjaxAreasToRender

public abstract java.util.Set getAjaxAreasToRender()

isAjaxRequest

public abstract boolean isAjaxRequest(javax.faces.context.FacesContext context)

isAjaxRequest

public abstract boolean isAjaxRequest()

processHeadResources

public abstract void processHeadResources(javax.faces.context.FacesContext context)
                                   throws javax.faces.FacesException

Throws:

javax.faces.FacesException

encodeAjaxEnd

public abstract void encodeAjaxEnd(javax.faces.context.FacesContext context,
                                   javax.faces.component.UIComponent component)
                            throws java.io.IOException

Throws:

java.io.IOException

encodeAjaxBegin

public abstract void encodeAjaxBegin(javax.faces.context.FacesContext context,
                                     javax.faces.component.UIComponent component)
                              throws java.io.IOException

Throws:

java.io.IOException

renderAjaxRegion

public abstract void renderAjaxRegion(javax.faces.context.FacesContext context,
                                      javax.faces.component.UIComponent component,
                                      boolean useFilterWriter)
                               throws javax.faces.FacesException

Throws:

javax.faces.FacesException

renderSubmittedAjaxRegion

public abstract void renderSubmittedAjaxRegion(javax.faces.context.FacesContext context,
                                               boolean useFilterWriter)

renderSubmittedAjaxRegion

public abstract void renderSubmittedAjaxRegion(javax.faces.context.FacesContext context)

getCurrentInstance

public static AjaxContext getCurrentInstance()

Get instance of current AJAX Context. Instance get by VariableResolver.resolveVariable(FacesContext, String) for variable AJAX_CONTEXT_KEY

Returns:

memento instance for current request

getCurrentInstance

public static AjaxContext getCurrentInstance(javax.faces.context.FacesContext context)

Get instance of current AJAX Context. Instance get by VariableResolver.resolveVariable(FacesContext, String) for variable AJAX_CONTEXT_KEY

Parameters:

context - current FacesContext

Returns:

instance of AjaxContext.

release

public abstract void release()

getResponseDataMap

public abstract java.util.Map getResponseDataMap()

setAjaxRequest

public abstract void setAjaxRequest(boolean b)

isSelfRender

public abstract boolean isSelfRender()

setSelfRender

public abstract void setSelfRender(boolean b)

getSubmittedRegionClientId

public abstract java.lang.String getSubmittedRegionClientId(javax.faces.context.FacesContext context)

saveViewState

public abstract void saveViewState(javax.faces.context.FacesContext context)
                            throws java.io.IOException

Throws:

java.io.IOException