|
BEA NetUI tags and APIs are included for backward compatibility only. For new applications, use the Beehive tags and APIs. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
public abstract class GridColumn
The abstract base class for all column tags that can be children
of the Columns
tag. This
tag defines the basic lifecycle methods of a grid column:
renderHeaderCell()
method
is called in the Grid's Grid.HEADER
state, and the renderDataCell()
and renderFooterCell()
methods are called during the Grid's Grid.ROWS
and Grid.FOOTER
lifecycle states
respectively.
This tag extends GridComponent
and overrides
the valid container type for subclasses. GridColumn types must be nested within a
Columns
tag.
Attribute Descriptions | |||
---|---|---|---|
Attribute | Required | Runtime Expression Evaluation | Data Bindable |
styleClassPrefix | No | No | No |
A partial name of a CSS style class that can be used to stylize the header, data,
and footer regions of a column. The rest of the actual CSS class rendered for these regions is created
by appending -td-header , -td-data , and -td-footer , respectively
to the value of the styleClassPrefix property. |
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 | |
---|---|
GridColumn()
|
Method Summary | |
---|---|
protected Columns |
getColumns()
Get the Columns
parent of this tag. |
String |
getStyleClassPrefix()
Get the CSS style class for this grid column. |
protected Class |
getValidContainerType()
Set the required parent type for this tag to the Columns tag. |
protected void |
localRelease()
Reset all of the fields of this tag. |
protected void |
prepare()
Implementation of the StructuredBaseTag.prepare()
method. |
protected String |
renderCloseCellTag()
|
protected abstract String |
renderDataCell()
Render the contents of this GridColumn for each dataset item into each cell in the column. |
protected String |
renderDataCellTag()
|
protected int |
renderEndTag(int state)
Implementation of the StructuredBaseTag.renderStartTag(int)
method for all GridColumn subclasses. |
protected abstract String |
renderFooterCell()
Render the contents of this GridColumn in the footer cell. |
protected String |
renderFooterCellTag()
|
protected abstract String |
renderHeaderCell()
Render the contents of this GridColumn in the header cell. |
protected String |
renderHeaderCellTag()
|
protected String |
renderOpenCellTag()
|
protected int |
renderStartTag(int gridState)
Default implementation of the StructuredBaseTag.renderStartTag(int)
method for all GridColumns that returns SKIP_BODY. |
void |
setStyleClassPrefix(String styleClassPrefix)
Set the style class prefix that is used to render table cell style information for the header, data, and footer cells of this HTML table column. |
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 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 |
---|
public GridColumn()
Method Detail |
---|
public String getStyleClassPrefix()
-td-header
, -td-data
, and
-td-footer
are appended to this style class prefix to create the style classes that
should appear in a CSS.
public void setStyleClassPrefix(String styleClassPrefix)
Set the style class prefix that is used to render table cell style
information for the header, data, and footer cells of this HTML
table column. The styleClassPrefix
will be used
in conjunction with a suffix to create style class names
that are rendered inside of the <td> tags for each cell in
this column. The value of this property overrides any value
set on the Columns.setStyleClassPrefix(java.lang.String)
tag.
Assuming the value of this property is foo
, the style class
names rendered for each part of the column are:
Column Region | Style class |
Header | foo-td-header |
Data | foo-td-data |
Footer | foo-td-footer |
styleClassPrefix
- the name of a style class that will be qualified with
a suffix to name a CSS style class rendered for the header, data, and footer
regions in a grid column.
The style class prefix used to make the style class name
in the header, data, and footer cells.
The styleClassPrefix
will be concatinated
with a suffix to create style class names
that are rendered inside of the <td> tags for each cell in
this column.
Assuming the value of this attribute is foo
, the style class
names rendered for each part of the column are shown in the table below.
Column Region | Style class |
Header | foo-td-header |
Data | foo-td-data |
Footer | foo-td-footer |
protected void localRelease()
localRelease
in class GridComponent
protected abstract String renderHeaderCell() throws javax.servlet.jsp.JspException
javax.servlet.jsp.JspException
- if an error occurs that can not be reported in the pageprotected abstract String renderDataCell() throws javax.servlet.jsp.JspException
javax.servlet.jsp.JspException
- if an error occurs that can not be reported in the pageprotected abstract String renderFooterCell() throws javax.servlet.jsp.JspException
javax.servlet.jsp.JspException
- if an error occurs that can not be reported in the pageprotected void prepare()
StructuredBaseTag.prepare()
method. This method finds the parent Columns
tag and references it locally so that subclasses can access the Columns tag easily.
prepare
in class GridComponent
protected final Columns getColumns()
Columns
parent of this tag.
protected int renderStartTag(int gridState)
StructuredBaseTag.renderStartTag(int)
method for all GridColumns that returns SKIP_BODY. Subclasses that
need to process their body, for example to read formatters or
URL parameters should override this method.
renderStartTag
in class StructuredBaseTag
gridState
- the current rendering state of the containing Grid
protected final int renderEndTag(int state) throws javax.servlet.jsp.JspException
StructuredBaseTag.renderStartTag(int)
method for all GridColumn subclasses. This method performs the rendering
lifecycle for all GridColumn instances; depending on the Grid's current render
state, specified with the state
parameter, a different method is called
on the subclasses to render a different part of a GridColumn.
Grid Lifecycle State | GridColumn Lifecycle Method |
HEADER | renderHeaderCell() |
ROWS | renderDataCell() |
FOOTER | renderFooterCell() |
Columns
tag.
renderEndTag
in class StructuredBaseTag
state
- the current rendering state of the containing Grid
javax.servlet.jsp.JspException
- if an error occurs that can not be reported on the pageprotected Class getValidContainerType()
Columns
tag. A GridColumn used
outside of this required parent tag will report an error.
getValidContainerType
in class GridComponent
protected String renderHeaderCellTag()
protected String renderDataCellTag()
protected String renderFooterCellTag()
protected String renderOpenCellTag()
protected String renderCloseCellTag()
|
BEA NetUI tags and APIs are included for backward compatibility only. For new applications, use the Beehive tags and APIs. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |