org.radeox.macro.list
Class AtoZListFormatter

java.lang.Object
  extended byorg.radeox.macro.list.AtoZListFormatter
All Implemented Interfaces:
ListFormatter

public class AtoZListFormatter
extends java.lang.Object
implements ListFormatter

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

Version:
$Id: AtoZListFormatter.java,v 1.4 2004/02/16 16:13:20 leo Exp $
Author:
Matthias L. Jugel

Constructor Summary
AtoZListFormatter()
           
 
Method Summary
 void format(java.io.Writer writer, Linkable current, java.lang.String listComment, java.util.Collection c, java.lang.String emptyText, boolean showSize)
          Create an A to Z index
 java.lang.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 java.lang.String getName()
Specified by:
getName in interface ListFormatter

format

public void format(java.io.Writer writer,
                   Linkable current,
                   java.lang.String listComment,
                   java.util.Collection c,
                   java.lang.String emptyText,
                   boolean showSize)
            throws java.io.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:
java.io.IOException


Copyright © 2003 Matthias L. Jugel, Stephan J. Schmidt. All Rights Reserved.