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

java.lang.Object
  org.nuxeo.runtime.model.DefaultComponent
      org.nuxeo.ecm.platform.forms.layout.service.WebLayoutManagerImpl

All Implemented Interfaces:

Serializable, LayoutManager, WebLayoutManager, Adaptable, Component, Extensible

public class WebLayoutManagerImpl
extends DefaultComponent
implements WebLayoutManager

Layout service implementation.

Author:

Anahide Tchertchian

See Also:

Serialized Form

Field Summary

static String	LAYOUTS_EP_NAME
static ComponentName	NAME
static String	WIDGET_TYPES_EP_NAME

Constructor Summary

WebLayoutManagerImpl()

Method Summary

Widget	createWidget(com.sun.facelets.FaceletContext ctx, String type, String mode, String valueName, Map<String,Serializable> properties, Widget[] subWidgets) Returns a widget computed from given information.
<T> T	getAdapter(Class<T> adapter) Returns an object which is an instance of the given class associated with this object.
com.sun.facelets.FaceletHandler	getFaceletHandler(com.sun.facelets.FaceletContext ctx, com.sun.facelets.tag.TagConfig config, Widget widget) Returns the facelet handler for given widget.
Layout	getLayout(com.sun.facelets.FaceletContext ctx, String layoutName, String mode, String valueName) Returns the computed layout for this name and mode in given context.
LayoutDefinition	getLayoutDefinition(String layoutName) Returns the registered layout definition for this name.
WidgetType	getWidgetType(String typeName) Returns the registered widget type for this type name.
WidgetTypeHandler	getWidgetTypeHandler(String typeName) Returns the widget type handler for the registered widget type with this type name.
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)

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

activate, deactivate, registerExtension, unregisterExtension

Methods inherited from class java.lang.Object

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

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

LAYOUTS_EP_NAME

public static final String LAYOUTS_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

getAdapter

public <T> T getAdapter(Class<T> adapter)

Description copied from interface: Adaptable

Returns an object which is an instance of the given class associated with this object. Returns null if no such object can be found.

Specified by:

getAdapter in interface Adaptable

Overrides:

getAdapter in class DefaultComponent

Parameters:

adapter - the adapter class to look up

Returns:

a object castable to the given class, or null if this object does not have an adapter for the given class

getWidgetType

public WidgetType getWidgetType(String typeName)

Description copied from interface: LayoutManager

Returns the registered widget type for this type name.

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

Specified by:

getWidgetType in interface LayoutManager

getLayoutDefinition

public LayoutDefinition getLayoutDefinition(String layoutName)

Description copied from interface: LayoutManager

Returns the registered layout definition for this name.

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

Specified by:

getLayoutDefinition in interface LayoutManager

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

getLayout

public Layout getLayout(com.sun.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.

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

getFaceletHandler

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

createWidget

public Widget createWidget(com.sun.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.