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

Class AbstractWidgetTypeHandler

java.lang.Object

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

All Implemented Interfaces:

Serializable, WidgetTypeHandler

Direct Known Subclasses:

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

public abstract class AbstractWidgetTypeHandler
extends Object
implements WidgetTypeHandler

Abstract widget type handler.

Author:

Anahide Tchertchian

See Also:

Serialized Form

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

Constructor Summary

Constructors

Constructor and Description
AbstractWidgetTypeHandler()

Method Summary

Modifier and Type	Method and Description
javax.faces.view.facelets.FaceletHandler	getDevFaceletHandler(javax.faces.view.facelets.FaceletContext ctx, 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)
abstract javax.faces.view.facelets.FaceletHandler	getFaceletHandler(javax.faces.view.facelets.FaceletContext ctx, javax.faces.view.facelets.TagConfig tagConfig, Widget widget, javax.faces.view.facelets.FaceletHandler[] subHandlers) Returns the facelet handler that will be applied for given widget and template in this context.
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) Deprecated. since 7.2, use getNextHandler(FaceletContext, TagConfig, Widget, FaceletHandler[], FaceletHandlerHelper, boolean, boolean) instead
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

properties

protected Map<String,String> properties

Constructor Detail

AbstractWidgetTypeHandler

public AbstractWidgetTypeHandler()

Method Detail

getFaceletHandler

public abstract javax.faces.view.facelets.FaceletHandler getFaceletHandler(javax.faces.view.facelets.FaceletContext ctx,
                                                                           javax.faces.view.facelets.TagConfig tagConfig,
                                                                           Widget widget,
                                                                           javax.faces.view.facelets.FaceletHandler[] subHandlers)
                                                                    throws WidgetException

Description copied from interface: WidgetTypeHandler

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

Specified by:

getFaceletHandler in interface WidgetTypeHandler

Parameters:

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

tagConfig - the tag configuration this facelet will be applied for.

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

subHandlers - facelet handlers for sub widgets.

Returns:

a facelet handler.

Throws:

WidgetException

getDevFaceletHandler

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

Description copied from interface: WidgetTypeHandler

Returns the facelet handler used for dev mode.

Specified by:

getDevFaceletHandler in interface WidgetTypeHandler

Throws:

WidgetException

getProperty

public String getProperty(String name)

Description copied from interface: WidgetTypeHandler

Returns a property value given its name.

Specified by:

getProperty in interface 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 interface: WidgetTypeHandler

Set properties

Specified by:

setProperties in interface 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)

Deprecated. since 7.2, use getNextHandler(FaceletContext, TagConfig, Widget, FaceletHandler[], FaceletHandlerHelper, boolean, boolean) instead

Returns sub handlers as computed from tag information.

Adds an input slot if corresponding boolean parameter is true.

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)