nxl
Tag widgetType


Facelet tag handler that renders a widget outside of a layout context, in a given mode.

This is helpful to reuse an existing widget within templates that do not need an entire layout to be defined.

In addition to the following attributes, any optional attributes are accepted and are used as properties of the created widget.

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


Example:
<nxl:widgetType name="text" mode="#{myMode}" value="#{myText}" required="true" /> or <nxl:widgetType name="#{myWidgetType}" mode="#{myMode}" value="#{myBoundProperty}" properties="#{myProperties}" />


Tag Information
Tag ClassNone
TagExtraInfo ClassNone
Body ContentNone
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
nametruefalsejava.lang.StringName of the widget type that will be used: can be 'text', 'template',... or any widget type registered on the pluggable layout system.
modetruefalsejava.lang.StringMode in which widget must be rendered.
categoryfalsefalsejava.lang.StringName of the widget type category that will be used. Available since 5.7.3, defaults implicitely to "jsf" when not set for compatibility.
valuefalsefalsejava.lang.StringThe value on which widget will apply. If the "fields" attribute is not defined, it has to represent the bound property. Otherwise, it is used as a base for fields definitions that will represent the bound properties.
fieldfalsefalsejava.lang.StringThe field definition on which the widget will apply. Must resolve to a FieldDefinition instances, or String item. If fields is also defined, this field definitions is added to the list. Available since 5.5.
fieldsfalsefalsejava.lang.StringThe field definitions on which the widget will apply. Must resolve to a list of FieldDefinition instances, or a list of String items. Available since 5.4.2.
widgetNamefalsefalsejava.lang.StringThe String widget Name. Available since 5.7. If is not present, a name is generated instead.
propertiesfalsefalsejava.lang.StringThe widget properties. Must resolve to an instance of Map. Any other tag attributes are accepted and will be added on top of these properties. Available since 5.4.2.
labelfalsefalsejava.lang.StringThe String widget label. Available since 5.4.2.
helpLabelfalsefalsejava.lang.StringThe String widget help label. Available since 5.4.2.
translatedfalsefalsejava.lang.StringThe boolean value stating if the widget labels have to be translated. Available since 5.4.2.
ignoreTemplatePropertyfalsefalsejava.lang.StringBoolean value stating if "template" property should be removed from the widget properties. Convenient attribute to avoid stack overflow errors when using another widget type in a widget template, for compatibility code for instance. Available since 5.6.
subWidgetsfalsefalsejava.lang.StringThe array of widgets instances (Widget[]) to add to the created widget. Available since 5.6.
resolveOnlyfalsefalsejava.lang.BooleanBoolean 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.


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.