Facelet tag handler that renders all layouts attached to a document in a given mode.
Layouts are built using the document type definition. This tag is equivalent to rendering each layout in given mode, using document as value.
Any additional property set on the tag and that is not explicitely in the list of handled attributes is added to each of the layouts properties, overriding properties that already set in the layout definitions.
Example:<nxl:documentLayout mode="#{myMode}" value="#{myDocument}" />
Name | Required | Type | Description |
---|---|---|---|
mode | true | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Mode in which layouts must be taken on the document definition, as well as rendered if attribute "documentMode" is not defined. |
documentMode | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Mode in which layouts must be taken on the document definition, if defined (otherwise, will use the "mode" attribute value). |
value | true | javax.el.ValueExpression
(must evaluate to org.nuxeo.ecm.core.api.DocumentModel )
| The document for which layouts will be built and rendered. |
template | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| The template to use for layouts, overriding each of the templates declared in the layouts definitions. |
defaultLayout | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| The default layout to be rendered if no layout is found on the document definition. Available since 5.4.2. |
includeAnyMode | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean )
| Boolean indicating if layouts declared in the 'any' mode on the document definition should be used if no layout is found for the wanted mode. Defaults to true. Available since 5.4.2. |
Output generated by Vdldoc View Declaration Language Documentation Generator.