|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.webapp.UIComponentTagBase
javax.faces.webapp.UIComponentClassicTagBase
javax.faces.webapp.UIComponentTag
javax.faces.webapp.UIComponentBodyTag
com.ibm.bpe.jsf.component.taglib.BaseTag
com.ibm.bpe.jsf.component.taglib.ListTag
public class ListTag
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. |
<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.UIComponentClassicTagBase |
---|
bodyContent, pageContext, UNIQUE_ID_PREFIX |
Fields inherited from class javax.faces.webapp.UIComponentTagBase |
---|
log |
Fields inherited from interface javax.servlet.jsp.tagext.Tag |
---|
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE |
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 |
Constructor Summary | |
---|---|
ListTag()
|
Method Summary | |
---|---|
protected void |
encodeBegin()
|
java.lang.String |
getButtonStyleClass()
Returns the style class used for rendering the navigation buttons. |
java.lang.String |
getCellStyleClass()
Returns the name of the cell style class that is used to render the list. |
java.lang.String |
getCheckbox()
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 that is used to render 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. |
java.lang.String |
getRowClasses()
Returns the name of the rowClasses attribute used to
render the list. |
java.lang.String |
getRows()
Returns the maximum number of rows that can be displayed in the list at any one time. |
java.lang.String |
getSelectAll()
Whether all items are initially selected. |
java.lang.String |
getStyleClass()
Returns the style class that is used to render the list. |
void |
release()
|
void |
setButtonStyleClass(java.lang.String cssStyle)
Sets the style class to use to render the navigation buttons. |
void |
setCellStyleClass(java.lang.String cssStyle)
Sets the cell style class used to render the list. |
void |
setCheckbox(java.lang.String isCheckboxRequired)
Specifies whether a 'check' column is displayed. |
void |
setHeaderStyleClass(java.lang.String cssStyle)
Sets the header style class used to render 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 to use to render the list. |
void |
setRows(java.lang.String numberOfRows)
Sets the maximum number of list rows that can be displayed at any one time. |
void |
setSelectAll(java.lang.String isAllSelected)
Specifies whether all items are initially selected. |
void |
setStyleClass(java.lang.String cssStyle)
Sets the style class to use to render 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 |
Methods inherited from interface javax.servlet.jsp.tagext.Tag |
---|
getParent, setPageContext, setParent |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
Constructor Detail |
---|
public ListTag()
Method Detail |
---|
public void release()
release
in interface javax.servlet.jsp.tagext.Tag
release
in class com.ibm.bpe.jsf.component.taglib.BaseTag
public java.lang.String getComponentType()
getComponentType
in class javax.faces.webapp.UIComponentTagBase
public java.lang.String getRendererType()
getRendererType
in class javax.faces.webapp.UIComponentTagBase
public java.lang.String getCheckbox()
public java.lang.String getSelectAll()
public java.lang.String getCellStyleClass()
public java.lang.String getHeaderStyleClass()
public java.lang.String getStyleClass()
h:dataTable
tag. Refer to the Java
Server Faces documentation for further details. Returns either a literal
or a Value Binding Expression.
public java.lang.String getRowClasses()
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.
public java.lang.String getModel()
BPCListHandler
object.
public java.lang.String getRows()
public void setCellStyleClass(java.lang.String cssStyle)
cssStyle
- The CSS cell style class namepublic void setHeaderStyleClass(java.lang.String cssStyle)
cssStyle
- The CSS header style class namepublic void setRowClasses(java.lang.String cssStyle)
h:dataTable
element. Refer to the Java Server
Faces documentation for further details. Can be either a literal or a
Value Binding Expression.
cssStyle
- The CSS row style class namepublic void setModel(java.lang.String model)
BPCListHandler
object.
model
- The Value Binding Expression for the modelpublic void setRows(java.lang.String numberOfRows)
numberOfRows
- The number of rows displayed.public void setStyleClass(java.lang.String cssStyle)
h:dataTable
tag. Refer to the Java Server Faces
documentation for further details. Can be either a literal or a Value
Binding Expression.
cssStyle
- The CSS table style class namepublic java.lang.String getButtonStyleClass()
h:dataTable
tag. Refer to the
Java Server Faces documentation for further details. Returns ither a
literal or a Value Binding Expression.
public void setButtonStyleClass(java.lang.String cssStyle)
h:dataTable
tag. Refer to the
Java Server Faces documentation for further details. Can be either a
literal or a Value Binding Expression.
cssStyle
- The CSS button style class namepublic void setCheckbox(java.lang.String isCheckboxRequired)
isCheckboxRequired
- 'true', 'false', or a Value Binding Expressionpublic void setSelectAll(java.lang.String isAllSelected)
isAllSelected
- 'true', 'false', or a Value Binding Expressionprotected void encodeBegin() throws java.io.IOException
encodeBegin
in class javax.faces.webapp.UIComponentClassicTagBase
java.io.IOException
|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |