org.nuxeo.ecm.platform.forms.layout.service

Class WebLayoutManagerImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.platform.forms.layout.core.service.AbstractLayoutManager

org.nuxeo.ecm.platform.forms.layout.service.WebLayoutManagerImpl

All Implemented Interfaces:

Serializable, LayoutManager, WebLayoutManager, Adaptable, Component, Extensible, TimestampedService

public class WebLayoutManagerImpl
extends AbstractLayoutManager
implements WebLayoutManager

Layout service implementation.

Author:

Anahide Tchertchian

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	LAYOUT_TYPES_EP_NAME
static String	LAYOUTS_EP_NAME
static ComponentName	NAME
static String	PROPS_REF_EP_NAME
static String	WIDGET_TYPES_EP_NAME
static String	WIDGETS_EP_NAME

Fields inherited from interface org.nuxeo.ecm.platform.forms.layout.service.WebLayoutManager

JSF_CATEGORY

Constructor Summary

Constructors

Constructor and Description
WebLayoutManagerImpl()

Method Summary

Methods

Modifier and Type	Method and Description
Widget	createWidget(javax.faces.view.facelets.FaceletContext ctx, String type, String mode, String valueName, List<FieldDefinition> fieldDefinitions, String label, String helpLabel, Boolean translated, Map<String,Serializable> properties, Widget[] subWidgets) Returns a widget computed from given information.
Widget	createWidget(javax.faces.view.facelets.FaceletContext ctx, String type, String mode, String valueName, Map<String,Serializable> properties, Widget[] subWidgets) Returns a widget computed from given information.
Widget	createWidget(javax.faces.view.facelets.FaceletContext ctx, WidgetDefinition wDef, String mode, String valueName, Widget[] subWidgets) Returns a widget computed from given information.
String	getDefaultStoreCategory() Return the default category used for storage
javax.faces.view.facelets.FaceletHandler	getFaceletHandler(javax.faces.view.facelets.FaceletContext ctx, javax.faces.view.facelets.TagConfig config, Widget widget) Returns the facelet handler for given widget.
javax.faces.view.facelets.FaceletHandler	getFaceletHandler(javax.faces.view.facelets.FaceletContext ctx, javax.faces.view.facelets.TagConfig config, Widget widget, javax.faces.view.facelets.FaceletHandler nextHandler) Returns the facelet handler for given widget.
Layout	getLayout(javax.faces.view.facelets.FaceletContext ctx, LayoutDefinition layoutDef, String mode, String valueName, List<String> selectedRows, boolean selectAllRowsByDefault) Returns the computed layout for this definition, mode and list of selected rows in given context, or null if the layout definition is null.
Layout	getLayout(javax.faces.view.facelets.FaceletContext ctx, String layoutName, String mode, String valueName) Returns the computed layout for this name and mode in given context, or null if no layout with this name is found.
Layout	getLayout(javax.faces.view.facelets.FaceletContext ctx, String layoutName, String mode, String valueName, List<String> selectedRows, boolean selectAllRowsByDefault) Returns the computed layout for this name, mode and list of selected rows in given context, or null if no layout with this name is found.
Layout	getLayout(javax.faces.view.facelets.FaceletContext ctx, String layoutName, String layoutCategory, String mode, String valueName, List<String> selectedRows, boolean selectAllRowsByDefault) Returns the computed layout for this name, category, mode and list of selected rows in given context, or null if no layout with this name is found.
Widget	getWidget(javax.faces.view.facelets.FaceletContext ctx, String widgetName, String widgetCategory, String layoutMode, String valueName, String layoutName) Returns a widget instance given a name and a category, as it would be computed when defined within a layout.
Widget	getWidget(javax.faces.view.facelets.FaceletContext ctx, WidgetDefinition wDef, String layoutMode, String valueName, String layoutName) Returns a widget instance given a name and a category, as it would be computed when defined within a layout.
WidgetTypeHandler	getWidgetTypeHandler(String typeName) Returns the widget type handler for the registered widget type with this type name.
WidgetTypeHandler	getWidgetTypeHandler(String typeCategory, String typeName) Returns the widget type handler for the registered widget type with this type name and type category.
boolean	referencePropertyAsExpression(String name, Serializable value, String widgetType, String widgetMode, String template) Returns true if property with given name and value should be referenced as a value expression.
boolean	referencePropertyAsExpression(String name, Serializable value, String widgetType, String widgetTypeCategory, String widgetMode, String template) Returns true if property with given name and value should be referenced as a value expression.
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)

Methods inherited from class org.nuxeo.ecm.platform.forms.layout.core.service.AbstractLayoutManager

getLayoutDefinition, getLayoutDefinitionNames, getLayoutTypeDefinition, getLayoutTypeDefinitions, getWidgetDefinition, getWidgetType, getWidgetTypeDefinition, getWidgetTypeDefinitions

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, applicationStarted, deactivate, getAdapter, getApplicationStartedOrder, getLastModified, registerExtension, setLastModified, unregisterExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.platform.forms.layout.api.service.LayoutManager

getLayoutDefinition, getLayoutDefinitionNames, getLayoutTypeDefinition, getLayoutTypeDefinitions, getWidgetDefinition, getWidgetType, getWidgetTypeDefinition, getWidgetTypeDefinitions

Field Detail

NAME

public static final ComponentName NAME

WIDGET_TYPES_EP_NAME

public static final String WIDGET_TYPES_EP_NAME

See Also:

Constant Field Values

LAYOUT_TYPES_EP_NAME

public static final String LAYOUT_TYPES_EP_NAME

Since:

6.0

See Also:

Constant Field Values

WIDGETS_EP_NAME

public static final String WIDGETS_EP_NAME

See Also:

Constant Field Values

LAYOUTS_EP_NAME

public static final String LAYOUTS_EP_NAME

See Also:

Constant Field Values

PROPS_REF_EP_NAME

public static final String PROPS_REF_EP_NAME

See Also:

Constant Field Values

Constructor Detail

WebLayoutManagerImpl

public WebLayoutManagerImpl()

Method Detail

registerContribution

public void registerContribution(Object contribution,
                        String extensionPoint,
                        ComponentInstance contributor)

Overrides:

registerContribution in class DefaultComponent

unregisterContribution

public void unregisterContribution(Object contribution,
                          String extensionPoint,
                          ComponentInstance contributor)

Overrides:

unregisterContribution in class DefaultComponent

getDefaultStoreCategory

public String getDefaultStoreCategory()

Description copied from interface: LayoutManager

Return the default category used for storage

Specified by:

getDefaultStoreCategory in interface LayoutManager

Specified by:

getDefaultStoreCategory in class AbstractLayoutManager

getWidgetTypeHandler

public WidgetTypeHandler getWidgetTypeHandler(String typeName)
                                       throws WidgetException

Description copied from interface: WebLayoutManager

Returns the widget type handler for the registered widget type with this type name.

If the no widget type is found with this name, return null.

Specified by:

getWidgetTypeHandler in interface WebLayoutManager

Throws:

WidgetException

getWidgetTypeHandler

public WidgetTypeHandler getWidgetTypeHandler(String typeCategory,
                                     String typeName)
                                       throws WidgetException

Description copied from interface: WebLayoutManager

Returns the widget type handler for the registered widget type with this type name and type category.

If the no widget type is found with this name, return null.

Specified by:

getWidgetTypeHandler in interface WebLayoutManager

Throws:

WidgetException

getWidget

public Widget getWidget(javax.faces.view.facelets.FaceletContext ctx,
               String widgetName,
               String widgetCategory,
               String layoutMode,
               String valueName,
               String layoutName)

Description copied from interface: WebLayoutManager

Returns a widget instance given a name and a category, as it would be computed when defined within a layout.

Specified by:

getWidget in interface WebLayoutManager

Parameters:

ctx - the facelet context this widget will be computed in. If context is null, no expressions can be resolved during computing.

widgetName - the widget name

widgetCategory - the widget category

layoutMode - the pseudo layout mode

layoutName - the pseudo layout name (if any)

Returns:

the widget instance, or null if widget definition could not be resolved.

getWidget

public Widget getWidget(javax.faces.view.facelets.FaceletContext ctx,
               WidgetDefinition wDef,
               String layoutMode,
               String valueName,
               String layoutName)

Description copied from interface: WebLayoutManager

Returns a widget instance given a name and a category, as it would be computed when defined within a layout.

Specified by:

getWidget in interface WebLayoutManager

Parameters:

ctx - the facelet context this widget will be computed in. If context is null, no expressions can be resolved during computing.

wDef - the widget definition

layoutMode - the pseudo layout mode

valueName - the value name to use when computing tag attributes (useful for fields mapping)

layoutName - the pseudo layout name (if any)

Returns:

the widget instance, or null if the widget definition is null.

getLayout

public Layout getLayout(javax.faces.view.facelets.FaceletContext ctx,
               String layoutName,
               String mode,
               String valueName)
                 throws LayoutException

Description copied from interface: WebLayoutManager

Returns the computed layout for this name and mode in given context, or null if no layout with this name is found.

When a widget is configured not to be rendered in this mode, the layout will hold a null value instead. As well, when a row does not hold any non-null widget in this mode, the layout will not hold it.

Specified by:

getLayout in interface WebLayoutManager

Parameters:

ctx - the facelet context this layout will be computed in. If context is null, no expressions can be resolved during computing.

layoutName - the layout definition name.

mode - the mode.

valueName - the value name to use when computing tag attributes.

Returns:

a layout computed in this context.

Throws:

LayoutException

See Also:

WebLayoutManager.getLayout(FaceletContext, String, String, String, List, boolean)

getLayout

public Layout getLayout(javax.faces.view.facelets.FaceletContext ctx,
               String layoutName,
               String mode,
               String valueName,
               List<String> selectedRows,
               boolean selectAllRowsByDefault)

Description copied from interface: WebLayoutManager

Returns the computed layout for this name, mode and list of selected rows in given context, or null if no layout with this name is found.

Specified by:

getLayout in interface WebLayoutManager

layoutName - the layout definition name.

Returns:

a layout computed in this context.

See Also:

LayoutManager.getLayoutDefinition(String), WebLayoutManager.getLayout(FaceletContext, LayoutDefinition, String, String, List, boolean)

getLayout

public Layout getLayout(javax.faces.view.facelets.FaceletContext ctx,
               String layoutName,
               String layoutCategory,
               String mode,
               String valueName,
               List<String> selectedRows,
               boolean selectAllRowsByDefault)

Description copied from interface: WebLayoutManager

Returns the computed layout for this name, category, mode and list of selected rows in given context, or null if no layout with this name is found.

Specified by:

getLayout in interface WebLayoutManager

layoutName - the layout definition name.

Returns:

a layout computed in this context.

See Also:

LayoutManager.getLayoutDefinition(String), WebLayoutManager.getLayout(FaceletContext, LayoutDefinition, String, String, List, boolean)

getLayout

public Layout getLayout(javax.faces.view.facelets.FaceletContext ctx,
               LayoutDefinition layoutDef,
               String mode,
               String valueName,
               List<String> selectedRows,
               boolean selectAllRowsByDefault)

Description copied from interface: WebLayoutManager

Returns the computed layout for this definition, mode and list of selected rows in given context, or null if the layout definition is null.

When a widget is configured not to be rendered in this mode, the layout will hold a null value instead. As well, when a row does not hold any non-null widget in this mode, the layout will not hold it.

If parameter selectedRows is not null, layout rows will be filtered according to this value. If selectedRows is null and parameter selectAllRowsByDefault is true, all rows will be taken into account, even rows marked as not selected by default.

Specified by:

getLayout in interface WebLayoutManager

Parameters:

ctx - the facelet context this layout will be computed in. If context is null, no expressions can be resolved during computing.

layoutDef - the layout definition instance.

mode - the mode.

valueName - the value name to use when computing tag attributes (useful for fields mapping)

selectedRows - the list of selected rows names

selectAllRowsByDefault - boolean indicating if all rows should be considered selected by default in case parameter selectedRows resolves to null.

Returns:

a layout computed in this context, null if definition is null.

getFaceletHandler

public javax.faces.view.facelets.FaceletHandler getFaceletHandler(javax.faces.view.facelets.FaceletContext ctx,
                                                         javax.faces.view.facelets.TagConfig config,
                                                         Widget widget)

Description copied from interface: WebLayoutManager

Returns the facelet handler for given widget.

Specified by:

getFaceletHandler in interface WebLayoutManager

Parameters:

ctx - the facelet context.

config - the tag config, used to hook the handler in the jsf tree.

widget - the computed widget.

Returns:

a facelet handler.

getFaceletHandler

public javax.faces.view.facelets.FaceletHandler getFaceletHandler(javax.faces.view.facelets.FaceletContext ctx,
                                                         javax.faces.view.facelets.TagConfig config,
                                                         Widget widget,
                                                         javax.faces.view.facelets.FaceletHandler nextHandler)

Description copied from interface: WebLayoutManager

Returns the facelet handler for given widget.

Specified by:

getFaceletHandler in interface WebLayoutManager

Parameters:

ctx - the facelet context.

config - the tag config, used to hook the handler in the jsf tree.

widget - the computed widget.

nextHandler - the next handler in the execution chain

Returns:

a facelet handler.

createWidget

public Widget createWidget(javax.faces.view.facelets.FaceletContext ctx,
                  String type,
                  String mode,
                  String valueName,
                  Map<String,Serializable> properties,
                  Widget[] subWidgets)

Description copied from interface: WebLayoutManager

Returns a widget computed from given information.

Specified by:

createWidget in interface WebLayoutManager

Parameters:

ctx - the facelet context this layout will be computed in. If context is null, no expressions can be resolved during computing.

type - the widget type name.

mode - the mode.

valueName - the value name to use when computing tag attributes.

properties - optional properties to use when computing the widget.

subWidgets - optional sub widgets for this widget.

Returns:

a widget computed in this context.

See Also:

WebLayoutManager.createWidget(FaceletContext, String, String, String, List, String, String, Boolean, Map, Widget[])

createWidget

public Widget createWidget(javax.faces.view.facelets.FaceletContext ctx,
                  String type,
                  String mode,
                  String valueName,
                  List<FieldDefinition> fieldDefinitions,
                  String label,
                  String helpLabel,
                  Boolean translated,
                  Map<String,Serializable> properties,
                  Widget[] subWidgets)

Description copied from interface: WebLayoutManager

Returns a widget computed from given information.

Specified by:

createWidget in interface WebLayoutManager

Parameters:

ctx - the facelet context this layout will be computed in. If context is null, no expressions can be resolved during computing.

type - the widget type name.

mode - the mode.

valueName - the value name to use when computing tag attributes.

label - the widget label

helpLabel - the widget help label

translated - if true, the labels will be translated

properties - optional properties to use when computing the widget.

subWidgets - optional sub widgets for this widget.

Returns:

a widget computed in this context.

createWidget

public Widget createWidget(javax.faces.view.facelets.FaceletContext ctx,
                  WidgetDefinition wDef,
                  String mode,
                  String valueName,
                  Widget[] subWidgets)

Description copied from interface: WebLayoutManager

Returns a widget computed from given information.

Specified by:

createWidget in interface WebLayoutManager

Parameters:

ctx - the facelet context this layout will be computed in. If context is null, no expressions can be resolved during computing.

mode - the mode.

valueName - the value name to use when computing tag attributes.

subWidgets - optional sub widgets for this widget.

Returns:

a widget computed in this context.

referencePropertyAsExpression

public boolean referencePropertyAsExpression(String name,
                                    Serializable value,
                                    String widgetType,
                                    String widgetMode,
                                    String template)

Description copied from interface: WebLayoutManager

Returns true if property with given name and value should be referenced as a value expression.

Assumes the widget type is in category #JSF_CATEGORY for backward compatibility.

Specified by:

referencePropertyAsExpression in interface WebLayoutManager

See Also:

WebLayoutManager.referencePropertyAsExpression(String, Serializable, String, String, String)

referencePropertyAsExpression

public boolean referencePropertyAsExpression(String name,
                                    Serializable value,
                                    String widgetType,
                                    String widgetTypeCategory,
                                    String widgetMode,
                                    String template)

Description copied from interface: WebLayoutManager

Returns true if property with given name and value should be referenced as a value expression.

Referencing properties as value expressions makes it possible to resolve this value again when reloading components in ajax for instance, as literal values kept by JSF components are not evaluated again.

But some components wait for a literal value and do not evaluate value expressions, so their properties should not be referenced as value expressions. An extension point on the service makes it possible to declare these properties: by default other properties will be using references.

This method returns false if it finds a matching disabled property ref for given criteria. If any of the given parameters are null, this criterion is ignored, and this looks up any matching (and enabled) contribution.

Specified by:

referencePropertyAsExpression in interface WebLayoutManager

Parameters:

name - the property name

value - the property value

widgetType - the widget type if any

widgetTypeCategory - the widget type category if any

widgetMode - the widget mode if any

template - the widget template if any