widget (Tag Library Documentation Generator

Overview

Library

Tag

Help

FRAMES NO FRAMES

nxl
Tag widget

Facelet tag handler that renders a widget in a given mode.

When rendered, some variables are exposed to the resolution context:

'value' references the given widget value.
'widget' references the widget. It is also referenced by 'widget_0' or 'widget_1',... the number being the widget level in the hierarchy of widgets.
widgets of type 'template' also expose field values by 'field_0' or 'field_1',... the number being the field definition index in the field definitions list.

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}" />

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

Attributes
Name	Required	Request-time	Type	Description
widget	false	false	`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	false	`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	true	false	`java.lang.String`	Category of the widget (optional). Available since 5.6, and used in conjunction with the 'name' attribute.
definition	false	false	`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	false	`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	false	`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	false	`java.lang.String`	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	false	`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.

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 widget

nxl
Tag widget