layout (Tag Library Documentation Generator

Overview

Library

Tag

Help

FRAMES NO FRAMES

nxl
Tag layout

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.

'layout' references the computed layout.
'value' or 'layoutValue' references the given value, so that it can be used in the widget properties definitions, for instance. The 'value' variable is updated to the value passed to widget tag in a widget rendering context.

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}" /> <nxl:layout layout="#{myLayoutInstance}" value="#{myObject}" />

Tag Information
Tag Class	None
TagExtraInfo Class	None
Body Content	None
Display Name	None

Attributes
Name	Required	Request-time	Type	Description
name	false	false	`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	true	false	`java.lang.String`	Category of the layout (optional). Available since 5.5.
definition	false	false	`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	false	`java.lang.String`	Mode in which layout must be rendered. Required only if layout instance needs to be built.
value	true	false	`java.lang.String`	The value on which layout will apply.
layout	false	false	`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	false	`java.lang.String`	The template to use for this layout, overriding the template declared in the layout definition.
selectedRows	false	false	`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	false	`java.util.List`	Alias of selectedRows attribute.
selectAllByDefault	false	false	`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	false	`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.

Variables
No Variables Defined.

Overview

Library

Tag

Help

FRAMES NO FRAMES

Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.

nxl Tag layout

nxl
Tag layout