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

Class AbstractDirectorySelectWidgetTypeHandler

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.AbstractSelectWidgetTypeHandler

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

All Implemented Interfaces:

javax.faces.view.facelets.FaceletHandler

Direct Known Subclasses:

DirectorySelectManyWidgetTypeHandler, DirectorySelectOneWidgetTypeHandler, SelectDirectoryAggregateWidgetTypeHandler

public abstract class AbstractDirectorySelectWidgetTypeHandler
extends AbstractSelectWidgetTypeHandler

Helper class for options generation depending on the widget definition

Since:

5.4.2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractDirectorySelectWidgetTypeHandler.DirectoryPropertyMappings

Nested classes/interfaces inherited from class org.nuxeo.ecm.platform.forms.layout.facelets.plugins.AbstractSelectWidgetTypeHandler

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, tagConfig, widget, widgetAttr

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

nextHandler, tag, tagId

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected List<String>	getExcludedProperties() Returns properties useful for select items, not to be reported on the select component.
protected String	getOptionComponentType(WidgetSelectOption selectOption)
protected Map<String,Serializable>	getOptionProperties(javax.faces.view.facelets.FaceletContext ctx, Widget widget, WidgetSelectOption selectOption)
protected javax.faces.view.facelets.TagAttributes	getTagAttributesForMode(Widget widget, String mode, FaceletHandlerHelper helper, String widgetId) Get tag attributes for a specific mode.
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.AbstractSelectWidgetTypeHandler

apply, apply, getBareOptionFaceletHandler, getComponentFaceletHandler, getFirstHandler, getOptionFaceletHandler, getOptionsFaceletHandler, getOptionsFaceletHandler, getWidgetPropsHandler

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

apply, 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

Constructor Detail

AbstractDirectorySelectWidgetTypeHandler

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

Method Detail

getExcludedProperties

protected List<String> getExcludedProperties()

Description copied from class: AbstractSelectWidgetTypeHandler

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

Overrides:

getExcludedProperties in class AbstractSelectWidgetTypeHandler

getOptionComponentType

protected String getOptionComponentType(WidgetSelectOption selectOption)

Overrides:

getOptionComponentType in class AbstractSelectWidgetTypeHandler

shouldAddWidgetPropsHandler

protected boolean shouldAddWidgetPropsHandler(Widget widget)

Description copied from class: AbstractSelectWidgetTypeHandler

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.

Overrides:

shouldAddWidgetPropsHandler in class AbstractSelectWidgetTypeHandler

getOptionProperties

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

Overrides:

getOptionProperties in class AbstractSelectWidgetTypeHandler

getTagAttributesForMode

protected javax.faces.view.facelets.TagAttributes getTagAttributesForMode(Widget widget,
                                                                          String mode,
                                                                          FaceletHandlerHelper helper,
                                                                          String widgetId)

Get tag attributes for a specific mode.

Parameters:

widget - The widget to generate tag attributes for.

mode - The given mode like PLAIN, CSV.

helper - An instance of FaceletHandlerHelper.

widgetId - The widget id.

Returns:

Since:

9.3