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:

java.io.Serializable, WidgetTypeHandler

Direct Known Subclasses:

CheckboxWidgetTypeHandler, DateTimeWidgetTypeHandler, DirectorySelectManyWidgetTypeHandler, DirectorySelectOneWidgetTypeHandler, FileWidgetTypeHandler, HiddenWidgetTypeHandler, HtmlTextWidgetTypeHandler, IntWidgetTypeHandler, LayoutWidgetTypeHandler, SecretWidgetTypeHandler, TemplateWidgetTypeHandler, TextareaWidgetTypeHandler, TextWidgetTypeHandler

public abstract class AbstractWidgetTypeHandler
extends java.lang.Object
implements WidgetTypeHandler

Abstract widget type handler.

Author:

Anahide Tchertchian

See Also:

Serialized Form

Constructor Summary

AbstractWidgetTypeHandler()

Method Summary

abstract com.sun.facelets.FaceletHandler	getFaceletHandler(com.sun.facelets.FaceletContext ctx, com.sun.facelets.tag.TagConfig tagConfig, Widget widget, com.sun.facelets.FaceletHandler[] subHandlers) Returns the facelet handler that will be applied for given widget and template in this context.
java.lang.String	getProperty(java.lang.String name) Returns a property value given its name.
java.lang.String	getRequiredProperty(java.lang.String name) Helper method, throws an exception if property value is null.
void	setProperties(java.util.Map<java.lang.String,java.lang.String> properties) Set properties

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractWidgetTypeHandler

public AbstractWidgetTypeHandler()

Method Detail

getFaceletHandler

public abstract com.sun.facelets.FaceletHandler getFaceletHandler(com.sun.facelets.FaceletContext ctx,
                                                                  com.sun.facelets.tag.TagConfig tagConfig,
                                                                  Widget widget,
                                                                  com.sun.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

getProperty

public java.lang.String getProperty(java.lang.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 java.lang.String getRequiredProperty(java.lang.String name)
                                     throws WidgetException

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

Throws:

WidgetException

setProperties

public void setProperties(java.util.Map<java.lang.String,java.lang.String> properties)

Description copied from interface: WidgetTypeHandler

Set properties

Specified by:

setProperties in interface WidgetTypeHandler