/*
 * This file is part of "SnipSnap Radeox Rendering Engine".
 *
 * Copyright (c) 2002 Stephan J. Schmidt, Matthias L. Jugel
 * All Rights Reserved.
 *
 * Please visit http://radeox.org/ for updates and contact.
 *
 * --LICENSE NOTICE--
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * --LICENSE NOTICE--
 */
package org.radeox.macro.list;

import java.io.IOException;
import java.io.Writer;
import java.util.Collection;

import org.radeox.util.Linkable;

/**
 * List formatter interface. List formatters are loaded via the plugin
 * mechanism.
 * 
 * @author Matthias L. Jugel
 * @version $Id: ListFormatter.java 7707 2006-04-12 17:30:19Z
 *          ian@caret.cam.ac.uk $
 */
public interface ListFormatter
{
	public String getName();

	/**
	 * Display a simple vertical list.
	 * 
	 * @param writer
	 *        Writer to write the list output to
	 * @param current
	 *        the current linkable
	 * @param listComment
	 *        String to display before the list
	 * @param c
	 *        Collection of Linkables, Snips or Nameables to display
	 * @param emptyText
	 *        Text to display if collection is empty
	 * @param showSize
	 *        If showSize is true then the size of the collection is displayed
	 */
	public void format(Writer writer, Linkable current, String listComment,
			Collection c, String emptyText, boolean showSize)
			throws IOException;
}
