com.ibm.bpe.jsf.component.taglib
Class ColumnTag

java.lang.Object
  extended byjavax.servlet.jsp.tagext.TagSupport
      extended bycom.ibm.bpe.jsf.component.taglib.ColumnTag
All Implemented Interfaces:
javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag

public class ColumnTag
extends javax.servlet.jsp.tagext.TagSupport

This class is used to configure a column of the List Component. The list itself is specified by the bpe:list ListTag tag. A bpe:column tag must be surrounded by a bpe:list tag. If the used model provides meta information, the label and converter information will be retrieved from the model unless they are explicitly set on the tag.

Table of tag attributes:

tag attributedescriptionmandatory
name The name of the property that is shown in this column. true
action 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 will be rendered in this column. false
label A literal or Value Binding Expression that is used as label. If not specified, any label provided by the model for this property is used. false
converterID 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. false


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:
Serialized Form

Field Summary
static java.lang.String 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
ColumnTag()
           
 
Method Summary
 int doStartTag()
           
 java.lang.String getAction()
          Returns the action that is triggered when clicking on the link in this column.
 java.lang.String getConverterID()
          Returns the explicitly set converter id.
 java.lang.String getLabel()
          Returns the explicitly set label of the column header.
 java.lang.String getName()
          Returns the name of the property that is display in the column.
 void release()
           
 void setAction(java.lang.String action)
          Sets the action that is triggerd when clicking on the link in this column.
 void setConverterID(java.lang.String converterId)
          Sets the converterId for the column.
 void setLabel(java.lang.String label)
          Sets the label of the column header.
 void setName(java.lang.String name)
          Sets the name of the property that is display in the column.
 
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:
Constant Field Values
Constructor Detail

ColumnTag

public ColumnTag()
Method Detail

getAction

public java.lang.String getAction()
Returns the action that is triggered when 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 refering to a Java Server Faces Action Method.

Returns:
Literal or Java Server Faces Action Method Binding Expression or null

getName

public java.lang.String getName()
Returns the name of the property that is display in the column. The name is equal to a property name of the model bean associated with the list according to the Java Bean Convention.

Returns:
The property name

setAction

public void setAction(java.lang.String action)
Sets the action that is triggerd when clicking on the link in this column. The value should either be a literal that is used as navigation target in the application or a Method Binding Expression refering to a Java Server Faces Action Method.

Parameters:
action - 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 display in the column. The name should be a property name of the model bean associated with the list according to the Java Bean Convention.

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 will use the label specified in the meta information of the model bean associated with the surrounding list.

Returns:
A literal or a 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 will be looked up in the meta information 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 will use the converter id that is specified in the meta information of the model bean associated with the surrouding list.

Returns:
The Id of the converter or null

setConverterID

public void setConverterID(java.lang.String converterId)
Sets the converterId for the column. The id should 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 surronding list is used.

Parameters:
converterId - The Id of the converter

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException
Throws:
javax.servlet.jsp.JspException

release

public void release()