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

Class AbstractSelectWidgetTypeHandler

java.lang.Object

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

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

All Implemented Interfaces:

Serializable, WidgetTypeHandler

Direct Known Subclasses:

AbstractDirectorySelectWidgetTypeHandler, SelectAggregateWidgetTypeHandler, SelectManyCheckboxWidgetTypeHandler, SelectManyListboxWidgetTypeHandler, SelectManyMenuWidgetTypeHandler, SelectOneListboxWidgetTypeHandler, SelectOneMenuWidgetTypeHandler, SelectOneRadioWidgetTypeHandler

public abstract class AbstractSelectWidgetTypeHandler
extends AbstractWidgetTypeHandler

Helper class for options generation depending on the widget definition

Since:

5.4.2

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractSelectWidgetTypeHandler.SelectPropertyMappings

Field Summary

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

DEV_TEMPLATE_PROPERTY_NAME, DISABLE_DEV_PROPERTY_NAME, properties

Constructor Summary

Constructors

Constructor and Description
AbstractSelectWidgetTypeHandler()

Method Summary

Modifier and Type	Method and Description
protected javax.faces.view.facelets.FaceletHandler	getBareOptionFaceletHandler(javax.faces.view.facelets.FaceletContext ctx, FaceletHandlerHelper helper, Widget widget, WidgetSelectOption selectOption, javax.faces.view.facelets.FaceletHandler nextHandler)
protected javax.faces.view.facelets.FaceletHandler	getComponentFaceletHandler(javax.faces.view.facelets.FaceletContext ctx, FaceletHandlerHelper helper, Widget widget, javax.faces.view.facelets.FaceletHandler componentHandler)
protected List<String>	getExcludedProperties() Returns properties useful for select items, not to be reported on the select component.
protected 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, String componentType)
protected 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, String componentType, String rendererType)
protected javax.faces.view.facelets.FaceletHandler	getFirstHandler(javax.faces.view.facelets.FaceletContext ctx, FaceletHandlerHelper helper, Widget widget, javax.faces.view.facelets.FaceletHandler nextHandler) Adds a default disabled "select a value" option if widget is not required.
protected String	getOptionComponentType(WidgetSelectOption selectOption)
protected javax.faces.view.facelets.FaceletHandler	getOptionFaceletHandler(javax.faces.view.facelets.FaceletContext ctx, FaceletHandlerHelper helper, Widget widget, WidgetSelectOption selectOption, javax.faces.view.facelets.FaceletHandler nextHandler)
protected Map<String,Serializable>	getOptionProperties(javax.faces.view.facelets.FaceletContext ctx, Widget widget, WidgetSelectOption selectOption)
protected javax.faces.view.facelets.FaceletHandler	getOptionsFaceletHandler(javax.faces.view.facelets.FaceletContext ctx, FaceletHandlerHelper helper, Widget widget)
protected javax.faces.view.facelets.FaceletHandler	getOptionsFaceletHandler(javax.faces.view.facelets.FaceletContext ctx, FaceletHandlerHelper helper, Widget widget, WidgetSelectOption[] selectOptions)
protected javax.faces.view.facelets.FaceletHandler	getWidgetPropsHandler(javax.faces.view.facelets.FaceletContext ctx, FaceletHandlerHelper helper, Widget widget, javax.faces.view.facelets.FaceletHandler nextHandler) Computes select options from widget properties.
protected boolean	shouldAddWidgetPropsHandler(Widget widget) Returns true if widget properties should generate a default tag handler for select options.

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

getDevFaceletHandler, getDocumentConstraintValidatorHandler, getFaceletHandler, getInputSlotHandler, getNextHandler, getNextHandler, getNextHandler, getProperty, getRequiredProperty, setProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSelectWidgetTypeHandler

public AbstractSelectWidgetTypeHandler()

Method Detail

getOptionProperties

protected Map<String,Serializable> getOptionProperties(javax.faces.view.facelets.FaceletContext ctx,
                                                       Widget widget,
                                                       WidgetSelectOption selectOption)

getOptionComponentType

protected String getOptionComponentType(WidgetSelectOption selectOption)

getOptionFaceletHandler

protected javax.faces.view.facelets.FaceletHandler getOptionFaceletHandler(javax.faces.view.facelets.FaceletContext ctx,
                                                                           FaceletHandlerHelper helper,
                                                                           Widget widget,
                                                                           WidgetSelectOption selectOption,
                                                                           javax.faces.view.facelets.FaceletHandler nextHandler)

getBareOptionFaceletHandler

protected javax.faces.view.facelets.FaceletHandler getBareOptionFaceletHandler(javax.faces.view.facelets.FaceletContext ctx,
                                                                               FaceletHandlerHelper helper,
                                                                               Widget widget,
                                                                               WidgetSelectOption selectOption,
                                                                               javax.faces.view.facelets.FaceletHandler nextHandler)

getFirstHandler

protected javax.faces.view.facelets.FaceletHandler getFirstHandler(javax.faces.view.facelets.FaceletContext ctx,
                                                                   FaceletHandlerHelper helper,
                                                                   Widget widget,
                                                                   javax.faces.view.facelets.FaceletHandler nextHandler)

Adds a default disabled "select a value" option if widget is not required.

Since:

6.0

shouldAddWidgetPropsHandler

protected boolean shouldAddWidgetPropsHandler(Widget widget)

Returns true if widget properties should generate a default tag handler for select options.

This default implementation requires the selectOptions widget property to be filled.

Since:

6.0

getWidgetPropsHandler

protected javax.faces.view.facelets.FaceletHandler getWidgetPropsHandler(javax.faces.view.facelets.FaceletContext ctx,
                                                                         FaceletHandlerHelper helper,
                                                                         Widget widget,
                                                                         javax.faces.view.facelets.FaceletHandler nextHandler)

Computes select options from widget properties.

Since:

6.0

getOptionsFaceletHandler

protected javax.faces.view.facelets.FaceletHandler getOptionsFaceletHandler(javax.faces.view.facelets.FaceletContext ctx,
                                                                            FaceletHandlerHelper helper,
                                                                            Widget widget,
                                                                            WidgetSelectOption[] selectOptions)

getOptionsFaceletHandler

protected javax.faces.view.facelets.FaceletHandler getOptionsFaceletHandler(javax.faces.view.facelets.FaceletContext ctx,
                                                                            FaceletHandlerHelper helper,
                                                                            Widget widget)

getExcludedProperties

protected List<String> getExcludedProperties()

Returns properties useful for select items, not to be reported on the select component.

getFaceletHandler

protected 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,
                                                                     String componentType)
                                                              throws WidgetException

Throws:

WidgetException

getComponentFaceletHandler

protected javax.faces.view.facelets.FaceletHandler getComponentFaceletHandler(javax.faces.view.facelets.FaceletContext ctx,
                                                                              FaceletHandlerHelper helper,
                                                                              Widget widget,
                                                                              javax.faces.view.facelets.FaceletHandler componentHandler)

getFaceletHandler

protected 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,
                                                                     String componentType,
                                                                     String rendererType)
                                                              throws WidgetException

Throws:

WidgetException