com.esri.adf.web.faces.renderkit.xml
Class TocRenderer

java.lang.Object
  javax.faces.render.Renderer
      com.esri.adf.web.faces.renderkit.xml.TocRenderer

public class TocRenderer
extends javax.faces.render.Renderer

A renderer for the TocControl. Generates an XML representation of the control and then uses XSLT to transform it to the required markup.

Field Summary

static String	CHECKED_NODE_VALUE The value of the request parameter for a checked node.
static String	CLICK_OPERATION The value of the request parameter representing a node click operation.
static String	CONTEXT_MENU_OPERATION The value of the request parameter representing a context menu operation.
static String	EXPAND_COLLAPSE_OPERATION The value of the request parameter representing a node expand/collapse operation.
static String	NODE_KEY_SUFFIX The nodeKey request parameter representing the key of the node responsible for the operation.
static String	NODE_OPERATION_SUFFIX The request parameter "nodeOperation" must equal 0 for an expand/collapse operation, 1 for a check/uncheck operation, 2 for a context menu operation, or an integer other than -1, 0, 1 or 2 for a custom operation.
static String	UNCHECKED_NODE_VALUE The value of the request parameter for an unchecked node.

Constructor Summary

TocRenderer()

Method Summary

void	decode(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component) Determines if the associated TOC has to handle this event.
void	encodeBegin(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component) Begin the encoding of a given context.
void	encodeChildren(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component) Encodes the children of a given context.
void	encodeEnd(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component) Generates an XML representation of the TocControl and then encodes using XSLT to transform to the required markup.

Methods inherited from class javax.faces.render.Renderer

convertClientId, getConvertedValue, getRendersChildren

Methods inherited from class java.lang.Object

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

Field Detail

NODE_KEY_SUFFIX

public static final String NODE_KEY_SUFFIX

The nodeKey request parameter representing the key of the node responsible for the operation.

See Also:

Constant Field Values

NODE_OPERATION_SUFFIX

public static final String NODE_OPERATION_SUFFIX

The request parameter "nodeOperation" must equal 0 for an expand/collapse operation, 1 for a check/uncheck operation, 2 for a context menu operation, or an integer other than -1, 0, 1 or 2 for a custom operation.

See Also:

Constant Field Values

CLICK_OPERATION

public static final String CLICK_OPERATION

The value of the request parameter representing a node click operation.

See Also:

Constant Field Values

CONTEXT_MENU_OPERATION

public static final String CONTEXT_MENU_OPERATION

The value of the request parameter representing a context menu operation.

See Also:

Constant Field Values

EXPAND_COLLAPSE_OPERATION

public static final String EXPAND_COLLAPSE_OPERATION

The value of the request parameter representing a node expand/collapse operation.

See Also:

Constant Field Values

CHECKED_NODE_VALUE

public static final String CHECKED_NODE_VALUE

The value of the request parameter for a checked node.

See Also:

Constant Field Values

UNCHECKED_NODE_VALUE

public static final String UNCHECKED_NODE_VALUE

The value of the request parameter for an unchecked node.

See Also:

Constant Field Values

Constructor Detail

TocRenderer

public TocRenderer()

Method Detail

decode

public void decode(javax.faces.context.FacesContext facesContext,
                   javax.faces.component.UIComponent component)

Determines if the associated TOC has to handle this event. If yes, it calls the control's setEventArgs method.

Overrides:

decode in class javax.faces.render.Renderer

Parameters:

facesContext - the FacesContext

component - the JSF component

encodeEnd

public void encodeEnd(javax.faces.context.FacesContext facesContext,
                      javax.faces.component.UIComponent component)
               throws IOException

Generates an XML representation of the TocControl and then encodes using XSLT to transform to the required markup.

Overrides:

encodeEnd in class javax.faces.render.Renderer

Parameters:

facesContext - the FacesContext

component - the JSF component

Throws:

IOException

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext facesContext,
                        javax.faces.component.UIComponent component)

Begin the encoding of a given context. Currently, this is an empty implementation and throws an IOException.

Overrides:

encodeBegin in class javax.faces.render.Renderer

Parameters:

facesContext - the FacesContext

component - the JSF component

encodeChildren

public void encodeChildren(javax.faces.context.FacesContext facesContext,
                           javax.faces.component.UIComponent component)

Encodes the children of a given context. Currently, this is an empty implementation and throws an IOException.

Overrides:

encodeChildren in class javax.faces.render.Renderer

Parameters:

facesContext - the FacesContext

component - the JSF component