Facelet tag handler that renders a layout in a given mode.
When rendered, some variables are exposed to the resolution context and can be used within the template attached to the layout.
Any additional property set on the tag and that is not explicitely in the list of handled attributes is added to the layout properties, overriding properties that already set in the layout definition.
Example:<nxl:layout name="dublincore" mode="#{myMode}" value="#{myObject}" /> or <nxl:layout definition="#{myLayoutDefinition}" mode="#{myMode}" value="#{myObject}" /> or <nxl:layout layout="#{myLayoutInstance}" value="#{myObject}" />
Name | Required | Type | Description |
---|---|---|---|
name | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Name of the layout as registered on the pluggable layout system. Required if the 'layout' or 'definition' attributes are not filled. Since 5.6, also accepts a list of layout names, separated by commas. |
category | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Category of the layout (optional). Available since 5.5, 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.LayoutDefinition )
| Layout definition as it would be retrieved from the layout store service. This attribute is required if the layout or name attributes are not filled: it makes it possible to render a layout generated dynamically. Available since 5.4.2. |
mode | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Mode in which layout must be rendered. Required only if layout instance needs to be built. |
value | true | java.lang.Object | The value on which layout will apply. |
layout | false | javax.el.ValueExpression
(must evaluate to org.nuxeo.ecm.platform.forms.layout.api.Layout )
| Layout instance to rendered. This attribute is required if none of the 'definition' or 'name' attributes are filled: it makes it possible to render a layout generated dynamically or already in the context. Available since 5.7. |
template | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| The template to use for this layout, overriding the template declared in the layout definition. |
selectedRows | false | javax.el.ValueExpression
(must evaluate to java.util.List )
| String list of row names that are selected. If not null, the layout rows will be filtered according to this list. If null, only the rows marked as selected by default will be taken into account, unless attribute selectAllByDefault is set to true. Defaults to null. Is available since version 5.4. |
selectedColumns | false | javax.el.ValueExpression
(must evaluate to java.util.List )
| Alias of selectedRows attribute. |
selectAllByDefault | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean )
| Boolean indicating if all rows should be considered selected by default. Will have an impact only if attribute selectedRows or alias selectedColumns resolve to a null value. Defaults to false. Is available since version 5.4. |
resolveOnly | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean )
| Boolean stating that the layout to render should be resolved and exposed in the context, but not displayed. Useful to generate the layout instance without rendering it right away. Available since 5.7. |
Output generated by Vdldoc View Declaration Language Documentation Generator.