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 7707 2006-04-12 17:30:19Z ian@caret.cam.ac.uk $

Author:

Matthias L. Jugel

Method Summary

Methods

Modifier and Type	Method and Description
void	format(Writer writer, Linkable current, String listComment, Collection c, String emptyText, boolean showSize) Display a simple vertical list.
String	getName()

Method Detail

getName

String getName()

format

void format(Writer writer,
          Linkable current,
          String listComment,
          Collection c,
          String emptyText,
          boolean showSize)
            throws 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:

IOException