tc
Tag menuCommand


Renders a menu item. (This tag was renamed from tc:menuItem since Tobago 1.5.0)

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

RendererType: MenuCommand



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

Attributes
NameRequiredRequest-timeTypeDescription
accessKeyfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Character)
The access key of this control.
Type: java.lang.Character
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.
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
disabledfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Boolean)
Flag indicating that this element is disabled.
Type: boolean
Default: false
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
imagefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Url to an image to display.
Type: java.lang.String
immediatefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.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
jsfResourcefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.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
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 (if configured so and possible).
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
Starts with protocol followed by 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
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
omitfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Boolean)
Flag indicating that the action of this element, will not be executed from client side (e. g. when the user clicks a button. When setting this value to true, the action will not be executed by the Tobago, but it can executed by JavaScript. This attribute is useful, when you want to add JavaScript event handlers to commands manually. In this case you usually don't want a submit with a full reload of the page.
Type: boolean
Default: false
onclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Script to be invoked when clicked
Type: java.lang.String
renderedfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.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
renderedPartiallyfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String[])

Indicate the partially rendered components in a case of a submit.

The search depends on the number of prefixed colons in the relativeId:

number of prefixed colons == 0
fully relative
number of prefixed colons == 1
absolute (still normal findComponent syntax)
number of prefixed colons == 2
search in the current naming container (same as 0 colons)
number of prefixed colons == 3
search in the parent naming container of the current naming container
number of prefixed colons > 3
go to the next parent naming container for each additional colon

If a literal is specified: to use more than one identifier the identifiers must be space delimited.

Using this in a UISheet or UITabGroup component this list indicates components to update when calling internal AJAX requests like sort or paging commands. Don't forget to add the sheet-id or tagGroup-id in that case, if needed.

You can also use
Type: java.lang.String[]

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
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
transitionfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Boolean)
Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.
Type: boolean
Default: true

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.