KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > examples > HelloSnipMacro


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
26 package examples;
27
28 import org.snipsnap.render.context.SnipRenderContext;
29 import org.snipsnap.render.macro.SnipMacro;
30 import org.snipsnap.render.macro.parameter.SnipMacroParameter;
31 import org.snipsnap.snip.Snip;
32
33 import java.io.IOException JavaDoc;
34 import java.io.Writer JavaDoc;
35
36 /**
37  * Example which shows howto get the Snip from the context.
38  *
39  * @author Stephan J. Schmidt
40  * @version $Id: HelloSnipMacro.java 1606 2004-05-17 10:56:18Z leo $
41  */
42
43 // cut:start-1
44 public class HelloSnipMacro extends SnipMacro {
45
46   public void execute(Writer JavaDoc writer, SnipMacroParameter params)
47     throws IllegalArgumentException JavaDoc, IOException JavaDoc {
48
49     SnipRenderContext context = params.getSnipRenderContext();
50     Snip snip = (Snip)
51         context.getAttribute(SnipRenderContext.SNIP);
52     writer.write("hello, my name is "+snip.getName());
53   }
54
55
56   public String JavaDoc getName() {
57     return "hello-snip";
58   }
59 }
60 // cut:end-1
61
Popular Tags