KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > mmbase > bridge > jsp > taglib > Writer


1 /*
2
3 This software is OSI Certified Open Source Software.
4 OSI Certified is a certification mark of the Open Source Initiative.
5
6 The license (Mozilla version 1.0) can be read at the MMBase site.
7 See http://www.MMBase.org/license
8
9 */

10 package org.mmbase.bridge.jsp.taglib;
11 import javax.servlet.jsp.JspTagException JavaDoc;
12
13 /**
14  * Writer tag are tags which can write something to the page (or to
15  * something else). To ensure a common behavior, this interface is
16  * created.
17  *
18  * Tags implementing this interface can (should?) use 'WriterHelper'
19  * for a quick implementation.
20  *
21  * @author Michiel Meeuwissen
22  * @version $Id: Writer.java,v 1.10 2003/06/06 10:03:10 pierre Exp $
23  */

24
25 public interface Writer {
26
27     /**
28      * Wether to write to page or not. This has to default to 'false'
29      * if the tag has a body, and to 'true' if it hasn't.
30      *
31      */

32     public void setWrite(String JavaDoc t) throws JspTagException JavaDoc;
33
34
35     /**
36      * (Override) escape behaviour
37      *
38      */

39     public void setEscape(String JavaDoc e) throws JspTagException JavaDoc;
40
41     /**
42      * JspVar to Create, and write to
43      */

44     public void setJspvar(String JavaDoc j);
45
46     /**
47      * Type of the jspvar.
48      */

49
50     public void setVartype(String JavaDoc t) throws JspTagException JavaDoc;
51
52     /**
53      * Subtags of 'Writer' tag can request the value.
54      */

55
56     public Object JavaDoc getWriterValue() throws JspTagException JavaDoc;
57
58     /**
59      * To be used by child tags. If they are present, they say to the
60      * writer tag that it has body, which it can use to determine a
61      * default for the write property.
62      *
63      * @since MMBase-1.6
64      */

65     public void haveBody() throws JspTagException JavaDoc;
66
67
68 }
69
Popular Tags