<o:url> is a component which renders the given target URL or JSF view ID as a bookmarkable
URL with support for adding additional query string parameters to the URL via nested <f:param>
and <o:param>, and for exposing it into the request scope by the variable name as specified by
the var attribute instead of rendering it.
| Info | Value |
|---|---|
| Component Type | org.omnifaces.component.output.Url |
| Handler Class | None |
| Renderer Type | None |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
id | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| The component identifier for this component. This value must be unique within the closest parent component that is a naming container. |
rendered | false | javax.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. The default value for this property is true. |
binding | false | javax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
|
The ValueExpression linking this component to a property in a backing bean.
|
var | false | java.lang.String | If specified, then the URL will be exposed in the request scope by the given variable name. |
value | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
|
The target URL to encode.
When specified, the domain and viewId attributes are ignored.
|
viewId | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
|
The view ID to create URL for.
Defaults to current view ID.
This is ignored when value attribute is specified.
|
domain | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
|
The domain of the URL.
Valid formats are: http://example.com, //example.com, example.com, / and //.
If the value equals /, then the URL becomes domain-relative.
If the value equals //, then the URL becomes scheme-relative.
Defaults to current domain.
This is ignored when value attribute is specified.
|
includeViewParams | false | javax.el.ValueExpression
(must evaluate to boolean)
|
Whether to include view parameters in the URL.
Defaults to false.
This setting is ignored when includeRequestParams is set to true.
|
includeRequestParams | false | javax.el.ValueExpression
(must evaluate to boolean)
|
Whether to include request query string parameters in the URL.
Defaults to false.
When this setting is set to true, includeViewParams is ignored.
|
Output generated by Vdldoc View Declaration Language Documentation Generator.