org.apache.myfaces.custom.datascroller
Class HtmlDataScrollerRenderer

java.lang.Object
  extended by javax.faces.render.Renderer
      extended by org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlRenderer
          extended by org.apache.myfaces.custom.datascroller.HtmlDataScrollerRenderer

public class HtmlDataScrollerRenderer
extends org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlRenderer

Renderer for the HtmlDataScroller component.

Version:
$Revision: 382051 $ $Date: 2006-03-01 10:25:41 -0500 (Wed, 01 Mar 2006) $
Author:
Thomas Spiegl (latest modification by $Author: schof $)

Field Summary
protected static java.lang.String PAGE_NAVIGATION
           
static java.lang.String RENDERER_TYPE
           
 
Constructor Summary
HtmlDataScrollerRenderer()
           
 
Method Summary
 void decode(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
          Determine which datascroller navigation option the user chose (if any), and if they did then queue the appropriate ScrollerActionEvent for later execution.
 void encodeBegin(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent)
           
 void encodeChildren(javax.faces.context.FacesContext facescontext, javax.faces.component.UIComponent uicomponent)
           
 void encodeEnd(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent)
           
protected  javax.faces.component.html.HtmlCommandLink getLink(javax.faces.context.FacesContext facesContext, HtmlDataScroller scroller, java.lang.String facetName)
           
protected  javax.faces.component.html.HtmlCommandLink getLink(javax.faces.context.FacesContext facesContext, HtmlDataScroller scroller, java.lang.String text, int pageIndex)
           
 boolean getRendersChildren()
           
 void removeVariables(javax.faces.context.FacesContext facescontext, HtmlDataScroller scroller)
           
protected  void renderFacet(javax.faces.context.FacesContext facesContext, HtmlDataScroller scroller, javax.faces.component.UIComponent facetComp, java.lang.String facetName)
           
protected  void renderPaginator(javax.faces.context.FacesContext facesContext, HtmlDataScroller scroller)
          The "paginator" is a sequence of page numbers which the user can click on to leap directly to a specific page of data.
protected  void renderScroller(javax.faces.context.FacesContext facesContext, HtmlDataScroller scroller)
           
protected  void setVariables(javax.faces.context.FacesContext facescontext, HtmlDataScroller scroller)
          Expose much of the internal state of this component so that UIComponents nested within this component can very flexibly display the component state to the user.
 
Methods inherited from class org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlRenderer
getActionUrl, getChildCount, getChildren
 
Methods inherited from class javax.faces.render.Renderer
convertClientId, getConvertedValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE
See Also:
Constant Field Values

PAGE_NAVIGATION

protected static final java.lang.String PAGE_NAVIGATION
Constructor Detail

HtmlDataScrollerRenderer

public HtmlDataScrollerRenderer()
Method Detail

getRendersChildren

public boolean getRendersChildren()
Overrides:
getRendersChildren in class javax.faces.render.Renderer

decode

public void decode(javax.faces.context.FacesContext context,
                   javax.faces.component.UIComponent component)
Determine which datascroller navigation option the user chose (if any), and if they did then queue the appropriate ScrollerActionEvent for later execution.

Overrides:
decode in class javax.faces.render.Renderer

setVariables

protected void setVariables(javax.faces.context.FacesContext facescontext,
                            HtmlDataScroller scroller)
                     throws java.io.IOException
Expose much of the internal state of this component so that UIComponents nested within this component can very flexibly display the component state to the user.

Throws:
java.io.IOException

removeVariables

public void removeVariables(javax.faces.context.FacesContext facescontext,
                            HtmlDataScroller scroller)
                     throws java.io.IOException
Throws:
java.io.IOException

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext facesContext,
                        javax.faces.component.UIComponent uiComponent)
                 throws java.io.IOException
Overrides:
encodeBegin in class javax.faces.render.Renderer
Throws:
java.io.IOException

encodeChildren

public void encodeChildren(javax.faces.context.FacesContext facescontext,
                           javax.faces.component.UIComponent uicomponent)
                    throws java.io.IOException
Overrides:
encodeChildren in class javax.faces.render.Renderer
Throws:
java.io.IOException

encodeEnd

public void encodeEnd(javax.faces.context.FacesContext facesContext,
                      javax.faces.component.UIComponent uiComponent)
               throws java.io.IOException
Overrides:
encodeEnd in class javax.faces.render.Renderer
Throws:
java.io.IOException

renderScroller

protected void renderScroller(javax.faces.context.FacesContext facesContext,
                              HtmlDataScroller scroller)
                       throws java.io.IOException
Throws:
java.io.IOException

renderFacet

protected void renderFacet(javax.faces.context.FacesContext facesContext,
                           HtmlDataScroller scroller,
                           javax.faces.component.UIComponent facetComp,
                           java.lang.String facetName)
                    throws java.io.IOException
Throws:
java.io.IOException

renderPaginator

protected void renderPaginator(javax.faces.context.FacesContext facesContext,
                               HtmlDataScroller scroller)
                        throws java.io.IOException
The "paginator" is a sequence of page numbers which the user can click on to leap directly to a specific page of data.

Throws:
java.io.IOException

getLink

protected javax.faces.component.html.HtmlCommandLink getLink(javax.faces.context.FacesContext facesContext,
                                                             HtmlDataScroller scroller,
                                                             java.lang.String text,
                                                             int pageIndex)

getLink

protected javax.faces.component.html.HtmlCommandLink getLink(javax.faces.context.FacesContext facesContext,
                                                             HtmlDataScroller scroller,
                                                             java.lang.String facetName)


Copyright 2006 Apache Software Foundation. All Rights Reserved.