com.ibm.bpe.jsf.component.taglib

Class ListTag

  1. java.lang.Object
  2. extended byjavax.faces.webapp.UIComponentTagBase
  3. extended byjavax.faces.webapp.UIComponentClassicTagBase
  4. extended byjavax.faces.webapp.UIComponentTag
  5. extended byjavax.faces.webapp.UIComponentBodyTag
  6. extended bycom.ibm.bpe.jsf.component.taglib.BaseTag
  7. 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.JspIdConsumer, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

  1. public class ListTag
  2. 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 ColumnTag tags. The bpe:column tag is a subelement of 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 Mandatory? Description
buttonStyleClass false The CSS style class used for rendering the buttons in the footer area.
cellStyleClass false The CSS style class used for rendering individual table cells.
checkbox false If false, the checkbox column will not be rendered, otherwise a checkbox column is rendered.
headerStyleClass false The CSS style class used for rendering the header of the list.
id false The JavaServer Faces ID of the component. The attribute value must start with a letter or underscore. Subsequent characters may be letters, digits, dashes, and underscores. All whitespaces will be replaced by underscores.
model true The model that is displayed. The value must be a Value Binding Expression that evaluates to a BPCListHandler.
rowClasses false The CSS style class for rendering the rows in the table.
rows false The number of rows that are shown on a page. The value must be a number literal; Value Binding Expressions are not supported.
selectAll false If this attribute is set to true, all of the items in the list are selected by default.
styleClass false The CSS style class for rendering the overall table containing titles, rows, and paging buttons.
summary false Summary for the resulting HTML table displaying the list.


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

Modifier and Type Field and Description
  1. static
  2. java.lang.String
COPYRIGHT
Fields inherited from class javax.faces.webapp.UIComponentClassicTagBase
bodyContent, pageContext, UNIQUE_ID_PREFIX
Fields inherited from class javax.faces.webapp.UIComponentTagBase
log
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

Constructor and Description
ListTag()

Method Summary

Modifier and Type Method and Description
  1. protected
  2. void
encodeBegin()
  1. java.lang.String
getButtonStyleClass()
Returns the style class used for rendering the navigation buttons.
  1. java.lang.String
getCellStyleClass()
Returns the name of the cell style class that is used to render the list.
  1. java.lang.String
getCheckbox()
Whether a checkbox column is shown.
  1. java.lang.String
getComponentType()
Returns the name of the component type that is created for this tag.
  1. java.lang.String
getHeaderStyleClass()
Returns the name of the header style class that is used to render the list.
  1. java.lang.String
getModel()
Returns the Value Binding Expression used for retrieving the model.
  1. java.lang.String
getRendererType()
Returns the name of the renderer.
  1. java.lang.String
getRowClasses()
Returns the name of the rowClasses attribute used to render the list.
  1. java.lang.String
getRows()
Returns the maximum number of rows that can be displayed in the list at any one time.
  1. java.lang.String
getSelectAll()
Whether all items are initially selected.
  1. java.lang.String
getStyleClass()
Returns the style class that is used to render the list.
  1. java.lang.String
getSummary()
Returns the summary for the list.
  1. void
release()
  1. void
setButtonStyleClass(java.lang.String cssStyle)
Sets the style class to use to render the navigation buttons.
  1. void
setCellStyleClass(java.lang.String cssStyle)
Sets the cell style class used to render the list.
  1. void
setCheckbox(java.lang.String isCheckboxRequired)
Specifies whether a 'check' column is displayed.
  1. void
setHeaderStyleClass(java.lang.String cssStyle)
Sets the header style class used to render the list.
  1. void
setModel(java.lang.String model)
Sets the Value Binding Expression on the list.
  1. void
setRowClasses(java.lang.String cssStyle)
Sets the row classes to use to render the list.
  1. void
setRows(java.lang.String numberOfRows)
Sets the maximum number of list rows that can be displayed at any one time.
  1. void
setSelectAll(java.lang.String isAllSelected)
Specifies whether all items are initially selected.
  1. void
setStyleClass(java.lang.String cssStyle)
Sets the style class to use to render the list.
  1. void
setSummary(java.lang.String summary)
Sets the summary for 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.UIComponentTag
createComponent, getParentUIComponentTag, hasBinding, isSuppressed, isValueReference, setBinding, setRendered
Methods inherited from class javax.faces.webapp.UIComponentClassicTagBase
addChild, addFacet, addVerbatimAfterComponent, addVerbatimBeforeComponent, createVerbatimComponent, createVerbatimComponentFromBodyContent, doAfterBody, doInitBody, encodeChildren, encodeEnd, findComponent, getBodyContent, getComponentInstance, getCreated, getCreatedComponents, getDoAfterBodyValue, getDoEndValue, getDoStartValue, getFacesContext, getFacesJspId, getFacetName, getId, getIndexOfNextChildTag, getJspId, getParent, getParentUIComponentClassicTagBase, getPreviousOut, setBodyContent, setId, setJspId, setPageContext, setParent, setupResponseWriter
Methods inherited from class javax.faces.webapp.UIComponentTagBase
getELContext
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

  1. public static final java.lang.String COPYRIGHT
See Also:

Constructor Detail

ListTag

  1. public ListTag()

Method Detail

release

  1. public void release()
Specified by:
release in interface javax.servlet.jsp.tagext.Tag
Overrides:
release in class com.ibm.bpe.jsf.component.taglib.BaseTag

getComponentType

  1. public java.lang.String getComponentType( )
Returns the name of the component type that is created for this tag.
Specified by:
getComponentType in class javax.faces.webapp.UIComponentTagBase
Returns:
The Faces component type

getRendererType

  1. public java.lang.String getRendererType( )
Returns the name of the renderer. The List Component uses the default HTML renderer irrespective of this value.
Specified by:
getRendererType in class javax.faces.webapp.UIComponentTagBase
Returns:
The Faces renderer type

getCheckbox

  1. public java.lang.String getCheckbox( )
Whether a checkbox column is shown. Returns either a literal 'true' or 'false', or a Value Binding Expression that evaluates to a Boolean.
Returns:
'true', 'false', a Value Binding Expression, or null

getSelectAll

  1. public java.lang.String getSelectAll( )
Whether all items are initially selected. Returns either a literal 'true' or 'false', or a Value Binding Expression that evaluates to a Boolean. *
Returns:
'true', 'false', a Value Binding Expression, or null

getCellStyleClass

  1. public java.lang.String getCellStyleClass( )
Returns the name of the cell style class that is used to render the list. Returns either a literal or a Value Binding Expression.
Returns:
The CSS cell style class name, or null

getHeaderStyleClass

  1. public java.lang.String getHeaderStyleClass( )
Returns the name of the header style class that is used to render the list. This can be either a literal or a Value Binding Expression.
Returns:
The CSS header style class name, or null

getStyleClass

  1. public java.lang.String getStyleClass( )
Returns the style class that is used to render the list. This attribute value is set on a h:dataTable tag. Refer to the Java Server Faces documentation for further details. Returns either a literal or a Value Binding Expression.
Returns:
The CSS table style class name, or null

getRowClasses

  1. public java.lang.String getRowClasses( )
Returns the name of the rowClasses attribute used to render the list. This attribute value is set on an h:dataTable tag. Refer to the Java Server Faces documentation for further details. Returns either a literal or a Value Binding Expression.
Returns:
The CSS row style class name, or null.

getModel

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

getRows

  1. public java.lang.String getRows( )
Returns the maximum number of rows that can be displayed in the list at any one time. Returns a literal representing a number.
Returns:
The number of rows displayed, or null

setCellStyleClass

  1. public void setCellStyleClass(java.lang.String cssStyle)
Sets the cell style class used to render the list. Can be either a literal or a Value Binding Expression.
Parameters:
cssStyle - The CSS cell style class name

setHeaderStyleClass

  1. public void setHeaderStyleClass( java.lang.String cssStyle)
Sets the header style class used to render the list. Can be either a literal or a Value Binding Expression.
Parameters:
cssStyle - The CSS header style class name

setRowClasses

  1. public void setRowClasses(java.lang.String cssStyle)
Sets the row classes to use to render the list. This attribute value is set on an h:dataTable element. Refer to the Java Server Faces documentation for further details. Can be either a literal or a Value Binding Expression.
Parameters:
cssStyle - The CSS row style class name

setModel

  1. public void setModel(java.lang.String model)
Sets the Value Binding Expression on the list. The Value Binding Expression must point to a BPCListHandler object.
Parameters:
model - The Value Binding Expression for the model

setRows

  1. public void setRows(java.lang.String numberOfRows)
Sets the maximum number of list rows that can be displayed at any one time. The literal must be a number, not a Value Binding Expression.
Parameters:
numberOfRows - The number of rows displayed.

setStyleClass

  1. public void setStyleClass(java.lang.String cssStyle)
Sets the style class to use to render the list. This attribute value is set on a h:dataTable tag. Refer to the Java Server Faces documentation for further details. Can be either a literal or a Value Binding Expression.
Parameters:
cssStyle - The CSS table style class name

getButtonStyleClass

  1. public java.lang.String getButtonStyleClass( )
Returns the style class used for rendering the navigation buttons. This attribute value is set on an h:dataTable tag. Refer to the Java Server Faces documentation for further details. Returns ither a literal or a Value Binding Expression.
Returns:
The CSS table style class name, or null

setButtonStyleClass

  1. public void setButtonStyleClass( java.lang.String cssStyle)
Sets the style class to use to render the navigation buttons. This attribute value is set on an h:dataTable tag. Refer to the Java Server Faces documentation for further details. Can be either a literal or a Value Binding Expression.
Parameters:
cssStyle - The CSS button style class name

setCheckbox

  1. public void setCheckbox(java.lang.String isCheckboxRequired)
Specifies whether a 'check' column is displayed. Can be either a literal 'true' or 'false', or a Value Binding Expression that evaluates to a Boolean.
Parameters:
isCheckboxRequired - 'true', 'false', or a Value Binding Expression

setSelectAll

  1. public void setSelectAll(java.lang.String isAllSelected)
Specifies whether all items are initially selected. Can be either a literal 'true' or 'false', or a Value Binding Expression that evaluates to a Boolean.
Parameters:
isAllSelected - 'true', 'false', or a Value Binding Expression

getSummary

  1. public java.lang.String getSummary( )
Returns the summary for the list. Returns either a literal or a Value Binding Expression.
Returns:
The summary or null

setSummary

  1. public void setSummary(java.lang.String summary)
Sets the summary for the list. Can be either a literal or a Value Binding Expression.
Parameters:
summary - The summary

encodeBegin

  1. protected void encodeBegin()
  2. throws java.io.IOException
Overrides:
encodeBegin in class javax.faces.webapp.UIComponentClassicTagBase
Throws:
java.io.IOException