org.nuxeo.ecm.platform.forms.layout.facelets.plugins

Class TemplateWidgetTypeHandler

java.lang.Object

javax.faces.view.facelets.TagHandler

org.nuxeo.ecm.platform.forms.layout.facelets.WidgetTypeHandler

org.nuxeo.ecm.platform.forms.layout.facelets.plugins.AbstractWidgetTypeHandler

org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler

All Implemented Interfaces:

javax.faces.view.facelets.FaceletHandler

Direct Known Subclasses:

ActionWidgetTypeHandler, ListWidgetTypeHandler

public class TemplateWidgetTypeHandler
extends AbstractWidgetTypeHandler

Template widget type.

Author:

Anahide Tchertchian

Field Summary

Fields

Modifier and Type	Field and Description
static String	BIND_VALUE_IF_NO_FIELD_PROPERTY_NAME Property that can be put on the widget type definition to decide whether the widget type should bind to parent value when no field is set
static String	TEMPLATE_PROPERTY_NAME

Fields inherited from class org.nuxeo.ecm.platform.forms.layout.facelets.plugins.AbstractWidgetTypeHandler

DEV_TEMPLATE_PROPERTY_NAME, DISABLE_DEV_PROPERTY_NAME, properties, tagConfig, widget, widgetAttr

Fields inherited from class javax.faces.view.facelets.TagHandler

nextHandler, tag, tagId

Constructor Summary

Constructors

Constructor and Description
TemplateWidgetTypeHandler(javax.faces.view.facelets.TagConfig config)

Method Summary

Modifier and Type	Method and Description
protected void	addFieldVariable(Map<String,javax.el.ValueExpression> variables, javax.faces.view.facelets.FaceletContext ctx, Widget widget, FieldDefinition fieldDef, Integer index)
void	apply(javax.faces.view.facelets.FaceletContext ctx, javax.faces.component.UIComponent parent, Widget widget) Returns the facelet handler that will be applied for given widget and template in this context.
protected boolean	getBindValueIfNoFieldValue(Widget widget) Returns the "bindValueIfNoField" property value, looking up on the widget type definition first, and on the widget definition if not found.
protected javax.faces.view.facelets.TagAttribute	getTemplateAttribute(FaceletHandlerHelper helper) Returns the template attribute.
protected String	getTemplateValue(Widget widget) Returns the "template" property value, looking up on the widget definition definition first, and on the widget type definition if not found.
protected Map<String,javax.el.ValueExpression>	getVariablesForRendering(javax.faces.view.facelets.FaceletContext ctx, FaceletHandlerHelper helper, Widget widget, String widgetTagConfigId, String template) Computes variables for rendering, making available the field values in templates using the format "field_0", "field_1", etc.
protected String	lookupProperty(String name, Widget widget) Helper method to retrieve a property value, looking up on the widget definition first, and on the widget type definition if not found.

Methods inherited from class org.nuxeo.ecm.platform.forms.layout.facelets.plugins.AbstractWidgetTypeHandler

apply, getDevFaceletHandler, getDocumentConstraintValidatorHandler, getInputSlotHandler, getNextHandler, getNextHandler, getProperty, getRequiredProperty, setProperties, setWidget

Methods inherited from class javax.faces.view.facelets.TagHandler

getAttribute, getRequiredAttribute, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TEMPLATE_PROPERTY_NAME

public static final String TEMPLATE_PROPERTY_NAME

See Also:

Constant Field Values

BIND_VALUE_IF_NO_FIELD_PROPERTY_NAME

public static final String BIND_VALUE_IF_NO_FIELD_PROPERTY_NAME

Property that can be put on the widget type definition to decide whether the widget type should bind to parent value when no field is set

Since:

5.6

See Also:

Constant Field Values

Constructor Detail

TemplateWidgetTypeHandler

public TemplateWidgetTypeHandler(javax.faces.view.facelets.TagConfig config)

Method Detail

apply

public void apply(javax.faces.view.facelets.FaceletContext ctx,
                  javax.faces.component.UIComponent parent,
                  Widget widget)
           throws WidgetException,
                  IOException

Description copied from class: WidgetTypeHandler

Returns the facelet handler that will be applied for given widget and template in this context.

Specified by:

apply in class AbstractWidgetTypeHandler

Parameters:

ctx - the facelet context in which this handler will be applied.

parent - parent component in the JSF tree

widget - the widget giving properties the handler will take into account.

Throws:

WidgetException

IOException

getVariablesForRendering

protected Map<String,javax.el.ValueExpression> getVariablesForRendering(javax.faces.view.facelets.FaceletContext ctx,
                                                                        FaceletHandlerHelper helper,
                                                                        Widget widget,
                                                                        String widgetTagConfigId,
                                                                        String template)

Computes variables for rendering, making available the field values in templates using the format "field_0", "field_1", etc. and also the widget properties using the format "widgetProperty_thePropertyName".

addFieldVariable

protected void addFieldVariable(Map<String,javax.el.ValueExpression> variables,
                                javax.faces.view.facelets.FaceletContext ctx,
                                Widget widget,
                                FieldDefinition fieldDef,
                                Integer index)

getTemplateValue

protected String getTemplateValue(Widget widget)

Returns the "template" property value, looking up on the widget definition definition first, and on the widget type definition if not found.

lookupProperty

protected String lookupProperty(String name,
                                Widget widget)

Helper method to retrieve a property value, looking up on the widget definition first, and on the widget type definition if not found.

Since:

7.2

getBindValueIfNoFieldValue

protected boolean getBindValueIfNoFieldValue(Widget widget)

Returns the "bindValueIfNoField" property value, looking up on the widget type definition first, and on the widget definition if not found.

Parameters:

widget -

Returns:

Since:

5.6

getTemplateAttribute

protected javax.faces.view.facelets.TagAttribute getTemplateAttribute(FaceletHandlerHelper helper)

Returns the template attribute.