com.ibm.bpe.jsf.component.taglib
Class ColumnTag
- java.lang.Object
javax.servlet.jsp.tagext.TagSupport
com.ibm.bpe.jsf.component.taglib.ColumnTag
All implemented interfaces:
java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
- public class ColumnTag
- extends javax.servlet.jsp.tagext.TagSupport
bpe:list
ListTag
tag. Each bpe:column
tag must be enclosed within a bpe:list
tag.
If the model used provides metadata, the label and converter information are retrieved from the model,
unless they are explicitly set on the tag.
Table of tag attributes:
Tag attribute | Mandatory? | Description | action | false | Either a Java Server Faces Action Method or the Faces Navigation target that is triggered by clicking on the link in this column. If not specified, no link is rendered in this column. |
---|---|---|
converterID | false | The Faces Converter ID used for converting the property value. If not specified, any Faces Converter ID provided by the model for this property is used. |
label | false | A literal or Value Binding Expression that is used as a label. If not specified, any label provided by the model for this property is used. |
name | true | The name of the property that is displayed in this column. |
styleClass | false | The CSS style class used as the styleClass attribute on the column content. |
Example:
<bpe:list model="#{TaskInstanceList}" rows="5" styleClass="list" headerStyleClass="listHeader" rowClasses="normal"> <bpe:column name="name" action="taskInstanceDetails" /> <bpe:column name="state" converterID="my.task.state.converter" /> <bpe:column name="kind" /> <bpe:column name="owner" label="Working on the task:" /> <bpe:column name="originator" /> </bpe:list>
See Also:
Field Summary
Modifier and Type | Field and Description |
---|---|
|
COPYRIGHT
|
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
Constructor and Description |
---|
ColumnTag()
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
doStartTag()
|
|
getAction()
Returns the action that is triggered by clicking on the link in this column.
|
|
getConverterID()
Returns the explicitly set converter ID.
|
|
getEscape()
Returns the escape attribute.
|
|
getLabel()
Returns the explicitly set label of the column header.
|
|
getName()
Returns the name of the property that is displayed in the column.
|
|
getStyleClass()
Returns the CSS style used to render the column content.
|
|
release()
|
|
setAction(java.lang.String action)
Sets the action that is triggered by clicking on the link in this column.
|
|
setConverterID(java.lang.String converterId)
Sets the converter ID for the column.
|
|
setEscape(java.lang.String escape)
Sets the escape attribute.
|
|
setLabel(java.lang.String label)
Sets the label of the column header.
|
|
setName(java.lang.String name)
Sets the name of the property that is displayed in the column.
|
|
setStyleClass(java.lang.String cssStyle)
Sets the CSS style used to render the column content.
|
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
COPYRIGHT
- public static final java.lang.String COPYRIGHT
See Also:
Constructor Detail
ColumnTag
- public ColumnTag()
Method Detail
getAction
- public java.lang.String getAction( )
Returns the action that is triggered by clicking on the link in this column. The value is either a literal
that is used as navigation target in the application, or a Method Binding Expression that references
a Java Server Faces Action Method.
Returns:
A literal, Java Server Faces Action Method Binding Expression, or null
getName
- public java.lang.String getName( )
Returns the name of the property that is displayed in the column. According to the Java Bean Convention, the name must match a property name of the
model bean associated with the list.
Returns:
The property name
setAction
- public void setAction(java.lang.String action)
Sets the action that is triggered by clicking on the link in this column. The value must either be a literal
that is used as a navigation target in the application, or a Method Binding Expression that references a Java Server Faces Action Method.
Parameters:
action
- A literal or Java Server Faces Action Method Binding Expression setName
- public void setName(java.lang.String name)
Sets the name of the property that is displayed in the column. According to the Java Bean Convention, the name must
be a property name of the model bean associated with the list.
Parameters:
name
- The property name getLabel
- public java.lang.String getLabel( )
Returns the explicitly set label of the column header. If no label has been explicitly set on the tag, the component
uses the label specified in the metadata of the model bean associated with the surrounding list.
Returns:
A literal, Value Binding Expression, or null
setLabel
- public void setLabel(java.lang.String label)
Sets the label of the column header. If this tag property is not set, the label is looked up in the metadata
of the model bean associated with the list.
Parameters:
label
- A label or a Value Binding Expression getConverterID
- public java.lang.String getConverterID( )
Returns the explicitly set converter ID. If no converter ID has been explicitly set on the tag, the component
uses the converter ID that is specified in the metadata of the model bean associated with the surrounding list.
Returns:
The ID of the converter, or null
setConverterID
- public void setConverterID(java.lang.String converterId)
Sets the converter ID for the column. This ID must match the ID of a converter that is registered in the Faces Application.
If no converter is explicitly specified, the converter ID specified on the model associated with the surrounding list is used.
Parameters:
converterId
- The Id of the converter getEscape
- public java.lang.String getEscape( )
Returns the escape attribute. If set to true, special characters are escaped automatically.
Returns:
The escape setting.
setEscape
- public void setEscape(java.lang.String escape)
Sets the escape attribute. If set to true, special characters are escaped automatically.
Parameters:
escape
- The escape setting. getStyleClass
- public java.lang.String getStyleClass( )
Returns the CSS style used to render the column content.
Returns:
The CSS column content style name
setStyleClass
- public void setStyleClass(java.lang.String cssStyle)
Sets the CSS style used to render the column content.
Parameters:
cssStyle
- The CSS column content style name doStartTag
- public int doStartTag()
- throws javax.servlet.jsp.JspException
Specified by:
doStartTag
in interface javax.servlet.jsp.tagext.Tag
Overrides:
doStartTag
in class javax.servlet.jsp.tagext.TagSupport
Throws:
javax.servlet.jsp.JspException
release
- public void release()
Specified by:
release
in interface javax.servlet.jsp.tagext.Tag
Overrides:
release
in class javax.servlet.jsp.tagext.TagSupport