org.apache.struts.taglib.bean

Class WriteTag

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: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $

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?
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.
static String	FLOAT_FORMAT_KEY The key to search default format string for float (double, BigDecimal) in resources.
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_TIMESTAMP_FORMAT_KEY The key to search default format string for java.sql.Timestamp in resources.
static String	SQL_TIME_FORMAT_KEY The key to search default format string for java.sql.Time in resources.

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)

Field Detail

bundle

protected String bundle

The servlet context attribute key for our resources.

DATE_FORMAT_KEY

public static final String DATE_FORMAT_KEY

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

filter

protected boolean filter

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

formatKey

protected String formatKey

The key to search format string in applciation resources

formatStr

protected String formatStr

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

FLOAT_FORMAT_KEY

public static final String FLOAT_FORMAT_KEY

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

ignore

protected boolean ignore

Should we ignore missing beans and simply output nothing?

INT_FORMAT_KEY

public static final String INT_FORMAT_KEY

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

localeKey

protected String localeKey

The session scope key under which our Locale is stored.

messages

protected static MessageResources messages

The message resources for this package.

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.

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.

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.

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.

Method Detail

doStartTag

public int doStartTag()

Process the start tag.

Throws: JspException if a JSP exception has occurred

formatValue

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. 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

Parameters: formatKey value to use as key to search message in bundle

Throws: JspException if a JSP exception has occurred