The <o:param> is a component that extends the standard UIParameter to implement ValueHolder
and thus support a Converter to convert the supplied value to string, if necessary.
You can use it the same way as <f:param>, you only need to change f: into
o: to get the extra support for a Converter by usual means via the converter
attribute of the tag, or the nested <f:converter> tag, or just automatically if a converter is
already registered for the target class via @FacesConverter(forClass).
Also, if no value is specified, but children are present, then the encoded output of children will be returned as
param value. This is useful when you want to supply Faces components or HTML as parameter of an unescaped
<h:outputFormat>. For example,
<h:outputFormat value="#{bundle.paragraph}" escape="false">
<o:param><h:link outcome="contact" value="#{bundle.contact}" /></o:param>
</h:outputFormat>
with this bundle
paragraph = Please {0} for more information.
contact = contact us
will result in the link being actually encoded as output format parameter value.
| Info | Value |
|---|---|
| Component Type | org.omnifaces.component.output.Param |
| Handler Class | None |
| Renderer Type | None |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
binding | false | jakarta.el.ValueExpression
(must evaluate to jakarta.faces.component.UIComponent)
| The ValueExpression linking this component to a property in a backing bean. |
converter | false | jakarta.el.ValueExpression
(must evaluate to jakarta.faces.convert.Converter)
| Converter instance registered with this component. |
disable | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Flag enabling or disabling the inclusion of the parameter. This flag is consulted by renderers that consider the UIParameter component associated with this during their rendering. Such renderers include jakarta.faces.Output jakarta.faces.Link and jakarta.faces.OutcomeTarget jakarta.faces.Link. |
id | false | jakarta.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. |
name | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The name of the request parameter from which the value for this component is retrieved on an initial request or to override the stored value on a postback. |
rendered | false | jakarta.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. |
value | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| A ValueExpression to which the value of the request parameter, as determined by the name attribute, is bound. The resolved value of this expression is used when encoding the view parameter into a bookmarkable link or redirect URL with view parameter encoding enabled. If this attribute is omitted, the value of the request parameter will instead be the local value of the UIViewParameter. |
Output generated by Vdldoc View Declaration Language Documentation Generator.