Facelet tag handler that renders a widget in a given mode.
When rendered, some variables are exposed to the resolution context:
Any additional property set on the tag and that is not explicitely in the list of handled attributes is added to the widget properties, overriding properties that already set in the widget definition.
Example:<nxl:widget widget="#{widget}" value="#{myObject}" /> or <nxl:widget name="widgetName" category="" mode="#{myMode}" value="#{myObject}" />
Name | Required | Type | Description |
---|---|---|---|
widget | false | javax.el.ValueExpression
(must evaluate to org.nuxeo.ecm.platform.forms.layout.api.Widget )
| The widget instance. This instance is often exposed by the layout system inside of a layout template, but any widget instance created by third-party code can be used as long as its type is registered on the pluggable layout system. Attributes 'name' and 'definition' are another alternative to build a widget when the instance is not already created and available: this attribute is required when alternatives are not filled. |
name | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Name of the widget as registered on the pluggable layout system. Required if the attributes 'widget' and 'definition' are not filled. Available since 5.6. |
category | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Category of the widget (optional). Available since 5.6, and used in conjunction with the 'name' attribute. Defaults implicitly to "jsf" when not set for compatibility. |
definition | false | javax.el.ValueExpression
(must evaluate to org.nuxeo.ecm.platform.forms.layout.api.WidgetDefinition )
| Widget definition as it would be retrieved from the layout store service. This attribute is required if none of the 'widget' or 'name' attributes are filled: it makes it possible to render a widget generated dynamically. Available since 5.6. |
mode | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| The widget mode. Required if attributes 'name' or 'definition' are used so that the widget instance can be generated for given mode. Available since 5.6. |
layoutName | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| The layout name. Optional, and only used if attributes 'name' or 'definition' are used so that the layout name can be set on generated widget instance. Available since 5.6. |
value | false | javax.el.ValueExpression
(must evaluate to java.lang.Object )
| The value on which widget will apply. If the widget holds field definitions, they will be resolved based on this value. For instance, if value is a document and the widget references the dc:title field, standard widgets will apply on the given document property. |
resolveOnly | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean )
| Boolean stating that the widget to render should be resolved and exposed in the context, but not displayed. Useful to generate the widget instance without rendering it right away. Available since 5.7. |
Output generated by Vdldoc View Declaration Language Documentation Generator.