org.apache.struts.taglib.bean
Class WriteTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      org.apache.struts.taglib.bean.WriteTag

All Implemented Interfaces:

Serializable, IterationTag, Tag

Direct Known Subclasses:

NestedWriteTag

public class WriteTag
extends TagSupport

Tag that retrieves the specified property of the specified bean, converts it to a String representation (if necessary), and writes it to the current output stream, optionally filtering characters that are sensitive in HTML.

Version:

$Rev: 471754 $ $Date: 2004-10-16 12:38:42 -0400 (Sat, 16 Oct 2004) $

See Also:

Serialized Form

Field Summary

protected String	bundle The servlet context attribute key for our resources.
static String	DATE_FORMAT_KEY The key to search default format string for java.util.Date in resources.
protected boolean	filter Filter the rendered output for characters that are sensitive in HTML?
static String	FLOAT_FORMAT_KEY The key to search default format string for float (double, BigDecimal) in resources.
protected String	formatKey The key to search format string in applciation resources
protected String	formatStr The format string to be used as format to convert value to String.
protected boolean	ignore Should we ignore missing beans and simply output nothing?
static String	INT_FORMAT_KEY The key to search default format string for int (byte, short, etc.) in resources.
protected String	localeKey The session scope key under which our Locale is stored.
protected static MessageResources	messages The message resources for this package.
protected String	name Name of the bean that contains the data we will be rendering.
protected String	property Name of the property to be accessed on the specified bean.
protected String	scope The scope to be searched to retrieve the specified bean.
static String	SQL_DATE_FORMAT_KEY The key to search default format string for java.sql.Date in resources.
static String	SQL_TIME_FORMAT_KEY The key to search default format string for java.sql.Time in resources.
static String	SQL_TIMESTAMP_FORMAT_KEY The key to search default format string for java.sql.Timestamp in resources.

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

WriteTag()

Method Summary

int	doStartTag() Process the start tag.
protected String	formatValue(Object valueToFormat) Format value according to specified format string (as tag attribute or as string from message resources) or to current user locale.
String	getBundle()
boolean	getFilter()
String	getFormat()
String	getFormatKey()
boolean	getIgnore()
String	getLocale()
String	getName()
String	getProperty()
String	getScope()
void	release() Release all allocated resources.
protected String	retrieveFormatString(String formatKey) Retrieve format string from message bundle and return null if message not found or message string.
void	setBundle(String bundle)
void	setFilter(boolean filter)
void	setFormat(String formatStr)
void	setFormatKey(String formatKey)
void	setIgnore(boolean ignore)
void	setLocale(String localeKey)
void	setName(String name)
void	setProperty(String property)
void	setScope(String scope)

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Field Detail

SQL_TIMESTAMP_FORMAT_KEY

public static final String SQL_TIMESTAMP_FORMAT_KEY

The key to search default format string for java.sql.Timestamp in resources.

See Also:

Constant Field Values

SQL_DATE_FORMAT_KEY

public static final String SQL_DATE_FORMAT_KEY

The key to search default format string for java.sql.Date in resources.

See Also:

Constant Field Values

SQL_TIME_FORMAT_KEY

public static final String SQL_TIME_FORMAT_KEY

The key to search default format string for java.sql.Time in resources.

See Also:

Constant Field Values

DATE_FORMAT_KEY

public static final String DATE_FORMAT_KEY

The key to search default format string for java.util.Date in resources.

See Also:

Constant Field Values

INT_FORMAT_KEY

public static final String INT_FORMAT_KEY

The key to search default format string for int (byte, short, etc.) in resources.

See Also:

Constant Field Values

FLOAT_FORMAT_KEY

public static final String FLOAT_FORMAT_KEY

The key to search default format string for float (double, BigDecimal) in resources.

See Also:

Constant Field Values

messages

protected static MessageResources messages

The message resources for this package.

filter

protected boolean filter

Filter the rendered output for characters that are sensitive in HTML?

ignore

protected boolean ignore

Should we ignore missing beans and simply output nothing?

name

protected String name

Name of the bean that contains the data we will be rendering.

property

protected String property

Name of the property to be accessed on the specified bean.

scope

protected String scope

The scope to be searched to retrieve the specified bean.

formatStr

protected String formatStr

The format string to be used as format to convert value to String.

formatKey

protected String formatKey

The key to search format string in applciation resources

localeKey

protected String localeKey

The session scope key under which our Locale is stored.

bundle

protected String bundle

The servlet context attribute key for our resources.

Constructor Detail

WriteTag

public WriteTag()

Method Detail

getFilter

public boolean getFilter()

setFilter

public void setFilter(boolean filter)

getIgnore

public boolean getIgnore()

setIgnore

public void setIgnore(boolean ignore)

getName

public String getName()

setName

public void setName(String name)

getProperty

public String getProperty()

setProperty

public void setProperty(String property)

getScope

public String getScope()

setScope

public void setScope(String scope)

getFormat

public String getFormat()

setFormat

public void setFormat(String formatStr)

getFormatKey

public String getFormatKey()

setFormatKey

public void setFormatKey(String formatKey)

getLocale

public String getLocale()

setLocale

public void setLocale(String localeKey)

getBundle

public String getBundle()

setBundle

public void setBundle(String bundle)

doStartTag

public int doStartTag()
               throws JspException

Process the start tag.

Specified by:

doStartTag in interface Tag

Overrides:

doStartTag in class TagSupport

Throws:

JspException - if a JSP exception has occurred

retrieveFormatString

protected String retrieveFormatString(String formatKey)
                               throws JspException

Retrieve format string from message bundle and return null if message not found or message string.

Parameters:

formatKey - value to use as key to search message in bundle

Throws:

JspException - if a JSP exception has occurred

formatValue

protected String formatValue(Object valueToFormat)
                      throws JspException

Format value according to specified format string (as tag attribute or as string from message resources) or to current user locale. When a format string is retrieved from the message resources, applyLocalizedPattern is used. For more about localized patterns, see . (To obtain the correct value for some characters, you may need to view the file in a hex editor and then use the Unicode escape form in the property resources file.)

Parameters:

valueToFormat - value to process and convert to String

Throws:

JspException - if a JSP exception has occurred

release

public void release()

Release all allocated resources.

Specified by:

release in interface Tag

Overrides:

release in class TagSupport