|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.servlet.jsp.tagext.TagSupport
com.ibm.bpe.jsf.component.taglib.CommandTag
This class is used to configure the commands shown by the Command Bar Component. The Command Bar
itself is specified by the bpe:commandbar CommandBarTag
tag. A bpe:command tag must be
surrounded by a bpe:commandbar tag. A command will be represented as button on the view.
Table of tag attributes:
tag attribute | description | mandatory |
---|---|---|
commandID | A unique id for the command used. | true |
label | The label shown on the button. | true |
action | A Java Server Faces Action Method or the Faces Navigation target that will be triggered by the command button. The navigation target returned by the Action will overwrite all navigation rules that are specified by other means. The action will only be called if no exception other than an ErrorsInCommandException has been thrown in the command before. | false |
commandClass | An instance of the command class is triggered by the command button. Navigation targets returned by the command instance might be overwritten through an action method. | false |
context | An arbitrary context object that is provided as context for commands that are specified using the commandClass attribute. The context object is retrieved at the time when the command bar is first accessed. | false |
styleClass | The CSS style used as styleClass attribute on the h:commandButton. | false |
<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']}" commandClass="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.servlet.jsp.tagext.TagSupport |
---|
id, pageContext |
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 | |
---|---|
CommandTag()
|
Method Summary | |
---|---|
int |
doStartTag()
|
java.lang.String |
getAction()
Returns the Action being specified. |
java.lang.String |
getCommandClass()
Returns the class name of the command. |
java.lang.String |
getCommandID()
Returns the command ID that has been specified. |
java.lang.String |
getContext()
Returns the Value Binding pointing to a Context Object if specified. |
java.lang.String |
getLabel()
Returns the label of the button. |
java.lang.String |
getStyleClass()
Returns the CSS style used for rendering the h:commandButton. |
void |
release()
|
void |
setAction(java.lang.String facesAction)
Sets a Faces Action for the command button. |
void |
setCommandClass(java.lang.String commandClassName)
Sets the class name of the command that will be triggered by the rendered button. |
void |
setCommandID(java.lang.String commandID)
Sets the command ID of the command |
void |
setContext(java.lang.String contextObject)
Sets the Value Binding Expression pointing to a Context object. |
void |
setLabel(java.lang.String label)
Sets the label of the command button. |
void |
setStyleClass(java.lang.String cssStyle)
Sets the CSS style used for rendering the h:commandButton |
Methods inherited from class javax.servlet.jsp.tagext.TagSupport |
---|
doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String COPYRIGHT
Constructor Detail |
public CommandTag()
Method Detail |
public java.lang.String getCommandClass()
public void setCommandClass(java.lang.String commandClassName)
commandClassName
- The clazzName of the commandpublic java.lang.String getCommandID()
public java.lang.String getLabel()
public java.lang.String getStyleClass()
public void setCommandID(java.lang.String commandID)
commandID
- The command IDpublic void setLabel(java.lang.String label)
label
- A Value Binding Expression or a literalpublic void setStyleClass(java.lang.String cssStyle)
cssStyle
- The CSS command button style namepublic java.lang.String getAction()
public java.lang.String getContext()
public void setAction(java.lang.String facesAction)
facesAction
- A Faces Action Method Binding or a Navigation Target literalpublic void setContext(java.lang.String contextObject)
contextObject
- A Context Objectpublic int doStartTag() throws javax.servlet.jsp.JspException
javax.servlet.jsp.JspException
public void release()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |