org.sakaiproject.jsf.renderer

Class AlphaIndexRenderer

java.lang.Object

javax.faces.render.Renderer

org.sakaiproject.jsf.renderer.AlphaIndexRenderer

public class AlphaIndexRenderer
extends Renderer

Description:

Render an alphabetical index. Makes any letter that exists in the initials parameter a link.

Copyright: Copyright (c) 2004

Organization: Sakai Project

Version:

$Id$

Author:

Ed Smiley

Constructor Summary

Constructors

Constructor and Description
AlphaIndexRenderer()

Method Summary

Modifier and Type	Method and Description
void	decode(FacesContext context, UIComponent component)
void	encodeBegin(FacesContext context, UIComponent component)
void	encodeChildren(FacesContext context, UIComponent component)
void	encodeEnd(FacesContext context, UIComponent component) Render an alphabetical index.
boolean	supportsComponentType(UIComponent component)

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

AlphaIndexRenderer

public AlphaIndexRenderer()

Method Detail

supportsComponentType

public boolean supportsComponentType(UIComponent component)

decode

public void decode(FacesContext context,
                   UIComponent component)

Overrides:

decode in class Renderer

encodeBegin

public void encodeBegin(FacesContext context,
                        UIComponent component)
                 throws IOException

Overrides:

encodeBegin in class Renderer

Throws:

IOException

encodeChildren

public void encodeChildren(FacesContext context,
                           UIComponent component)
                    throws IOException

Overrides:

encodeChildren in class Renderer

Throws:

IOException

encodeEnd

public void encodeEnd(FacesContext context,
                      UIComponent component)
               throws IOException

Render an alphabetical index. Makes any letter that exists in the initials parameter a link. Any other is simply displayed.

Example:
| <a href='#A'><b>A</b></a> | <b>B</b>...

Overrides:

encodeEnd in class Renderer

Parameters:

context - FacesContext for the request we are processing

component - UIComponent to be rendered

Throws:

IOException - if an input/output error occurs while rendering

NullPointerException - if context or component is null