com.esri.adf.web.faces.renderkit.xml.ajax
Interface AJAXRenderer

All Known Implementing Classes:

GPAsyncTaskResultsRenderer, MapRenderer, OverviewRenderer, TaskRenderer, TocRenderer, ToolbarRenderer

public interface AJAXRenderer

The AJAXRenderer interface must be implemented by all classes that would like to render xml fragments as part of the postback request response cycle.

Once the class has been coded and the AJAXRenderer interface implemented, it needs to be registered in the WEB-INF/ajax-renderers.xml file for it to be used by the AJAXResponseRenderer

 <managed-bean>
 <display-name>AJAXRenderers</display-name>
 ...
 <list-entries>
 <value>#{myAjaxRenderer}</value>
 <list-entries>

 <managed-bean>
   <managed-bean-name>myAjaxRenderer</managed-bean-name>
   <managed-bean-class>my.company.MyAjaxRenderer</managed-bean-class>
   <managed-bean-scope>none</managed-bean-scope>
 </managed-bean>
 

Method Summary

java.lang.Class	getControlClass() Return the class of the control to be passed for processing
java.lang.Object	getOriginalState(javax.faces.component.UIComponent component) Returns the state of the argument component.
void	renderAjaxResponse(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component, java.lang.Object state, boolean isEventSource, org.w3c.dom.Element parentElement) Render AJAX xml response for this control.

Method Detail

getControlClass

public java.lang.Class getControlClass()

Return the class of the control to be passed for processing

 return MyClassName.class
 

getOriginalState

public java.lang.Object getOriginalState(javax.faces.component.UIComponent component)

Returns the state of the argument component. The returned state can be null.

Parameters:

component - Component who's class is the same as that returned by getControlClass method

renderAjaxResponse

public void renderAjaxResponse(javax.faces.context.FacesContext facesContext,
                               javax.faces.component.UIComponent component,
                               java.lang.Object state,
                               boolean isEventSource,
                               org.w3c.dom.Element parentElement)

Render AJAX xml response for this control. The response is contained within the argument Document.

 if (state != null && state.equals(currentState))
   return;

 org.w3c.dom.Element myTag = {@link com.esri.adf.web.util.XMLUtil).createElement("my-tag", null, parentElement);
 {@link com.esri.adf.web.util.XMLUtil).createElement("id", component.getId(), myTag);
 ...
 

Parameters:

facesContext - Current FacesContext instance

component - Component who's class is the same as that returned by getControlClass method

state - Object returned by getOriginalState method. May be null.

isEventSource - True if component handled request from client to perform operation on server

parentElement - Root level XML response node. All content must be rendered within a unique tag which is created as a child for this parentElement