Tobago Components 1.5.x
Tag toolBarCommand


Renders a command button within a toolbar.

UIComponentClass: org.apache.myfaces.tobago.component.UIToolBarCommand

RendererType: Button

Supported facets:

confirmation
Contains a UIOutput instance with the confirmation message.
popup
Contains a UIPopup instance.
menupopup
Deprecated. Please use dropDownMenu facet.
dropDownMenu
Contains a UIMenu instance to render a drop down menu.


Tag Information
Tag Classorg.apache.myfaces.tobago.internal.taglib.ToolBarCommandTag
TagExtraInfo Classorg.apache.myfaces.tobago.internal.taglib.component.CommandTagExtraInfo
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
actionfalsefalsejavax.el.MethodExpression
(signature must match java.lang.Object action())
Action to invoke when clicked. This must be a MethodBinding or a String representing the application action to invoke when this component is activated by the user. The MethodBinding must evaluate to a public method that takes no parameters, and returns a String (the logical outcome) which is passed to the NavigationHandler for this application. The string is directly passed to the navigation handler.
actionListenerfalsefalsejavax.el.MethodExpression
(signature must match void actionListener(javax.faces.event.ActionEvent))
MethodBinding representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void.
immediatefalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Flag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.
Type: boolean
Default: false
onclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Script to be invoked when clicked
Type: java.lang.String
linkfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Link to an arbitrary URL, either an internal link or an external link.
internal absolute link
Starts with a slash '/' character. The context path will be added. A session id will be added, if needed.
external link
Contains a colon ':' character. The link will not be modified.
internal relative link
Any other strings. A session id will be added, if needed.

Type: java.lang.String
jsfResourcefalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Flag indicating that the resource referenced by the resource attribute is a jsf resource. That means that the url has to be processed to change the prefix or suffix (e. g. *.jsf or /faces/*). Default is false.
Type: boolean
Default: false
resourcefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Link to an internal resource. Resources will be processed by the resource management. E. g. define help.html and it will be served help_es.html or help_de.html if available. For JSF-Pages you have to set the jsfResource attribute.
Type: java.lang.String
transitionfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.
Type: boolean
Default: true
targetfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Name of a frame where the resource retrieved via this hyperlink is to be displayed.
Type: java.lang.String
renderedPartiallyfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String[])
Indicate the partially rendered Components in a case of a submit.
Type: java.lang.String[]
idfalsetruejava.lang.StringThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.
Type: java.lang.String
bindingfalsefalsejavax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
The value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:

  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.

Type: javax.faces.component.UIComponent
renderedfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.
Type: boolean
Default: true
markupfalsefalsejavax.el.ValueExpression
(must evaluate to org.apache.myfaces.tobago.context.Markup)
Indicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.
Type: org.apache.myfaces.tobago.context.Markup
labelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Text value to display as label. If text contains an underscore the next character is used as accesskey.
Type: java.lang.String
accessKeyfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Character)

**** @deprecated. Will be removed in a future version ****

Deprecated! Has not longer any function.
Type: java.lang.Character
labelWithAccessKeyfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)

**** @deprecated. Will be removed in a future version ****

Deprecated! Use 'label' instead. Text value to display as label. If text contains an underscore the next character overwrites 'accesskey'.
Type: java.lang.String
imagefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Url to an image to display.
Type: java.lang.String
disabledfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Flag indicating that this element is disabled.
Type: boolean
Default: false
tipfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Text value to display as tooltip.
Type: java.lang.String

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.