IBM WebSphere Application ServerTM
Release 7

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

java.lang.Object
  extended by javax.faces.webapp.UIComponentTagBase
      extended by javax.faces.webapp.UIComponentClassicTagBase
          extended by javax.faces.webapp.UIComponentTag
              extended by javax.faces.webapp.UIComponentBodyTag
                  extended by com.ibm.bpe.jsf.component.taglib.BaseTag
                      extended by com.ibm.bpe.jsf.component.taglib.DetailsTag
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

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

This class is used to configure a DetailsComponent and corresponds to the bpe:detail tag. The properties displayed are specified by bpe:property PropertyTag tags. The bpe:property tag is a subelement of the bpe:details tag.

Table of tag attributes:

Tag attributeMandatory?Description
columnClasses false A list of CSS style classes, separated by commas, for rendering columns.
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 A value binding for a managed bean of the BPCDetailsHandler class.
rowClasses false A list of CSS style classes, separated by commas, for rendering rows.
styleClass false The CSS style class for rendering the HTML element.


Example:
                        <bpe:details model="#{EscalationDetails}" styleClass="details" columnClasses="detailsProperty,detailsValue">
                                <bpe:property name="state" />                        
                                <bpe:property name="action"/>
                                <bpe:property name="atLeastExpectedState" />
                                <bpe:property name="activationState" />                                           
                                <bpe:property name="taskName" />
                                <bpe:property name="taskOwner" />
                                <bpe:property name="escalationReceiver" />
                        </bpe:details>

 


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
DetailsTag()
           
 
Method Summary
 java.lang.String getColumnClasses()
          Returns the column class used to render the details table.
 java.lang.String getComponentType()
          Returns the name of the component type that is created for this tag.
 java.lang.String getModel()
          Returns the Value Binding Expression used to retrieve the model.
 java.lang.String getRendererType()
          Returns the name of the renderer type.
 java.lang.String getRowClasses()
          Returns the row classes used to render the details table.
 java.lang.String getStyleClass()
          Returns the style class used to render the details table.
 void release()
           
 void setColumnClasses(java.lang.String cssStyle)
          Sets the column class used to render the details table.
 void setModel(java.lang.String model)
          Sets the Value Binding Expression used to retrieve the model.
 void setRowClasses(java.lang.String cssStyle)
          Sets the row classes used to render the details table.
 void setStyleClass(java.lang.String cssStyle)
          Sets the style class used to render the details table.
 
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, encodeBegin, 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

COPYRIGHT

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

DetailsTag

public DetailsTag()
Method Detail

getComponentType

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

public java.lang.String getRendererType()
Returns the name of the renderer type. Note that 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

getModel

public java.lang.String getModel()
Returns the Value Binding Expression used to retrieve the model. The Value Binding Expression points to a BPCDetailsHandler.

Returns:
The Value Binding Expression for the model

setModel

public void setModel(java.lang.String model)
Sets the Value Binding Expression used to retrieve the model. The Value Binding Expression must point to a BPCDetailsHandler.

Parameters:
model - The Value Binding Expression for the model

getStyleClass

public java.lang.String getStyleClass()
Returns the style class used to render the details table. Either a literal or a Value Binding Expression is returned.

Returns:
The CSS table style class name, or null

setStyleClass

public void setStyleClass(java.lang.String cssStyle)
Sets the style class used to render the details table. Either a literal or a Value Binding Expression is allowed.

Parameters:
cssStyle - The CSS table style class name

getColumnClasses

public java.lang.String getColumnClasses()
Returns the column class used to render the details table. Either a literal or a Value Binding Expression is returned.

Returns:
The CSS column style class name or null

setColumnClasses

public void setColumnClasses(java.lang.String cssStyle)
Sets the column class used to render the details table. Either a literal or a Value Binding Expression is allowed.

Parameters:
cssStyle - The CSS column style class name

getRowClasses

public java.lang.String getRowClasses()
Returns the row classes used to render the details table. Either a literal or a Value Binding Expression is returned.

Returns:
The CSS row style class name, or null

setRowClasses

public void setRowClasses(java.lang.String cssStyle)
Sets the row classes used to render the details table. Either a literal or a Value Binding Expression is allowed.

Parameters:
cssStyle - The CSS row style class name

release

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

IBM WebSphere Application ServerTM
Release 7