UIComponentClass: org.apache.myfaces.tobago.component.UILink
RendererType:
Supported facets:
Info | Value |
---|---|
Component Type | org.apache.myfaces.tobago.Link |
Handler Class | org.apache.myfaces.tobago.facelets.TobagoComponentHandler |
Renderer Type | Link |
Description | None |
Name | Required | Type | Description |
---|---|---|---|
accessKey | false | javax.el.ValueExpression
(must evaluate to java.lang.Character )
| The access key of this control. Type: java.lang.Character |
action | false | java.lang.String | Action to invoke when clicked. This must be a MethodExpression or a String representing the application action to invoke when this component is activated by the user. The {@link javax.el.MethodExpression} must evaluate to a public method that takes no parameters, and returns a {@link String} (the logical outcome) which is passed to the {@link javax.faces.application.NavigationHandler} for this application. The string is directly passed to the navigation handler. |
actionListener | false | java.lang.String | MethodExpression 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. |
binding | false | javax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent )
| The value binding expression linking this component to a property in a backing bean.
For Facelets, the component is the outer UIPanel, not the input control. Type: javax.faces.component.UIComponent |
confirmation | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Text to use as confirmation message. Type: java.lang.String |
disabled | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean )
| Flag indicating that this element is disabled. If configured so in the tobago-config.xml the action will be
checked for the annotations {@link javax.annotation.security.RolesAllowed},
{@link javax.annotation.security.PermitAll} or {@link javax.annotation.security.DenyAll}. Type: boolean |
fragment | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| The identifier of the page fragment which should
be brought into focus when the target page is
rendered. The value of this attribute is appended
to the end of target URL following a hash (#) mark.
This notation is part of the standard URL syntax. Type: java.lang.String |
id | false | java.lang.String | The component identifier for this component.
This value must be unique within the closest parent component that is a naming container. Type: java.lang.String |
image | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Url to an image to display. Type: java.lang.String |
immediate | false | javax.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 |
label | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| A localized user presentable label for this component. Type: java.lang.String |
link | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Link to an arbitrary URL, either an internal link or an external link. For internal URLs, a session id will be added, if needed (when cookies disabled). The context path needs to be added manually e.g. #{request.contextPath}. For JSF navigation to a viewId use the outcome attribute! The semantic of this attributes has been changed from Tobago 3 to 4! Type: java.lang.String |
markup | false | javax.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 |
omit | false | javax.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 |
outcome | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Link to an internal facelet page, like the outcome of an action.
The context path will be added.
A session id will be added, if needed. Type: java.lang.String |
rendered | false | javax.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 |
tabIndex | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer )
| Controls the navigation of the focus through the
input controls on a page with the Tab-Key.
The navigation starts from the element with
the lowest tabIndex value to the element with the highest value.
Elements that have identical tabIndex values should be navigated
in the order they appear in the character stream
Elements that are disabled or with a negative tabIndex
do not participate in the tabbing order. Type: java.lang.Integer |
target | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Name of a frame where the resource retrieved via this hyperlink is to be
displayed.
The target attribute is not reliable in combination with
DeltaSpike and its Type: java.lang.String |
tip | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Text value to display as tooltip. Type: java.lang.String |
transition | false | javax.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 |
Output generated by Vdldoc View Declaration Language Documentation Generator.