org.ajax4jsf.context
Class AjaxContextImpl

java.lang.Object
  extended by org.ajax4jsf.context.AjaxContext
      extended by org.ajax4jsf.context.AjaxContextImpl

public class AjaxContextImpl
extends org.ajax4jsf.context.AjaxContext

This class incapsulated

Version:
$Revision: 1.1.2.7 $ $Date: 2007/02/08 19:07:16 $
Author:
asmirnov@exadel.com (latest modification by $Author: alexsmirnov $)

Field Summary
static java.lang.String RESOURCES_PROCESSED
           
 
Fields inherited from class org.ajax4jsf.context.AjaxContext
AJAX_CONTEXT_KEY, RESPONSE_DATA_KEY, SCRIPTS_PARAMETER, STYLES_PARAMETER, USER_STYLES_PARAMETER
 
Constructor Summary
AjaxContextImpl()
           
 
Method Summary
 void addComponentToAjaxRender(javax.faces.component.UIComponent component)
           
 void addComponentToAjaxRender(javax.faces.component.UIComponent base, java.lang.String id)
           
 void addRegionsFromComponent(javax.faces.component.UIComponent component)
          Add affected regions's ID to ajaxView component.
 void addRenderedArea(java.lang.String id)
           
 void encodeAjaxBegin(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
          Encode declaration for AJAX response.
 void encodeAjaxEnd(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
          End encoding of AJAX response.
 java.lang.String getAjaxActionURL()
           
 java.lang.String getAjaxActionURL(javax.faces.context.FacesContext context)
           
 java.util.Set getAjaxAreasToRender()
           
 java.util.Set getAjaxRenderedAreas()
           
 java.util.Map getCommonAjaxParameters()
           
 java.lang.Object getOncomplete()
           
 java.lang.Object getResponseData()
           
 java.util.Map getResponseDataMap()
           
 java.lang.String getSubmittedRegionClientId(javax.faces.context.FacesContext context)
           
 org.ajax4jsf.context.ViewIdHolder getViewIdHolder()
           
protected  java.io.PrintWriter getWriter(javax.faces.context.ExternalContext extContext)
          Gives back the writer of a Response object.
static boolean invokeOnComponent(javax.faces.component.UIComponent root, javax.faces.context.FacesContext context, InvokerCallback callback, java.lang.String regionId)
           
static void invokeOnRegionOrRoot(AjaxViewRoot viewRoot, javax.faces.context.FacesContext context, InvokerCallback callback)
           
 boolean isAjaxRequest()
           
 boolean isAjaxRequest(javax.faces.context.FacesContext context)
           
 boolean isSelfRender()
           
 void processHeadResources(javax.faces.context.FacesContext context)
           
 void release()
           
 boolean removeRenderedArea(java.lang.String id)
           
 void renderAjaxRegion(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, boolean useFilterWriter)
           
 void renderSubmittedAjaxRegion(javax.faces.context.FacesContext context)
           
 void renderSubmittedAjaxRegion(javax.faces.context.FacesContext context, boolean useFilterWriter)
           
 void saveViewState(javax.faces.context.FacesContext context)
           
 void setAjaxRequest(boolean ajaxRequest)
           
 void setOncomplete(java.lang.Object oncomplete)
           
 void setResponseData(java.lang.Object responseData)
           
 void setSelfRender(boolean selfRender)
           
 void setSubmittedRegionClientId(java.lang.String submittedClientId)
           
 void setViewIdHolder(org.ajax4jsf.context.ViewIdHolder viewIdHolder)
           
 
Methods inherited from class org.ajax4jsf.context.AjaxContext
getCurrentInstance, getCurrentInstance
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RESOURCES_PROCESSED

public static final java.lang.String RESOURCES_PROCESSED
See Also:
Constant Field Values
Constructor Detail

AjaxContextImpl

public AjaxContextImpl()
Method Detail

release

public void release()
Specified by:
release in class org.ajax4jsf.context.AjaxContext

invokeOnComponent

public static boolean invokeOnComponent(javax.faces.component.UIComponent root,
                                        javax.faces.context.FacesContext context,
                                        InvokerCallback callback,
                                        java.lang.String regionId)
Parameters:
root -
context -
callback -
regionId -
Returns:
See Also:
JsfOneOneInvoker.invokeOnComponent(javax.faces.component.UIComponent, javax.faces.context.FacesContext, org.ajax4jsf.context.InvokerCallback, java.lang.String)

invokeOnRegionOrRoot

public static void invokeOnRegionOrRoot(AjaxViewRoot viewRoot,
                                        javax.faces.context.FacesContext context,
                                        InvokerCallback callback)
Parameters:
viewRoot -
context -
callback -
See Also:
JsfOneOneInvoker.invokeOnRegionOrRoot(org.ajax4jsf.component.AjaxViewRoot, javax.faces.context.FacesContext, org.ajax4jsf.context.InvokerCallback)

renderSubmittedAjaxRegion

public void renderSubmittedAjaxRegion(javax.faces.context.FacesContext context)
Specified by:
renderSubmittedAjaxRegion in class org.ajax4jsf.context.AjaxContext

renderSubmittedAjaxRegion

public void renderSubmittedAjaxRegion(javax.faces.context.FacesContext context,
                                      boolean useFilterWriter)
Specified by:
renderSubmittedAjaxRegion in class org.ajax4jsf.context.AjaxContext

renderAjaxRegion

public void renderAjaxRegion(javax.faces.context.FacesContext context,
                             javax.faces.component.UIComponent component,
                             boolean useFilterWriter)
                      throws javax.faces.FacesException
Specified by:
renderAjaxRegion in class org.ajax4jsf.context.AjaxContext
Parameters:
context -
useFilterWriter - TODO
Throws:
javax.faces.event.AbortProcessingException
javax.faces.FacesException

encodeAjaxBegin

public void encodeAjaxBegin(javax.faces.context.FacesContext context,
                            javax.faces.component.UIComponent component)
                     throws java.io.IOException
Encode declaration for AJAX response. Render <html><body>

Specified by:
encodeAjaxBegin in class org.ajax4jsf.context.AjaxContext
Parameters:
context -
component -
Throws:
java.io.IOException

encodeAjaxEnd

public void encodeAjaxEnd(javax.faces.context.FacesContext context,
                          javax.faces.component.UIComponent component)
                   throws java.io.IOException
End encoding of AJAX response. Render tag with included areas and close </body></html>

Specified by:
encodeAjaxEnd in class org.ajax4jsf.context.AjaxContext
Parameters:
context -
component -
Throws:
java.io.IOException

processHeadResources

public void processHeadResources(javax.faces.context.FacesContext context)
                          throws javax.faces.FacesException
Specified by:
processHeadResources in class org.ajax4jsf.context.AjaxContext
Parameters:
context -
root -
Throws:
javax.faces.FacesException

saveViewState

public void saveViewState(javax.faces.context.FacesContext context)
                   throws java.io.IOException
Specified by:
saveViewState in class org.ajax4jsf.context.AjaxContext
Throws:
java.io.IOException

isAjaxRequest

public boolean isAjaxRequest()
Specified by:
isAjaxRequest in class org.ajax4jsf.context.AjaxContext
Returns:
Returns the ajaxRequest.

isAjaxRequest

public boolean isAjaxRequest(javax.faces.context.FacesContext context)
Specified by:
isAjaxRequest in class org.ajax4jsf.context.AjaxContext
Returns:
Returns the ajaxRequest.

setAjaxRequest

public void setAjaxRequest(boolean ajaxRequest)
Specified by:
setAjaxRequest in class org.ajax4jsf.context.AjaxContext
Parameters:
ajaxRequest - The ajaxRequest to set.

getAjaxAreasToRender

public java.util.Set getAjaxAreasToRender()
Specified by:
getAjaxAreasToRender in class org.ajax4jsf.context.AjaxContext
Returns:
Returns the ajaxAreasToRender.

addRegionsFromComponent

public void addRegionsFromComponent(javax.faces.component.UIComponent component)
Add affected regions's ID to ajaxView component.

Specified by:
addRegionsFromComponent in class org.ajax4jsf.context.AjaxContext
Parameters:
component -

addComponentToAjaxRender

public void addComponentToAjaxRender(javax.faces.component.UIComponent component)
Specified by:
addComponentToAjaxRender in class org.ajax4jsf.context.AjaxContext

addComponentToAjaxRender

public void addComponentToAjaxRender(javax.faces.component.UIComponent base,
                                     java.lang.String id)
Specified by:
addComponentToAjaxRender in class org.ajax4jsf.context.AjaxContext

getAjaxRenderedAreas

public java.util.Set getAjaxRenderedAreas()
Specified by:
getAjaxRenderedAreas in class org.ajax4jsf.context.AjaxContext
Returns:
Returns the ajaxRenderedAreas.

addRenderedArea

public void addRenderedArea(java.lang.String id)
Specified by:
addRenderedArea in class org.ajax4jsf.context.AjaxContext

removeRenderedArea

public boolean removeRenderedArea(java.lang.String id)
Specified by:
removeRenderedArea in class org.ajax4jsf.context.AjaxContext

getSubmittedRegionClientId

public java.lang.String getSubmittedRegionClientId(javax.faces.context.FacesContext context)
Specified by:
getSubmittedRegionClientId in class org.ajax4jsf.context.AjaxContext
Returns:
Returns the submittedClientId.

setSubmittedRegionClientId

public void setSubmittedRegionClientId(java.lang.String submittedClientId)
Parameters:
submittedClientId - The submittedClientId to set.

isSelfRender

public boolean isSelfRender()
Specified by:
isSelfRender in class org.ajax4jsf.context.AjaxContext
Returns:
Returns the selfRender.

setSelfRender

public void setSelfRender(boolean selfRender)
Specified by:
setSelfRender in class org.ajax4jsf.context.AjaxContext
Parameters:
selfRender - The selfRender to set.

getViewIdHolder

public org.ajax4jsf.context.ViewIdHolder getViewIdHolder()
Specified by:
getViewIdHolder in class org.ajax4jsf.context.AjaxContext
Returns:
the vievIdHolder

setViewIdHolder

public void setViewIdHolder(org.ajax4jsf.context.ViewIdHolder viewIdHolder)
Specified by:
setViewIdHolder in class org.ajax4jsf.context.AjaxContext
Parameters:
viewIdHolder - the vievIdHolder to set

getResponseData

public java.lang.Object getResponseData()
Specified by:
getResponseData in class org.ajax4jsf.context.AjaxContext
Returns:
the responseData

setResponseData

public void setResponseData(java.lang.Object responseData)
Specified by:
setResponseData in class org.ajax4jsf.context.AjaxContext
Parameters:
responseData - the responseData to set

getResponseDataMap

public java.util.Map getResponseDataMap()
Specified by:
getResponseDataMap in class org.ajax4jsf.context.AjaxContext
Returns:
the responseDataMap

getWriter

protected java.io.PrintWriter getWriter(javax.faces.context.ExternalContext extContext)
                                 throws javax.faces.FacesException
Gives back the writer of a Response object.

Parameters:
extContext - The external context.
Returns:
The writer of the response.
Throws:
javax.faces.FacesException - If the response object has no getWriter() method.

getAjaxActionURL

public java.lang.String getAjaxActionURL()
Specified by:
getAjaxActionURL in class org.ajax4jsf.context.AjaxContext

getAjaxActionURL

public java.lang.String getAjaxActionURL(javax.faces.context.FacesContext context)
Specified by:
getAjaxActionURL in class org.ajax4jsf.context.AjaxContext

getCommonAjaxParameters

public java.util.Map getCommonAjaxParameters()
Specified by:
getCommonAjaxParameters in class org.ajax4jsf.context.AjaxContext
Returns:
the commonAjaxParameters

getOncomplete

public java.lang.Object getOncomplete()
Specified by:
getOncomplete in class org.ajax4jsf.context.AjaxContext
Returns:
the oncomplete

setOncomplete

public void setOncomplete(java.lang.Object oncomplete)
Specified by:
setOncomplete in class org.ajax4jsf.context.AjaxContext
Parameters:
oncomplete - the oncomplete to set


Copyright © 2008. All Rights Reserved.