org.radeox.macro.list
Interface ListFormatter

All Known Implementing Classes:
AtoZListFormatter, ExampleListFormatter, SimpleList

public interface ListFormatter

List formatter interface. List formatters are loaded via the plugin mechanism.

Version:
$Id: ListFormatter.java,v 1.5 2004/03/01 11:02:13 leo Exp $
Author:
Matthias L. Jugel

Method Summary
 void format(java.io.Writer writer, Linkable current, java.lang.String listComment, java.util.Collection c, java.lang.String emptyText, boolean showSize)
          Display a simple vertical list.
 java.lang.String getName()
           
 

Method Detail

getName

public java.lang.String getName()

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
Display a simple vertical list.

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.