org.nuxeo.ecm.platform.forms.layout.api.service
Interface LayoutManager

All Superinterfaces:

Serializable

All Known Subinterfaces:

LayoutManagerLocal, LayoutManagerRemote, WebLayoutManager

All Known Implementing Classes:

LayoutManagerImpl, WebLayoutManagerImpl

public interface LayoutManager
extends Serializable

Layout manager interface.

It manages registries of layout definitions and widget types.

Author:

Anahide Tchertchian

Method Summary

LayoutDefinition	getLayoutDefinition(String layoutName) Returns the registered layout definition for this name.
List<String>	getLayoutDefinitionNames() Returns the names of all the registered layout definitions
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.
void	registerLayout(LayoutDefinition layoutDef)
void	registerWidget(WidgetDefinition widgetDef)
void	registerWidgetType(WidgetTypeDefinition desc)
void	unregisterLayout(LayoutDefinition layoutDef)
void	unregisterWidget(WidgetDefinition widgetDef)
void	unregisterWidgetType(WidgetTypeDefinition desc)

Method Detail

getWidgetType

WidgetType getWidgetType(String typeName)

Returns the registered widget type for this type name.

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

getWidgetTypeDefinition

WidgetTypeDefinition getWidgetTypeDefinition(String typeName)

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

Since:

5.4

getWidgetTypeDefinitions

List<WidgetTypeDefinition> getWidgetTypeDefinitions()

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

Since:

5.4

getLayoutDefinition

LayoutDefinition getLayoutDefinition(String layoutName)

Returns the registered layout definition for this name.

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

getLayoutDefinitionNames

List<String> getLayoutDefinitionNames()

Returns the names of all the registered layout definitions

Since:

5.4.3

getWidgetDefinition

WidgetDefinition getWidgetDefinition(String widgetName)

Returns the registered widget definition for this name.

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

Since:

5.1.7, 5.2.0

registerWidgetType

void registerWidgetType(WidgetTypeDefinition desc)

unregisterWidgetType

void unregisterWidgetType(WidgetTypeDefinition desc)

registerLayout

void registerLayout(LayoutDefinition layoutDef)

unregisterLayout

void unregisterLayout(LayoutDefinition layoutDef)

registerWidget

void registerWidget(WidgetDefinition widgetDef)

unregisterWidget

void unregisterWidget(WidgetDefinition widgetDef)