org.richfaces.renderkit

## Class TreeRendererBase

- java.lang.Object
- - javax.faces.render.Renderer
  - - org.richfaces.renderkit.RendererBase
    - - org.richfaces.renderkit.TreeRendererBase

- All Implemented Interfaces:
    MetaComponentRenderer
  Direct Known Subclasses:
    TreeRenderer

      public abstract class TreeRendererBase
      extends RendererBase
      implements MetaComponentRenderer

  Author:
    Nick Belaevski

- - ### Field Summary

    - ### Fields inherited from class javax.faces.render.Renderer

      `PASSTHROUGH_RENDERER_LOCALNAME_KEY`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `TreeRendererBase()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | `createTreeRenderingContext(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)`
    `void` | `decodeMetaComponent(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, String metaComponentId)`
    `protected void` | `deleteTreeRenderingContext(javax.faces.context.FacesContext context)`
    `void` | `doDecode(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)` Template method for custom decoding of concrete renderer.
    `void` | `encodeMetaComponent(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, String metaComponentId)`
    `protected void` | `encodeSelectionStateInput(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)`
    `void` | `encodeTree(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)`
    `protected String` | `getAjaxSubmitFunction(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)`
    `protected Object` | `getClientEventHandlers(javax.faces.context.FacesContext facesContext)`
    `protected String` | `getSelectionStateInputId(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)`
    `protected SwitchType` | `getSelectionType(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)`

    - ### Methods inherited from class org.richfaces.renderkit.RendererBase

      `concatClasses, concatStyles, decode, doEncodeBegin, doEncodeChildren, doEncodeEnd, encodeBegin, encodeChildren, encodeEnd, getComponentClass, getResourcePath, getSkin, getUtils, isAlreadyRendered, preDecode, preEncodeBegin, queueComponentEventForBehaviorEvent, renderChildren`

    - ### 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`

- - ### Constructor Detail

    - #### TreeRendererBase

          public TreeRendererBase()

  - ### Method Detail

    - #### encodeTree

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

      Throws:
        `IOException`

    - #### getAjaxSubmitFunction

          protected String getAjaxSubmitFunction(javax.faces.context.FacesContext context,
                                     javax.faces.component.UIComponent component)

    - #### encodeSelectionStateInput

          protected void encodeSelectionStateInput(javax.faces.context.FacesContext context,
                                       javax.faces.component.UIComponent component)
                                            throws IOException

      Throws:
        `IOException`

    - #### getSelectionStateInputId

          protected String getSelectionStateInputId(javax.faces.context.FacesContext context,
                                        javax.faces.component.UIComponent component)

    - #### getSelectionType

          protected SwitchType getSelectionType(javax.faces.context.FacesContext context,
                                    javax.faces.component.UIComponent component)

    - #### encodeMetaComponent

          public void encodeMetaComponent(javax.faces.context.FacesContext context,
                                 javax.faces.component.UIComponent component,
                                 String metaComponentId)
                                   throws IOException

      Specified by:
        `encodeMetaComponent` in interface `MetaComponentRenderer`
      Throws:
        `IOException`

    - #### decodeMetaComponent

          public void decodeMetaComponent(javax.faces.context.FacesContext context,
                                 javax.faces.component.UIComponent component,
                                 String metaComponentId)

      Specified by:
        `decodeMetaComponent` in interface `MetaComponentRenderer`

    - #### doDecode

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

      Description copied from class: `RendererBase`
      Template method for custom decoding of concrete renderer. All parameters checking if performed in original `RendererBase.decode(FacesContext, UIComponent)` method.
      Overrides:
        `doDecode` in class `RendererBase`

    - #### createTreeRenderingContext

          protected void createTreeRenderingContext(javax.faces.context.FacesContext context,
                                        javax.faces.component.UIComponent component)

    - #### getClientEventHandlers

          protected Object getClientEventHandlers(javax.faces.context.FacesContext facesContext)

    - #### deleteTreeRenderingContext

          protected void deleteTreeRenderingContext(javax.faces.context.FacesContext context)

Copyright © 2015 JBoss by Red Hat. All Rights Reserved.