1 ////////////////////////////////////////////////////////////////////////////////
2 // MillScript: an Open Spice interpreter and batch website creation tool
3 // Copyright (C) 2001-2005 Open World Ltd
4 // Copyright (C) 2005 Kevin Rogers
5 //
6 // This file is part of MillScript.
7 //
8 // MillScript is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU General Public License as published by the Free
10 // Software Foundation; either version 2 of the License, or (at your option)
11 // any later version.
12 //
13 // MillScript is distributed in the hope that it will be useful, but WITHOUT
14 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 // FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 // more details.
17 //
18 // You should have received a copy of the GNU General Public License along with
19 // MillScript; if not, write to the Free Software Foundation, Inc., 59 Temple
20 // Place, Suite 330, Boston, MA 02111-1307 USA
21 ////////////////////////////////////////////////////////////////////////////////
22 package org.millscript.millscript.render;
23
24 import java.io.IOException;
25
26 /**
27 * This interface is implemented by objects which need to customise their
28 * rendering.
29 */
30 public interface Renderable {
31
32 /**
33 * This method is called to render the implementing object to the specified
34 * renderer.
35 * <p>
36 * If the implementing object is not a core part of MillScript you may need
37 * to query what type of renderer it is, so you can further customise your
38 * rendering as appropriate.
39 * </p>
40 *
41 * @param r the renderer to render this object with
42 * @throws IOException thrown if an IO problem occurs
43 */
44 public void render( final Renderer r ) throws IOException;
45
46 }