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

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.CommandBarTag
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 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 shown on the command bar are specified by bpe:command CommandTag tags which are enclosed in the bpe:commandbar tag.

tag attributedescriptionmandatory
model Reference to the model whose selected data is processed upon by the commands. Only selected items of the command are actually processed true
styleClass The CSS style used for rendering the command 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.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
CommandBarTag()
           
 
Method Summary
 java.lang.String getButtonStyleClass()
          Getter for the buttonStyleClass used for rendering the CommandBar.
 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 BPCDetailsHandler.
 java.lang.String getRendererType()
          Returns the name of the renderer type.
 java.lang.String getStyleClass()
          Getter for the styleClass used for rendering the CommandBar.
 void release()
           
 void setButtonStyleClass(java.lang.String cssStyle)
          Setter for the buttonStyleClass used for rendering the CommandBar.
 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)
          Setter for the styleClass used for rendering the CommandBar.
 
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

CommandBarTag

public CommandBarTag()
Method Detail

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.

Returns:
The Faces renderer type

getModel

public java.lang.String getModel()
The Value Binding Expression points to either a BPCListHandler or 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()
Getter for the styleClass used for rendering the CommandBar.

Returns:
The CSS table style class name or null

setStyleClass

public void setStyleClass(java.lang.String cssStyle)
Setter for the styleClass used for rendering the CommandBar.

Parameters:
cssStyle - The CSS table style class name

getButtonStyleClass

public java.lang.String getButtonStyleClass()
Getter for the buttonStyleClass used for rendering the CommandBar.

Returns:
The CSS button style class name or null

setButtonStyleClass

public void setButtonStyleClass(java.lang.String cssStyle)
Setter for the buttonStyleClass used for rendering the CommandBar.

Parameters:
cssStyle - The CSS button style class name

release

public void release()