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

Interface WebLayoutManager

All Superinterfaces:

LayoutManager, Serializable

All Known Implementing Classes:

WebLayoutManagerImpl

public interface WebLayoutManager
extends LayoutManager

Web Layout manager interface.

It manages registries of layout definitions and widget types and handles the creation of layouts and widgets instances.

Author:

Anahide Tchertchian

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSF_CATEGORY

Method Summary

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, WidgetDefinition widgetDef, String mode, String valueName, Widget[] subWidgets) Returns a widget computed from given information.
Layout	getLayout(javax.faces.view.facelets.FaceletContext ctx, LayoutConversionContext lctx, String conversionCat, LayoutDefinition layoutDef, String mode, String valueName, List<String> selectedRows, boolean selectAllRowsByDefault) Returns a layout with conversion.
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, LayoutConversionContext lctx, String conversionCat, WidgetDefinition widgetDef, String layoutMode, String valueName, String layoutName) Returns a widget with conversion.
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 widgetDef, 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(javax.faces.view.facelets.TagConfig config, String typeCategory, String typeName) Returns the widget type handler for the registered widget type with this type name and type category.
WidgetTypeHandler	getWidgetTypeHandler(javax.faces.view.facelets.TagConfig config, Widget widget) Returns the widget type handler for the registered widget.
boolean	referencePropertyAsExpression(String name, Serializable value, String widgetType, String widgetTypeCategory, String mode, String template) Returns true if property with given name and value should be referenced as a value expression.

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

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

Field Detail

JSF_CATEGORY

static final String JSF_CATEGORY

See Also:

Constant Field Values

Method Detail

getWidgetTypeHandler

WidgetTypeHandler getWidgetTypeHandler(javax.faces.view.facelets.TagConfig config,
                                       String typeCategory,
                                       String typeName)
                                throws WidgetException

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

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

Throws:

WidgetException

Since:

8.1

getWidgetTypeHandler

WidgetTypeHandler getWidgetTypeHandler(javax.faces.view.facelets.TagConfig config,
                                       Widget widget)
                                throws WidgetException

Returns the widget type handler for the registered widget.

If widget is null or its widget type is unknown, returns null.

Throws:

WidgetException

Since:

8.1

getLayout

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.

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.

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.

See Also:

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

getLayout

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.

Parameters:

layoutName - the layout definition name.

Returns:

a layout computed in this context.

Since:

5.4

See Also:

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

getLayout

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.

Parameters:

layoutName - the layout definition name.

Returns:

a layout computed in this context.

Since:

5.5

See Also:

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

getLayout

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.

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.

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.

Since:

5.4

getLayout

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

Returns a layout with conversion.

Since:

7.3

getWidget

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.

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

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 widget definition could not be resolved.

Since:

5.6

getWidget

Widget getWidget(javax.faces.view.facelets.FaceletContext ctx,
                 WidgetDefinition widgetDef,
                 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.

Parameters:

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

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

Since:

5.6

getWidget

Widget getWidget(javax.faces.view.facelets.FaceletContext ctx,
                 LayoutConversionContext lctx,
                 String conversionCat,
                 WidgetDefinition widgetDef,
                 String layoutMode,
                 String valueName,
                 String layoutName)

Returns a widget with conversion.

Since:

7.3

createWidget

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.

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.

fieldDefinitions - the field definitions

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.

Since:

5.4

createWidget

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

Returns a widget computed from given information.

Parameters:

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

widgetDef - the widget definition.

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.

Since:

5.7.3

referencePropertyAsExpression

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

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.

Parameters:

name - the property name

value - the property value

widgetType - the widget type if any

widgetTypeCategory - the widget type category if any

mode - the widget mode if any

template - the widget template if any

Since:

5.7.3