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

java.lang.Object
  extended byjavax.faces.webapp.UIComponentTag
      extended byjavax.faces.webapp.UIComponentBodyTag
          extended bycom.ibm.bpe.jsf.component.taglib.BaseTag
              extended bycom.ibm.bpe.jsf.component.taglib.ListTag
All Implemented Interfaces:
javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class ListTag
extends com.ibm.bpe.jsf.component.taglib.BaseTag

This class is used to configure a List Component and corresponds to the bpe:list tag. The columns shown in the list are specified by bpe:column ColumnTagtags which are enclosed in the bpe:list tag. The implementation of the ListComponent is based on the Java Server Faces h:dataTable functionality.

Table of tag attributes:

tag attribute description mandatory
model The model which is displayed. The value must be a Value Binding Expression that evaluates to a BPCListHandler BPCListHandler. true
cellStyleClass The CSS style used for the content cells in the h:dataTable. false
checkbox If true, the first column will be a checkbox column. The value must either be a literal 'true' or 'false' or a Value Binding Expression that returns a Boolean value. The default is true. false
headerStyleClass The CSS style used for the header cells in the h:dataTable. false
rowClasses The CSS styles set as rowClasses attribute on the h:dataTable. false
rows The number of rows that are shown at once. If model cannot be shown entirely button for paging are displayed. The value must be number literal. Value Binding Expressions are not supported. false
styleClass The CSS style used as styleClass attribute on the h:dataTable false


Example:
 
  <bpe:list model="#{ProcessInstanceList}" rows="5" styleClass="list" headerStyleClass="listHeader" rowClasses="normal">
  <bpe:column name="name" action="processInstanceDetails" />
  <bpe:column name="processTemplateName" action="processTemplateDetails" />
  <bpe:column name="executionState" />
  <bpe:column name="startTime" />
  </bpe:list>  
  
 


Field Summary
static java.lang.String COPYRIGHT
           
 
Fields inherited from class javax.faces.webapp.UIComponentBodyTag
bodyContent
 
Fields inherited from class javax.faces.webapp.UIComponentTag
pageContext
 
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
ListTag()
           
 
Method Summary
 java.lang.String getButtonStyleClass()
          Returns the style class used for rendering the buttons.
 java.lang.String getCellStyleClass()
          Returns the name of the cell style class used for rendering the list.
 java.lang.String getCheckbox()
          Returns whether a checkbox column is shown.
 java.lang.String getComponentType()
          Returns the name of the component type that is created for this tag.
 java.lang.String getHeaderStyleClass()
          Returns the name of the header style class used for rendering the list.
 java.lang.String getModel()
          Returns the Value Binding Expression used for retrieving the model.
 java.lang.String getRendererType()
          Returns the name of the renderer type.
 java.lang.String getRowClasses()
          Returns the name of the rowClasses attribute used for rendering the list.
 java.lang.String getRows()
          Returns the maximal number of rows that are shown in the list at once.
 java.lang.String getStyleClass()
          Returns the style class used for rendering the list.
 void release()
           
 void setButtonStyleClass(java.lang.String cssStyle)
          Sets the style class used for rendering the buttons.
 void setCellStyleClass(java.lang.String cssStyle)
          Sets the cell style class used for rendering the list.
 void setCheckbox(java.lang.String isCheckboxRequired)
          Determines whether a check column is shown.
 void setHeaderStyleClass(java.lang.String cssStyle)
          Sets the header style class used for rendering the list.
 void setModel(java.lang.String model)
          Sets the Value Binding Expression on the list.
 void setRowClasses(java.lang.String cssStyle)
          Sets the row classes used for rendering the list.
 void setRows(java.lang.String numberOfRows)
          Sets the maximal number of rows that are shown in the list.
 void setStyleClass(java.lang.String cssStyle)
          Sets the style class used for rendering the list.
 
Methods inherited from class com.ibm.bpe.jsf.component.taglib.BaseTag
add, addBooleanValue, doEndTag, doStartTag, setProperties
 
Methods inherited from class javax.faces.webapp.UIComponentBodyTag
doAfterBody, doInitBody, getBodyContent, getDoAfterBodyValue, getDoStartValue, getPreviousOut, setBodyContent
 
Methods inherited from class javax.faces.webapp.UIComponentTag
encodeBegin, encodeChildren, encodeEnd, findComponent, getComponentInstance, getCreated, getDoEndValue, getFacesContext, getFacetName, getId, getParent, getParentUIComponentTag, isSuppressed, isValueReference, setBinding, setId, setPageContext, setParent, setRendered, setupResponseWriter
 
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, setPageContext, setParent
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Constructor Detail

ListTag

public ListTag()
Method Detail

release

public void release()

getComponentType

public java.lang.String getComponentType()
Returns the name of the component type that is created for this tag.

Returns:
The Faces component type

getRendererType

public java.lang.String getRendererType()
Returns the name of the renderer type. Also the List Component uses the default html renderer despite this value.

Returns:
The Faces renderer type

getCheckbox

public java.lang.String getCheckbox()
Returns whether a checkbox column is shown. Either a literal 'true' or 'false' or a Value Binding Expression that evaluates to a Boolean.

Returns:
Either 'true' or 'false' or a Value Binding Expression or null

getCellStyleClass

public java.lang.String getCellStyleClass()
Returns the name of the cell style class used for rendering the list. Either a literal or a Value Binding Expression.

Returns:
The CSS cell style class name or null

getHeaderStyleClass

public java.lang.String getHeaderStyleClass()
Returns the name of the header style class used for rendering the list. Either a literal or a Value Binding Expression.

Returns:
The CSS header style class name or null

getStyleClass

public java.lang.String getStyleClass()
Returns the style class used for rendering the list. This attribute value is set on a h:dataTable. Please refer to the Java Server Faces documentation for further details. Either a literal or a Value Binding Expression.

Returns:
The CSS table style class name or null

getRowClasses

public java.lang.String getRowClasses()
Returns the name of the rowClasses attribute used for rendering the list. This attribute value is set on a h:dataTable. Please refer to the Java Server Faces documentation for further details. Either a literal or a Value Binding Expression.

Returns:
The CSS row style class name or null

getModel

public java.lang.String getModel()
Returns the Value Binding Expression used for retrieving the model. The Value Binding Expression points to a BPCListHandler.

Returns:
The Value Binding Expression for the model

getRows

public java.lang.String getRows()
Returns the maximal number of rows that are shown in the list at once. Will be a literal representing a number.

Returns:
The number of rows shown or null

setCellStyleClass

public void setCellStyleClass(java.lang.String cssStyle)
Sets the cell style class used for rendering the list. Either a literal or a Value Binding Expression is allowed.

Parameters:
cssStyle - The CSS cell style class name

setHeaderStyleClass

public void setHeaderStyleClass(java.lang.String cssStyle)
Sets the header style class used for rendering the list. Either a literal or a Value Binding Expression is allowed.

Parameters:
cssStyle - The CSS header style class name

setRowClasses

public void setRowClasses(java.lang.String cssStyle)
Sets the row classes used for rendering the list. This attribute value is set on a h:dataTable. Please refer to the Java Server Faces documentation for further details. Either a literal or a Value Binding Expression is allowed.

Parameters:
cssStyle - The CSS row style class name

setModel

public void setModel(java.lang.String model)
Sets the Value Binding Expression on the list. The Value Binding Expression must point to a BPCListHandler.

Parameters:
model - The Value Binding Expression for the model

setRows

public void setRows(java.lang.String numberOfRows)
Sets the maximal number of rows that are shown in the list. The literal should be a number and must not be a Value Binding Expression.

Parameters:
numberOfRows - The number of rows shown.

setStyleClass

public void setStyleClass(java.lang.String cssStyle)
Sets the style class used for rendering the list. This attribute value is set on a h:dataTable. Please refer to the Java Server Faces documentation for further details. Either a literal or a Value Binding Expression is allowed.

Parameters:
cssStyle - The CSS table style class name

getButtonStyleClass

public java.lang.String getButtonStyleClass()
Returns the style class used for rendering the buttons. This attribute value is set on a h:dataTable. Please refer to the Java Server Faces documentation for further details. Either a literal or a Value Binding Expression.

Returns:
The CSS table style class name or null

setButtonStyleClass

public void setButtonStyleClass(java.lang.String cssStyle)
Sets the style class used for rendering the buttons. This attribute value is set on a h:dataTable. Please refer to the Java Server Faces documentation for further details. Either a literal or a Value Binding Expression is allowed.

Parameters:
cssStyle - The CSS button style class name

setCheckbox

public void setCheckbox(java.lang.String isCheckboxRequired)
Determines whether a check column is shown. Either a literal 'true' or 'false' or a Value Binding Expression that evaluates to a Boolean is allowed.

Parameters:
isCheckboxRequired - Either 'true' or 'false' or a Value Binding Expression