net.windward.tags
Class EscapeTag

net.windward.tags.BaseTag
  |
  +--net.windward.tags.EscapeTag

public class EscapeTag

extends BaseTag

Output anything in the final report. This tag represents a <wr:escape ...> in the template. The full usage is <wr:escape select="./name" type="rtf"/> which will place the text in the referenced node in the final report exactly as is. Windward Reports does not parse the string and has no idea what it is doing.
With freedom comes responsibility. This command gives you the ability to totally honk up the final report.
The full list of attributes is:

• select - required - the node whose text will be substituted in.
• type - required - the report type that this will be substituted in on. The allowed values are ALL, RTF, HTM, and TXT. (pdf files are not stream based and therefore an escape makes no sense in them.)

It is an error to enter <wr:escape select="./name" type="rtf"> ... </wr:escape>
This tag follows the jstl example of c:out and x:out.

Version:

2.0 November 1, 2003

Field Summary

static java.lang.String	TYPE_ALL
static java.lang.String	TYPE_HTM
static java.lang.String	TYPE_RTF
static java.lang.String	TYPE_TXT

Fields inherited from class net.windward.tags.BaseTag

CHART, COLUMN, DISPLAY_ALWAYS, DISPLAY_NOT_EMPTY, DISPLAY_NOT_NULL, ELSE, END_FOREACH, END_IF, END_LINK, END_MATRIX, ESCAPE, FOREACH, FUNCTION, HTML, IF, IMPORT, LINK, MATRIX, OUT, PROP_COMMENT, PROP_DATASOURCE, PROP_DEFAULT, PROP_DISPLAY, PROP_ENABLED, PROP_INPUT, PROP_PATTERN, PROP_TITLE, PROP_TYPE, PROP_VAR, PROP_WRAP, QUERY, ROW, SET, TAG_DISPLAY_DEFAULT, TAG_DISPLAY_SELECT, TAG_DISPLAY_TAG, TYPE_BITMAP, TYPE_BOTH, TYPE_CURRENCY, TYPE_DATE, TYPE_NUMBER, TYPE_PERCENT, TYPE_TIME, WRAP_BEHIND, WRAP_FRONT, WRAP_INLINE, WRAP_SQUARE

Constructor Summary

EscapeTag(java.util.Map map, boolean selfContained, boolean ignoreErrors)
Create an escape element using the passed in map values.

Method Summary

net.windward.document.Element	dup(boolean sameRefId) Makes a duplicate of this object.
int	getXmlType() Returns which type of xml element this is.
java.lang.String	toDisplay(int type) How this node is displayed on the page when in a field.
java.lang.String	toString() Returns this object as a string in the format "html:...".
java.lang.String	toText() Converts this node back in to it's string representation in the document

Methods inherited from class net.windward.tags.BaseTag

containsAttribute, factory, factory, getAttribute, getAttributes, getBean, getDatasource, getIntAttribute, getLevel, getMode, getNode, getType, setLevel, setNode, toTagText

Field Detail

TYPE_ALL

public static final java.lang.String TYPE_ALL

TYPE_HTM

public static final java.lang.String TYPE_HTM

TYPE_RTF

public static final java.lang.String TYPE_RTF

TYPE_TXT

public static final java.lang.String TYPE_TXT

Constructor Detail

EscapeTag

public EscapeTag(java.util.Map map,
                 boolean selfContained,
                 boolean ignoreErrors)
          throws TagException

Create an escape element using the passed in map values.

Parameters:

map - Must have a select and type entry.

selfContained - Must be true.

ignoreErrors - create even if some attributes are bad.

Throws:

TagException - thrown if illegal parameters passed in.

Method Detail

toText

public java.lang.String toText()
                        throws TagException

Converts this node back in to it's string representation in the document

Overrides:

toText in class BaseTag

Returns:

<wr:escape ... /> type string.

toDisplay

public java.lang.String toDisplay(int type)

How this node is displayed on the page when in a field.

Overrides:

toDisplay in class BaseTag

Parameters:

type - One of the DISPLAY_* constants

Returns:

title, end of select, or <cmd> type string.

dup

public net.windward.document.Element dup(boolean sameRefId)

Makes a duplicate of this object. A deep clone is done so the new object shares nothing with the original object.

Parameters:

sameRefId -

Returns:

The new duplicate of this object

getXmlType

public int getXmlType()

Returns which type of xml element this is.

Overrides:

getXmlType in class BaseTag

Returns:

NODE_ESCAPE

toString

public java.lang.String toString()

Returns this object as a string in the format "html:...".

Returns:

A String listing this element.