com.esri.adf.web.faces.renderkit.xml.ajax
Class OverviewRenderer

java.lang.Object
  com.esri.adf.web.faces.renderkit.xml.ajax.OverviewRenderer

All Implemented Interfaces:

AJAXRenderer

public class OverviewRenderer
extends java.lang.Object
implements AJAXRenderer

A renderer for the OverviewControl. Generates an XML representation of the control which is processed by the AJAX handler to update the control in the rendered page.

Renders <overview> xml tag fragment as part of AJAX response.

Constructor Summary

OverviewRenderer()

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 context, javax.faces.component.UIComponent component, java.lang.Object origState, boolean isEventSource, org.w3c.dom.Element parentElement) Render AJAX xml response for this control.

Methods inherited from class java.lang.Object

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

Constructor Detail

OverviewRenderer

public OverviewRenderer()

Method Detail

getControlClass

public java.lang.Class getControlClass()

Description copied from interface: AJAXRenderer

Return the class of the control to be passed for processing

 return MyClassName.class
 

Specified by:

getControlClass in interface AJAXRenderer

renderAjaxResponse

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

Description copied from interface: AJAXRenderer

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 = com.esri.adf.web.util.XMLUtil.createElement("my-tag", null, parentElement);
 com.esri.adf.web.util.XMLUtil.createElement("id", component.getId(), myTag);
 ...
 

Specified by:

renderAjaxResponse in interface AJAXRenderer

Parameters:

context - Current FacesContext instance

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

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

getOriginalState

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

Description copied from interface: AJAXRenderer

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

Specified by:

getOriginalState in interface AJAXRenderer

Parameters:

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