Columns Class
- public class Columns
extends GridComponent
This tag is a container for the columns that will render the header, data, and footer
for each column in a Grid. Tags contained immediately within the Columns tag
should all be of type
GridColumn
. Those tags are:
Additionally, the Columns tag has the capability to set "global" properties for all
of the contained GridColumn tags. Specifically, the ability to sort / filter and the
actions associated with performing these operations can be set here. All sortable
and filterable GridColumn tags that are contained within a Columns tag may
use these values or may override them if a column needs to be handled specially.
Attribute Descriptions |
Attribute | Required | Runtime Expression Evaluation | Data Bindable |
filterable | No | No | No |
A boolean that enables all of the contained GridColumn objects that are
SortFilterColumn types to be filterable. Individual GridColumn tags can override
this to enable / disable filtering.
|
filterAction | No | No | No |
The action that will be executed if any filterable GridColumn tags
are filtered. Individual GridColumn tags can override this to call a different action.
|
sortable | No | No | No |
A boolean that enables all of the contained GridColumn objects that
are SortFilterColumn types to be sortable. Individual GridColumn tags can override
this to enable / disable sorting.
|
sortAction | No | No | No |
The action that will be executed if any sortable GridColumn tags
are sorted. Individual GridColumn tags can override this to call a different action.
|
styleClassPrefix | No | No | No |
A style class prefix that will be applied to all cells in all
columns inside of a GridColumns tag.
This attribute provides a way to customize the header, data, and footer cells of all
grid columns with a single attribute.
See GridColumn.setStyleClassPrefix(String)
for more information on how columns apply CSS styles to cells.
|
Related Topics
<netui-data:grid> Tag Sample
Grid
-
Hierarchy
-
Object
TagSupport
BodyTagSupport
AbstractBaseTag
StructuredBaseTag
GridComponent
Columns
-
All Implemented Interfaces
-
BodyTag
, IterationTag
, Serializable
, Tag
Fields from com.bea.wlw.netui.tags.AbstractBaseTag |
ATTR_GENERAL , ATTR_GENERAL_EXPRESSION , ATTR_JAVASCRIPT , ATTR_STYLE , CLASS , ID , JAVASCRIPT_STATUS , NAME , NETUI_UNIQUE_CNT , ONCLICK , ONDBLCLICK , ONKEYDOWN , ONKEYPRESS , ONKEYUP , ONMOUSEDOWN , ONMOUSEMOVE , ONMOUSEOUT , ONMOUSEOVER , ONMOUSEUP , STYLE , TABINDEX
|
public String |
-
getFilterAction ()
- Get the action that will be invoked if a contained GridColumn tag is filtered.
|
public String |
-
getSortAction ()
- Get the action that will be invoked if a contained GridColumn tag is sorted.
|
public String |
-
getStyleClassPrefix ()
- Get the default style class prefix that is applied to
all columns in the grid.
|
public String |
-
getTagName ()
- Get the name of this tag.
|
public boolean |
-
isFilterable ()
- Get whether or not this column can be filtered.
|
public boolean |
-
isSortable ()
- Get whether or not this column can be sorted.
|
protected void |
-
localRelease ()
- Reset all of the fields of this tag.
|
protected int |
-
renderEndTag (int gridState)
|
protected int |
-
renderStartTag (int gridState)
|
public void |
-
setFilterable (boolean filterable)
- Set whether or not this column can be filtered.
|
public void |
-
setFilterAction (String filterAction)
- Set the action that will be invoked if a contained GridColumn tag is filtered.
|
public void |
-
setSortable (boolean sortable)
- Set whether or not this column can be sorted.
|
public void |
-
setSortAction (String sortAction)
- Set the action that will be invoked if a contained GridColumn tag is sorted.
|
public void |
-
setStyleClassPrefix (String styleClassPrefix)
- Set a default style class prefix that is applied to
all columns in the grid.
|
Methods from com.bea.wlw.netui.tags.databinding.base.StructuredBaseTag |
addContent, doEndTag, doStartTag, getContent, getCurrentRenderState, getValidContainerType, localRelease, prepare, verifyAttributes, verifyStructure |
Methods from com.bea.wlw.netui.tags.AbstractBaseTag |
addTagIdMapping , evaluateAttributeToString , filter , filter , getJavaScriptUtils , getNearestForm , getScriptReporter , getUserLocale , localRelease , registerTagError , release , renderAttribute , rewriteName , write
|
Methods from javax.servlet.jsp.tagext.TagSupport |
doAfterBody, doEndTag, doStartTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue |
Methods from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Columns
public Columns()
getFilterAction() Method
public String
getFilterAction()
Get the action that will be invoked if a contained GridColumn tag is filtered.
Returns
- the action that will be called to sort a GridColumn inside
of a Columns tag.
getSortAction() Method
public String
getSortAction()
Get the action that will be invoked if a contained GridColumn tag is sorted.
Returns
- the action that will be called to sort a GridColumn inside
of a Columns tag.
getStyleClassPrefix() Method
public String
getStyleClassPrefix()
Get the default style class prefix that is applied to
all columns in the grid. See GridColumn.setStyleClassPrefix(String)
for more information.
Returns
- the style class prefix that is used by all columns in a grid.
getTagName() Method
public String
getTagName()
Get the name of this tag. This is used to identify the type of this tag
for reporting tag errors.
-
Overrides
-
AbstractBaseTag.getTagName()
Returns
- a constant String representing the name of this tag.
isFilterable() Method
public boolean isFilterable()
Get whether or not this column can be filtered.
Returns
true
if this column is filtered; false
otherwise.
isSortable() Method
public boolean isSortable()
Get whether or not this column can be sorted.
Returns
true
if this column is filtered; false
otherwise.
localRelease() Method
protected void localRelease()
Reset all of the fields of this tag.
-
Overrides
-
GridComponent.localRelease()
renderEndTag(int) Method
protected int renderEndTag(int gridState)
-
Overrides
- StructuredBaseTag.renderEndTag(int)
renderStartTag(int) Method
protected int renderStartTag(int gridState)
-
Overrides
- StructuredBaseTag.renderStartTag(int)
setFilterable(boolean) Method
public void setFilterable(boolean filterable)
Set whether or not this column can be filtered. This attribute
will help determine the capability of a contained
GridColumn
tags.
Parameters
-
filterable
- a boolean that sets this capability. If
true
this
column may be filterable; otherwise it is not.
setFilterAction(String) Method
public void setFilterAction(String
filterAction)
Set the action that will be invoked if a contained GridColumn tag is filtered. The use
of this attribute requires the presence of a PageFlowController
in the JSP's directory. This attribute will help determine the sort action of a contained
GridColumn
tags.
Parameters
-
filterAction
- the action that will be called to filter the column
setSortable(boolean) Method
public void setSortable(boolean sortable)
Set whether or not this column can be sorted. This attribute
will help determine the capability of a contained
GridColumn
tags.
Parameters
-
sortable
- a boolean that sets this capability. If
true
this
column may be sortable; otherwise it is not.
setSortAction(String) Method
public void setSortAction(String
sortAction)
Set the action that will be invoked if a contained GridColumn tag is sorted. The use
of this attribute requires the presence of a PageFlowController
in the JSP's directory. This attribute will help determine the sort action of a contained
GridColumn
tags.
Parameters
-
sortAction
- the action that will be called to sort the column
setStyleClassPrefix(String) Method
public void setStyleClassPrefix(String
styleClassPrefix)
Set a default style class prefix that is applied to
all columns in the grid. See GridColumn.setStyleClassPrefix(String)
for more information.
& @param styleClassPrefix a style class prefix that is used by all columns in a grid