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

Class AbstractLayoutManager

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

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

All Implemented Interfaces:

Serializable, LayoutManager, Adaptable, Component, Extensible, TimestampedService

Direct Known Subclasses:

WebLayoutManagerImpl

public abstract class AbstractLayoutManager
extends DefaultComponent
implements LayoutManager

Since:

5.5

Author:

Anahide Tchertchian

See Also:

Serialized Form

Field Summary

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

lastModified

Constructor Summary

Constructors

Constructor and Description
AbstractLayoutManager()

Method Summary

Modifier and Type	Method and Description
abstract String	getDefaultStoreCategory() Return the default category used for storage
LayoutDefinition	getLayoutDefinition(String layoutName) Returns the registered layout definition for this name.
List<String>	getLayoutDefinitionNames() Returns the names of all the registered layout definitions
protected LayoutStore	getLayoutStore()
LayoutTypeDefinition	getLayoutTypeDefinition(String typeName) Returns the layout type definition with given name, or null if no layout type with this name is found.
List<LayoutTypeDefinition>	getLayoutTypeDefinitions() Returns the layout type definitions for all the registered layout types.
protected String	getStoreCategory(String cat)
WidgetDefinition	getWidgetDefinition(String widgetName) Returns the registered widget definition for this name.
WidgetType	getWidgetType(String typeName) Returns the registered widget type for this type name.
WidgetTypeDefinition	getWidgetTypeDefinition(String typeName) Returns the widget type definition with given name, or null if no widget type with this name is found.
List<WidgetTypeDefinition>	getWidgetTypeDefinitions() Returns the widget type definitions for all the registered widget types.
protected WidgetDefinition	lookupWidget(LayoutDefinition layoutDef, WidgetReference widgetRef)
protected WidgetDefinition	lookupWidget(WidgetReference widgetRef)
protected void	registerLayout(LayoutDefinition layoutDef)
protected void	registerLayoutType(LayoutTypeDefinition desc)
protected void	registerWidget(WidgetDefinition widgetDef)
protected void	registerWidgetType(WidgetTypeDefinition desc)
protected void	unregisterLayout(LayoutDefinition layoutDef)
protected void	unregisterLayoutType(LayoutTypeDefinition desc)
protected void	unregisterWidget(WidgetDefinition widgetDef)
protected void	unregisterWidgetType(WidgetTypeDefinition desc)

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

activate, applicationStarted, deactivate, getAdapter, getApplicationStartedOrder, getLastModified, registerContribution, registerExtension, setLastModified, setModifiedNow, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractLayoutManager

public AbstractLayoutManager()

Method Detail

getDefaultStoreCategory

public abstract String getDefaultStoreCategory()

Description copied from interface: LayoutManager

Return the default category used for storage

Specified by:

getDefaultStoreCategory in interface LayoutManager

getStoreCategory

protected String getStoreCategory(String cat)

getLayoutStore

protected LayoutStore getLayoutStore()

lookupWidget

protected WidgetDefinition lookupWidget(LayoutDefinition layoutDef,
                                        WidgetReference widgetRef)

lookupWidget

protected WidgetDefinition lookupWidget(WidgetReference widgetRef)

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

getWidgetTypeDefinition

public WidgetTypeDefinition getWidgetTypeDefinition(String typeName)

Description copied from interface: LayoutManager

Returns the widget type definition with given name, or null if no widget type with this name is found.

Specified by:

getWidgetTypeDefinition in interface LayoutManager

getWidgetTypeDefinitions

public List<WidgetTypeDefinition> getWidgetTypeDefinitions()

Description copied from interface: LayoutManager

Returns the widget type definitions for all the registered widget types.

Specified by:

getWidgetTypeDefinitions in interface LayoutManager

getLayoutTypeDefinition

public LayoutTypeDefinition getLayoutTypeDefinition(String typeName)

Description copied from interface: LayoutManager

Returns the layout type definition with given name, or null if no layout type with this name is found.

Specified by:

getLayoutTypeDefinition in interface LayoutManager

getLayoutTypeDefinitions

public List<LayoutTypeDefinition> getLayoutTypeDefinitions()

Description copied from interface: LayoutManager

Returns the layout type definitions for all the registered layout types.

Specified by:

getLayoutTypeDefinitions 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

getLayoutDefinitionNames

public List<String> getLayoutDefinitionNames()

Description copied from interface: LayoutManager

Returns the names of all the registered layout definitions

Specified by:

getLayoutDefinitionNames in interface LayoutManager

getWidgetDefinition

public WidgetDefinition getWidgetDefinition(String widgetName)

Description copied from interface: LayoutManager

Returns the registered widget definition for this name.

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

Specified by:

getWidgetDefinition in interface LayoutManager

registerWidgetType

protected void registerWidgetType(WidgetTypeDefinition desc)

unregisterWidgetType

protected void unregisterWidgetType(WidgetTypeDefinition desc)

registerLayoutType

protected void registerLayoutType(LayoutTypeDefinition desc)

unregisterLayoutType

protected void unregisterLayoutType(LayoutTypeDefinition desc)

registerLayout

protected void registerLayout(LayoutDefinition layoutDef)

unregisterLayout

protected void unregisterLayout(LayoutDefinition layoutDef)

registerWidget

protected void registerWidget(WidgetDefinition widgetDef)

unregisterWidget

protected void unregisterWidget(WidgetDefinition widgetDef)