ListFormatter


1   /*
2    * This file is part of "SnipSnap Radeox Rendering Engine".
3    *
4    * Copyright (c) 2002 Stephan J. Schmidt, Matthias L. Jugel
5    * All Rights Reserved.
6    *
7    * Please visit http://radeox.org/ for updates and contact.
8    *
9    * --LICENSE NOTICE--
10   * This library is free software; you can redistribute it and/or
11   * modify it under the terms of the GNU Lesser General Public
12   * License as published by the Free Software Foundation; either
13   * version 2.1 of the License, or (at your option) any later version.
14   *
15   * This library is distributed in the hope that it will be useful,
16   * but WITHOUT ANY WARRANTY; without even the implied warranty of
17   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18   * Lesser General Public License for more details.
19   *
20   * You should have received a copy of the GNU Lesser General Public
21   * License along with this library; if not, write to the Free Software
22   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
23   * --LICENSE NOTICE--
24   */
25  package org.snipsnap.render.macro.list;
26  
27  import java.io.IOException  ;
28  import java.io.Writer  ;
29  import java.util.Collection  ;
30  
31  /**
32   * List formatter interface. List formatters are loaded via the plugin mechanism.
33   *
34   * @author Matthias L. Jugel
35   * @version $Id: ListFormatter.java 1606 2004-05-17 10:56:18Z leo $
36   */
37  public interface ListFormatter {
38    public String   getName();
39  
40    /**
41     * Display a simple vertical list.
42     *
43     * @param writer Writer to write the list output to
44     * @param current the current linkable
45     * @param listComment String to display before the list
46     * @param c Collection of Linkables, Snips or Nameables to display
47     * @param emptyText Text to display if collection is empty
48     * @param showSize If showSize is true then the size of the collection is displayed
49     */
50    public void format(Writer   writer,
51                       Linkable current,
52                       String   listComment,
53                       Collection   c,
54                       String   emptyText,
55                       boolean showSize)
56        throws IOException  ;
57  }
58
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags