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

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.CommandBarTag
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 CommandBarTag
extends com.ibm.bpe.jsf.component.taglib.BaseTag

This class is used to configure a CommandBar component and corresponds to the bpe:commandbar tag. The buttons displayed on the command bar are specified by bpe:command CommandTag tags, which are in turn enclosed within the bpe:commandbar tag.

Tag attributeDescriptionMandatory?
buttonStyleClass The CSS style class used for rendering the buttons in the command bar. false
id 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. false
model A value binding expression to a managed bean that implements the ItemProvider interface. This managed bean is usually the BPCListHandler class or the BPCDetailsHandler class that is used by the List component or Details component in the same JavaServer Pages (JSP) file as the CommandBar component. true
styleClass The CSS style class used for rendering the bar. false


Example:
    <bpe:commandbar model="#{TaskInstanceDetails}">
         <bpe:command commandID="Work on" label="#{bundle['ACTION.WORK.ON']}" commandClass="com.ibm.bpe.client.model.command.WorkOnTaskCommand" context="#{TaskInstanceDetailsBean}" action="taskMessage" />
         <bpe:command commandID="Complete" label="#{bundle['ACTION.COMPLETE']}" commandClass="com.ibm.bpe.client.model.command.CompleteTaskCommand" context="#{TaskInstanceDetailsBean}" action="taskInstanceList" />
         <bpe:command commandID="Release" label="#{bundle['ACTION.RELEASE']}" ccommandClass="com.ibm.bpe.client.model.command.CancelClaimTaskCommand" context="#{TaskInstanceList}" action="taskInstanceList" />
    </bpe:commandbar>
 


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
CommandBarTag()
           
 
Method Summary
 java.lang.String getButtonStyleClass()
          Gets the button style class used to render the command bar.
 java.lang.String getComponentType()
          Returns the name of the component type that is created for this tag.
 java.lang.String getModel()
          The Value Binding Expression points to either a BPCListHandler or a BPCDetailsHandler.
 java.lang.String getRendererType()
          Returns the name of the renderer type.
 java.lang.String getStyleClass()
          Gets the style class used to render the command bar.
 void release()
           
 void setButtonStyleClass(java.lang.String cssStyle)
          Sets the button style class used to render the command bar.
 void setModel(java.lang.String model)
          The Value Binding Expression must point to either a BPCListHandler or a BPCDetailsHandler.
 void setStyleClass(java.lang.String cssStyle)
          Sets the style class used to render the command bar.
 
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

CommandBarTag

public CommandBarTag()
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.

Specified by:
getRendererType in class javax.faces.webapp.UIComponentTagBase
Returns:
The Faces renderer type

getModel

public java.lang.String getModel()
The Value Binding Expression points to either a BPCListHandler or a BPCDetailsHandler.

Returns:
The Value Binding Expression for the model

setModel

public void setModel(java.lang.String model)
The Value Binding Expression must point to either a BPCListHandler or a BPCDetailsHandler.

Parameters:
model - The Value Binding Expression for the model

getStyleClass

public java.lang.String getStyleClass()
Gets the style class used to render the command bar.

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 command bar.

Parameters:
cssStyle - The CSS table style class name

getButtonStyleClass

public java.lang.String getButtonStyleClass()
Gets the button style class used to render the command bar.

Returns:
The CSS button style class name or null

setButtonStyleClass

public void setButtonStyleClass(java.lang.String cssStyle)
Sets the button style class used to render the command bar.

Parameters:
cssStyle - The CSS button 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