com.bea.wlw.netui.tags.databinding.grid.column
Class FormattableColumn

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          com.bea.wlw.netui.tags.AbstractBaseTag
              com.bea.wlw.netui.tags.databinding.base.StructuredBaseTag
                  com.bea.wlw.netui.tags.databinding.grid.GridComponent
                      com.bea.wlw.netui.tags.databinding.grid.column.GridColumn
                          com.bea.wlw.netui.tags.databinding.grid.column.FormattableColumn

All Implemented Interfaces:

Formattable, HtmlConstants, Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

Direct Known Subclasses:

ExpressionColumn, SortFilterColumn

public abstract class FormattableColumn
extends GridColumn
implements Formattable

The abstract base class of a GridColumn that can accept NetUI FormatTag tags. Formatter tags are used to provide a consistent appearance of data that is rendered in a cell in a GridColumn. The value of a data cell is formatted before it is rendered.

See Also:

Formattable, Serialized Form

Field Summary

Fields inherited from class com.bea.wlw.netui.tags.databinding.base.StructuredBaseTag

EMPTY_STRING

Fields inherited from class com.bea.wlw.netui.tags.AbstractBaseTag

ATTR_GENERAL, ATTR_GENERAL_EXPRESSION, ATTR_JAVASCRIPT, ATTR_STYLE, JAVASCRIPT_STATUS, NETUI_UNIQUE_CNT

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

bodyContent

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

id, pageContext

Fields inherited from interface com.bea.wlw.netui.tags.html.HtmlConstants

ACCEPT, ACCESSKEY, ACTION, ALIGN, ALINK, ALT, ANCHOR, BACKGROUND, BASE, BGCOLOR, BODY, BORDER, BR, CAPTION, CELLPADDING, CELLSPACING, CHAR, CHAROFF, CHARSET, CHECKED, CLASS, COLS, COORDS, DIR, DISABLED, DIV, ENCTYPE, FOR, FORM, FORM_GET, FORM_POST, FRAME, HEIGHT, HREF, HREFLANG, HSPACE, HTML, ID, IMAGE, INPUT, INPUT_BUTTON, INPUT_CHECKBOX, INPUT_FILE, INPUT_HIDDEN, INPUT_IMAGE, INPUT_PASSWORD, INPUT_RADIO, INPUT_RESET, INPUT_SUBMIT, INPUT_TEXT, ISMAP, LABEL, LANG, LINK, LONGDESC, MAXLENGTH, METHOD, NAME, ONBLUR, ONCHANGE, ONCLICK, ONDBLCLICK, ONFOCUS, ONKEYDOWN, ONKEYPRESS, ONKEYUP, ONLOAD, ONMOUSEDOWN, ONMOUSEMOVE, ONMOUSEOUT, ONMOUSEOVER, ONMOUSEUP, ONRESET, ONSELECT, ONSUBMIT, ONUNLOAD, OPTION, READONLY, REL, REV, ROWS, RULES, SELECT, SHAPE, SIZE, SPAN, SRC, STYLE, SUMMARY, TABINDEX, TABLE, TARGET, TD, TEXT, TEXTAREA, TITLE, TR, TYPE, USEMAP, VALIGN, VALUE, VLINK, VSPACE, WIDTH

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

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

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

FormattableColumn()

Method Summary

void	addFormatter(FormatTag.Formatter formatter) Add a FormatTag to this tag.
protected String	format(Object value) Format the text of the column with all of the registered FormatTag tags.
protected void	localRelease() Reset all of the fields of this tag.
protected int	renderStartTag(int gridState) In order for a formatted column to pick-up the formatters, it should evaluate its body.

Methods inherited from class com.bea.wlw.netui.tags.databinding.grid.column.GridColumn

getColumns, getStyleClassPrefix, getValidContainerType, prepare, renderCloseCellTag, renderDataCell, renderDataCellTag, renderEndTag, renderFooterCell, renderFooterCellTag, renderHeaderCell, renderHeaderCellTag, renderOpenCellTag, setStyleClassPrefix

Methods inherited from class com.bea.wlw.netui.tags.databinding.grid.GridComponent

getCurrentRenderState, getGrid, getGridContext

Methods inherited from class com.bea.wlw.netui.tags.databinding.base.StructuredBaseTag

addContent, doEndTag, doStartTag, getContent, verifyAttributes, verifyStructure

Methods inherited from class com.bea.wlw.netui.tags.AbstractBaseTag

addTagIdMapping, containsExpression, evaluateAttributeToString, evaluateExpression, filter, filter, formatErrorString, formatString, getAttribute, getErrorsReport, getExpressionEvaluator, getJavaScriptUtils, getNearestForm, getNextId, getQualifiedBundleName, getScriptReporter, getTagName, getUserLocale, hasErrors, isExpression, prepForRendering, registerAttribute, registerError, registerTagError, release, removeAttribute, renderAttribute, renderAttributes, reportErrors, rewriteName, setPageContext, updateExpression, write

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

doAfterBody, doInitBody, getBodyContent, getPreviousOut, setBodyContent

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

findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setParent, setValue

Methods inherited from class java.lang.Object

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

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

getParent, setParent

Constructor Detail

FormattableColumn

public FormattableColumn()

Method Detail

addFormatter

public void addFormatter(FormatTag.Formatter formatter)

Add a FormatTag to this tag. The Formatter tags are used to format the value that will be written into this Grid cell. A Formatter tag registers itself with this Formattable tag using this method.

Specified by:

addFormatter in interface Formattable

Parameters:

formatter - the Formatter object to add to the list of formatters

See Also:

Formattable

localRelease

protected void localRelease()

Reset all of the fields of this tag.

Overrides:

localRelease in class GridColumn

renderStartTag

protected int renderStartTag(int gridState)

In order for a formatted column to pick-up the formatters, it should evaluate its body. Child tags can override this behavior as necessary but should always evaluate the body in order to have the formatters applied.
The body is evaluated as buffered so that garbage text that may be in the body of the tag is ignored.

Overrides:

renderStartTag in class GridColumn

Parameters:

gridState - the state of this column's Grid tag parent

Returns:

EVAL_BODY_BUFFERED

format

protected String format(Object value)

Format the text of the column with all of the registered FormatTag tags. Each of the formatters is called in order, chaining the value from the previous formatter into the next.

Parameters:

value - the object to format

Returns:

the result of applying all of the Formatter tags to the value Object.