org.mmbase.bridge.jsp.taglib

Class WriterHelper

java.lang.Object

org.mmbase.bridge.jsp.taglib.WriterHelper

public class WriterHelper
extends Object

Tags that are Writers can use the this class. It's a pitty that they can't extend, but that's life.

Version:

$Id$

Author:

Michiel Meeuwissen

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	WriterHelper.StackEntry

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	IMPLICITLIST
static boolean	NOIMPLICITLIST
static String	STACK_ATTRIBUTE
(package private) static int	TYPE_BOOLEAN
(package private) static int	TYPE_BYTES
(package private) static int	TYPE_CHARSEQUENCE
(package private) static int	TYPE_CLOUD
(package private) static int	TYPE_DATE
(package private) static int	TYPE_DECIMAL
(package private) static int	TYPE_DOUBLE
(package private) static int	TYPE_FIELD
(package private) static int	TYPE_FIELDVALUE
(package private) static int	TYPE_FILEITEM
(package private) static int	TYPE_FLOAT
(package private) static int	TYPE_INTEGER
(package private) static int	TYPE_LIST
(package private) static int	TYPE_LONG
(package private) static int	TYPE_NODE
(package private) static int	TYPE_OBJECT
(package private) static int	TYPE_SET
static int	TYPE_STRING
(package private) static int	TYPE_TRANSACTION
(package private) static int	TYPE_UNKNOWN
(package private) static int	TYPE_UNSET
(package private) static int	TYPE_VECTOR

Constructor Summary

Constructors

Constructor and Description
WriterHelper(ContextReferrerTag tag)

Method Summary

Modifier and Type	Method and Description
int	doAfterBody()
int	doEndTag() A basic doEndTag for Writers.
void	doFinally()
String	getEscape() Gets specified escaper (as a string) or null (if not set)
CharTransformer	getEscaper()
String	getJspvar()
protected Writer	getPageString(Writer w) Returns a string which can be written to the page.
protected WriterHelper.StackEntry	getStackEntry() How to wrap the values when they are stored somewhere.
String	getString()
Object	getValue()
int	getVartype()
Attribute	getWrite()
void	haveBody() To be called by subtags.
void	initTag() Reset to initial values
boolean	isWrite()
void	overrideNoImplicitList()
void	overrideWrite(boolean w) There is a default behavior for what should happen if the 'write' attribute is not set.
void	setEscape(Attribute e) For implementation of the escape attribute.
void	setJspvar(javax.servlet.jsp.PageContext p) Deprecated. jspvar will be set by setValue then
void	setJspvar(String j)
void	setListdelimiter(Attribute l)
void	setUse_Stack(boolean b)
void	setValue(Object v) Sets the vartype for this variable (used for jspvar as well as for taglib var).
void	setValue(Object v, boolean noImplicitList)
void	setValueOnly(Object v, boolean noImplicitList) Sets only the value in the helper, withouth setting the _Stack
void	setVartype(String t)
void	setWrite(Attribute w) For implementation of the write attribute.
void	setWrite(Boolean b) Deprecated. Use setWrite(Attribute)
(package private) static int	stringToType(String tt)
void	useEscaper(boolean ue) Some writer tags produce very specific content, and take care of escaping themselves (UrlTag).
protected Object	wrap(WriterHelper.StackEntry se) How to wrap the values when they are stored somewhere.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NOIMPLICITLIST

public static final boolean NOIMPLICITLIST

See Also:

Constant Field Values

IMPLICITLIST

public static final boolean IMPLICITLIST

See Also:

Constant Field Values

STACK_ATTRIBUTE

public static final String STACK_ATTRIBUTE

See Also:

Constant Field Values

TYPE_UNKNOWN

static final int TYPE_UNKNOWN

See Also:

Constant Field Values

TYPE_UNSET

static final int TYPE_UNSET

See Also:

Constant Field Values

TYPE_OBJECT

static final int TYPE_OBJECT

See Also:

Constant Field Values

TYPE_LIST

static final int TYPE_LIST

See Also:

Constant Field Values

TYPE_VECTOR

static final int TYPE_VECTOR

See Also:

Constant Field Values

TYPE_INTEGER

static final int TYPE_INTEGER

See Also:

Constant Field Values

TYPE_STRING

public static final int TYPE_STRING

See Also:

Constant Field Values

TYPE_BYTES

static final int TYPE_BYTES

See Also:

Constant Field Values

TYPE_DOUBLE

static final int TYPE_DOUBLE

See Also:

Constant Field Values

TYPE_LONG

static final int TYPE_LONG

See Also:

Constant Field Values

TYPE_FLOAT

static final int TYPE_FLOAT

See Also:

Constant Field Values

TYPE_DECIMAL

static final int TYPE_DECIMAL

See Also:

Constant Field Values

TYPE_DATE

static final int TYPE_DATE

See Also:

Constant Field Values

TYPE_SET

static final int TYPE_SET

See Also:

Constant Field Values

TYPE_NODE

static final int TYPE_NODE

See Also:

Constant Field Values

TYPE_CLOUD

static final int TYPE_CLOUD

See Also:

Constant Field Values

TYPE_TRANSACTION

static final int TYPE_TRANSACTION

See Also:

Constant Field Values

TYPE_FIELD

static final int TYPE_FIELD

See Also:

Constant Field Values

TYPE_FIELDVALUE

static final int TYPE_FIELDVALUE

See Also:

Constant Field Values

TYPE_BOOLEAN

static final int TYPE_BOOLEAN

See Also:

Constant Field Values

TYPE_CHARSEQUENCE

static final int TYPE_CHARSEQUENCE

See Also:

Constant Field Values

TYPE_FILEITEM

static final int TYPE_FILEITEM

See Also:

Constant Field Values

Constructor Detail

WriterHelper

public WriterHelper(ContextReferrerTag tag)

Method Detail

stringToType

static int stringToType(String tt)

setUse_Stack

public void setUse_Stack(boolean b)

Since:

MMBase-1.9.1

initTag

public void initTag()

Reset to initial values

setWrite

public void setWrite(Attribute w)

For implementation of the write attribute.

getWrite

public Attribute getWrite()

Since:

MMBase-1.7

setEscape

public void setEscape(Attribute e)

For implementation of the escape attribute.

Since:

MMBase-1.7

setWrite

public void setWrite(Boolean b)

Deprecated. Use setWrite(Attribute)

overrideNoImplicitList

public void overrideNoImplicitList()

overrideWrite

public void overrideWrite(boolean w)

There is a default behavior for what should happen if the 'write' attribute is not set. if you want to override this, then call this function.

useEscaper

public void useEscaper(boolean ue)

Some writer tags produce very specific content, and take care of escaping themselves (UrlTag). They turn off escaping (on default).

isWrite

public boolean isWrite()
                throws javax.servlet.jsp.JspTagException

Throws:

javax.servlet.jsp.JspTagException

setJspvar

public void setJspvar(String j)

setJspvar

public void setJspvar(javax.servlet.jsp.PageContext p)
               throws javax.servlet.jsp.JspTagException

Deprecated. jspvar will be set by setValue then

Throws:

javax.servlet.jsp.JspTagException

getJspvar

public String getJspvar()

setValue

public void setValue(Object v)
              throws javax.servlet.jsp.JspTagException

Sets the vartype for this variable (used for jspvar as well as for taglib var). Some 'casting' functionality is present here.

Throws:

javax.servlet.jsp.JspTagException

getEscape

public String getEscape()
                 throws javax.servlet.jsp.JspTagException

Gets specified escaper (as a string) or null (if not set)

Throws:

javax.servlet.jsp.JspTagException

Since:

MMBase-1.7

getEscaper

public CharTransformer getEscaper()
                           throws javax.servlet.jsp.JspTagException

Throws:

javax.servlet.jsp.JspTagException

Since:

MMBase-1.8

setValueOnly

public void setValueOnly(Object v,
                         boolean noImplicitList)
                  throws javax.servlet.jsp.JspTagException

Sets only the value in the helper, withouth setting the _Stack

Throws:

javax.servlet.jsp.JspTagException

Since:

MMBase-1.8

wrap

protected Object wrap(WriterHelper.StackEntry se)

How to wrap the values when they are stored somewhere.

Since:

MMBase-1.9.2

getStackEntry

protected WriterHelper.StackEntry getStackEntry()
                                         throws javax.servlet.jsp.JspTagException

How to wrap the values when they are stored somewhere.

Throws:

javax.servlet.jsp.JspTagException

Since:

MMBase-1.9.2

setValue

public void setValue(Object v,
                     boolean noImplicitList)
              throws javax.servlet.jsp.JspTagException

Throws:

javax.servlet.jsp.JspTagException

getValue

public Object getValue()

setVartype

public void setVartype(String t)
                throws javax.servlet.jsp.JspTagException

Throws:

javax.servlet.jsp.JspTagException

setListdelimiter

public final void setListdelimiter(Attribute l)

Since:

MMBase-1.8

getVartype

public int getVartype()

getPageString

protected Writer getPageString(Writer w)
                        throws javax.servlet.jsp.JspTagException,
                               IOException

Returns a string which can be written to the page.

Throws:

javax.servlet.jsp.JspTagException

IOException

haveBody

public void haveBody()

To be called by subtags. Even if they don't produce output, they say that the tag had a body.

getString

public String getString()

doAfterBody

public int doAfterBody()
                throws javax.servlet.jsp.JspTagException

Throws:

javax.servlet.jsp.JspTagException

Since:

MMBase-1.7

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspTagException

A basic doEndTag for Writers. It decides if to write or not, and then does that or not. It also pops the _-stack, and releases the members for gc.

Throws:

javax.servlet.jsp.JspTagException

doFinally

public void doFinally()