Package org.radeox.macro.list

Class AtoZListFormatter

java.lang.Object

org.radeox.macro.list.AtoZListFormatter

All Implemented Interfaces:

ListFormatter

public class AtoZListFormatter
extends Object
implements ListFormatter

Formats a list as AtoZ listing separated by the alphabetical characters.

Version:

$Id: AtoZListFormatter.java 7707 2006-04-12 17:30:19Z ian@caret.cam.ac.uk $

Author:

Matthias L. Jugel

Constructor Summary

Constructors

Constructor	Description
AtoZListFormatter()

Method Summary

Modifier and Type	Method	Description
void	format(Writer writer, Linkable current, String listComment, Collection c, String emptyText, boolean showSize)	Create an A to Z index
String	getName()

Methods inherited from class java.lang.Object

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

Constructor Detail

AtoZListFormatter

public AtoZListFormatter()

Method Detail

getName

public String getName()

Specified by:

getName in interface ListFormatter

format

public void format(Writer writer,
                   Linkable current,
                   String listComment,
                   Collection c,
                   String emptyText,
                   boolean showSize)
            throws IOException

Create an A to Z index

Specified by:

format in interface ListFormatter

Parameters:

writer - Writer to write the list output to

current - the current linkable

listComment - String to display before the list

c - Collection of Linkables, Snips or Nameables to display

emptyText - Text to display if collection is empty

showSize - If showSize is true then the size of the collection is displayed

Throws:

IOException