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

Class AbstractWidgetTypeHandler

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

All Implemented Interfaces:

javax.faces.view.facelets.FaceletHandler

Direct Known Subclasses:

AbstractSelectWidgetTypeHandler, CheckboxWidgetTypeHandler, DateTimeWidgetTypeHandler, DoubleWidgetTypeHandler, FileWidgetTypeHandler, HiddenWidgetTypeHandler, HtmlTextWidgetTypeHandler, IntWidgetTypeHandler, LayoutWidgetTypeHandler, SecretWidgetTypeHandler, TemplateWidgetTypeHandler, TextareaWidgetTypeHandler, TextWidgetTypeHandler

public abstract class AbstractWidgetTypeHandler
extends WidgetTypeHandler

Abstract widget type handler.

Author:

Anahide Tchertchian

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEV_TEMPLATE_PROPERTY_NAME
static String	DISABLE_DEV_PROPERTY_NAME
protected Map<String,String>	properties
protected javax.faces.view.facelets.TagConfig	tagConfig
protected Widget	widget
protected javax.faces.view.facelets.TagAttribute	widgetAttr

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

nextHandler, tag, tagId

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	apply(javax.faces.view.facelets.FaceletContext ctx, javax.faces.component.UIComponent parent)
abstract 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.
javax.faces.view.facelets.FaceletHandler	getDevFaceletHandler(javax.faces.view.facelets.TagConfig tagConfig, Widget widget) Returns the facelet handler used for dev mode.
protected javax.faces.view.facelets.FaceletHandler	getDocumentConstraintValidatorHandler(javax.faces.view.facelets.FaceletContext ctx, javax.faces.view.facelets.TagConfig tagConfig, Widget widget, javax.faces.view.facelets.FaceletHandler[] subHandlers, FaceletHandlerHelper helper)
protected javax.faces.view.facelets.FaceletHandler	getInputSlotHandler(javax.faces.view.facelets.FaceletContext ctx, javax.faces.view.facelets.TagConfig tagConfig, Widget widget, javax.faces.view.facelets.FaceletHandler[] subHandlers, FaceletHandlerHelper helper)
protected javax.faces.view.facelets.FaceletHandler	getNextHandler(javax.faces.view.facelets.FaceletContext ctx, javax.faces.view.facelets.TagConfig tagConfig, Widget widget, javax.faces.view.facelets.FaceletHandler[] subHandlers, FaceletHandlerHelper helper) Returns sub handlers as computed from tag information.
protected javax.faces.view.facelets.FaceletHandler	getNextHandler(javax.faces.view.facelets.FaceletContext ctx, javax.faces.view.facelets.TagConfig tagConfig, Widget widget, javax.faces.view.facelets.FaceletHandler[] subHandlers, FaceletHandlerHelper helper, boolean addInputSlot, boolean addDocumentConstraintValidator) Returns sub handlers as computed from tag information.
String	getProperty(String name) Returns a property value given its name.
String	getRequiredProperty(String name) Helper method, throws an exception if property value is null.
void	setProperties(Map<String,String> properties) Set properties
void	setWidget(Widget widget)

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

DEV_TEMPLATE_PROPERTY_NAME

public static final String DEV_TEMPLATE_PROPERTY_NAME

Since:

6.0

See Also:

Constant Field Values

DISABLE_DEV_PROPERTY_NAME

public static final String DISABLE_DEV_PROPERTY_NAME

Since:

6.0

See Also:

Constant Field Values

tagConfig

protected final javax.faces.view.facelets.TagConfig tagConfig

properties

protected Map<String,String> properties

widget

protected Widget widget

widgetAttr

protected final javax.faces.view.facelets.TagAttribute widgetAttr

Constructor Detail

AbstractWidgetTypeHandler

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

Method Detail

apply

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

Throws:

IOException

apply

public abstract 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 WidgetTypeHandler

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

getDevFaceletHandler

public javax.faces.view.facelets.FaceletHandler getDevFaceletHandler(javax.faces.view.facelets.TagConfig tagConfig,
                                                                     Widget widget)
                                                              throws WidgetException

Description copied from class: WidgetTypeHandler

Returns the facelet handler used for dev mode.

Specified by:

getDevFaceletHandler in class WidgetTypeHandler

Throws:

WidgetException

getProperty

public String getProperty(String name)

Description copied from class: WidgetTypeHandler

Returns a property value given its name.

Specified by:

getProperty in class WidgetTypeHandler

Returns:

property with this name.

getRequiredProperty

public String getRequiredProperty(String name)
                           throws WidgetException

Helper method, throws an exception if property value is null.

Throws:

WidgetException

setProperties

public void setProperties(Map<String,String> properties)

Description copied from class: WidgetTypeHandler

Set properties

Specified by:

setProperties in class WidgetTypeHandler

setWidget

public void setWidget(Widget widget)

Specified by:

setWidget in class WidgetTypeHandler

getNextHandler

protected javax.faces.view.facelets.FaceletHandler getNextHandler(javax.faces.view.facelets.FaceletContext ctx,
                                                                  javax.faces.view.facelets.TagConfig tagConfig,
                                                                  Widget widget,
                                                                  javax.faces.view.facelets.FaceletHandler[] subHandlers,
                                                                  FaceletHandlerHelper helper)

Returns sub handlers as computed from tag information.

Adds an sub insert handler slot named RenderVariables.widgetTemplatingZones#inside_input_widget when widget is in edit mode.

Adds an sub document constraint validator handler named DocumentConstraintValidator.VALIDATOR_ID when widget is in edit mode.

Since:

6.0

getNextHandler

protected javax.faces.view.facelets.FaceletHandler getNextHandler(javax.faces.view.facelets.FaceletContext ctx,
                                                                  javax.faces.view.facelets.TagConfig tagConfig,
                                                                  Widget widget,
                                                                  javax.faces.view.facelets.FaceletHandler[] subHandlers,
                                                                  FaceletHandlerHelper helper,
                                                                  boolean addInputSlot,
                                                                  boolean addDocumentConstraintValidator)

Returns sub handlers as computed from tag information.

Adds an input slot if corresponding boolean parameter is true.

Adds an document constraint validator if corresponding boolean parameter is true.

Since:

7.2

getInputSlotHandler

protected javax.faces.view.facelets.FaceletHandler getInputSlotHandler(javax.faces.view.facelets.FaceletContext ctx,
                                                                       javax.faces.view.facelets.TagConfig tagConfig,
                                                                       Widget widget,
                                                                       javax.faces.view.facelets.FaceletHandler[] subHandlers,
                                                                       FaceletHandlerHelper helper)

getDocumentConstraintValidatorHandler

protected javax.faces.view.facelets.FaceletHandler getDocumentConstraintValidatorHandler(javax.faces.view.facelets.FaceletContext ctx,
                                                                                         javax.faces.view.facelets.TagConfig tagConfig,
                                                                                         Widget widget,
                                                                                         javax.faces.view.facelets.FaceletHandler[] subHandlers,
                                                                                         FaceletHandlerHelper helper)