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

Class LayoutStoreImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

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

All Implemented Interfaces:

Serializable, LayoutStore, Adaptable, Component, Extensible, TimestampedService

public class LayoutStoreImpl
extends DefaultComponent
implements LayoutStore

Since:

5.5

Author:

Anahide Tchertchian

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	LAYOUT_CONVERTERS_EP_NAME
static String	LAYOUT_TYPES_EP_NAME
static String	LAYOUTS_EP_NAME
static String	WIDGET_CONVERTERS_EP_NAME
static String	WIDGET_TYPES_EP_NAME
static String	WIDGETS_EP_NAME

Constructor Summary

Constructors

Constructor and Description
LayoutStoreImpl()

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getCategories() Returns categories of layout and widgets definitions and instances held by this service.
List<LayoutDefinitionConverter>	getLayoutConverters(String category)
LayoutDefinition	getLayoutDefinition(String category, String layoutName) Returns the registered layout definition for this name.
List<String>	getLayoutDefinitionNames(String category) Returns the names of all the registered layout definitions
LayoutTypeDefinition	getLayoutTypeDefinition(String category, String typeName)
List<LayoutTypeDefinition>	getLayoutTypeDefinitions(String category)
List<WidgetDefinitionConverter>	getWidgetConverters(String category)
WidgetDefinition	getWidgetDefinition(String category, String widgetName) Returns the registered widget definition for this name.
WidgetType	getWidgetType(String category, String typeName) Returns the registered widget type for this type name.
WidgetTypeDefinition	getWidgetTypeDefinition(String category, String typeName) Returns the widget type definition with given name, or null if no widget type with this name is found.
List<WidgetTypeDefinition>	getWidgetTypeDefinitions(String category) Returns the widget type definitions for all the registered widget types.
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
void	registerLayout(String category, LayoutDefinition layoutDef)
void	registerLayoutConverter(String category, LayoutConverterDescriptor layoutConverter)
void	registerLayoutType(String category, LayoutTypeDefinition layoutTypeDef)
void	registerWidget(String category, WidgetDefinition widgetDef)
void	registerWidgetConverter(String category, WidgetConverterDescriptor widgetConverter)
void	registerWidgetType(String category, WidgetTypeDefinition desc)
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
void	unregisterLayout(String category, LayoutDefinition layoutDef)
void	unregisterLayoutConverter(String category, LayoutConverterDescriptor layoutConverter)
void	unregisterLayoutType(String category, LayoutTypeDefinition layoutTypeDef)
void	unregisterWidget(String category, WidgetDefinition widgetDef)
void	unregisterWidgetConverter(String category, WidgetConverterDescriptor widgetConverter)
void	unregisterWidgetType(String category, WidgetTypeDefinition desc)

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

Field Detail

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

LAYOUT_CONVERTERS_EP_NAME

public static final String LAYOUT_CONVERTERS_EP_NAME

See Also:

Constant Field Values

WIDGET_CONVERTERS_EP_NAME

public static final String WIDGET_CONVERTERS_EP_NAME

See Also:

Constant Field Values

Constructor Detail

LayoutStoreImpl

public LayoutStoreImpl()

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

getCategories

public List<String> getCategories()

Description copied from interface: LayoutStore

Returns categories of layout and widgets definitions and instances held by this service.

Specified by:

getCategories in interface LayoutStore

registerWidgetType

public void registerWidgetType(String category,
                      WidgetTypeDefinition desc)

Specified by:

registerWidgetType in interface LayoutStore

unregisterWidgetType

public void unregisterWidgetType(String category,
                        WidgetTypeDefinition desc)

Specified by:

unregisterWidgetType in interface LayoutStore

registerLayoutType

public void registerLayoutType(String category,
                      LayoutTypeDefinition layoutTypeDef)

Specified by:

registerLayoutType in interface LayoutStore

unregisterLayoutType

public void unregisterLayoutType(String category,
                        LayoutTypeDefinition layoutTypeDef)

Specified by:

unregisterLayoutType in interface LayoutStore

registerLayout

public void registerLayout(String category,
                  LayoutDefinition layoutDef)

Specified by:

registerLayout in interface LayoutStore

unregisterLayout

public void unregisterLayout(String category,
                    LayoutDefinition layoutDef)

Specified by:

unregisterLayout in interface LayoutStore

registerWidget

public void registerWidget(String category,
                  WidgetDefinition widgetDef)

Specified by:

registerWidget in interface LayoutStore

unregisterWidget

public void unregisterWidget(String category,
                    WidgetDefinition widgetDef)

Specified by:

unregisterWidget in interface LayoutStore

registerLayoutConverter

public void registerLayoutConverter(String category,
                           LayoutConverterDescriptor layoutConverter)

unregisterLayoutConverter

public void unregisterLayoutConverter(String category,
                             LayoutConverterDescriptor layoutConverter)

registerWidgetConverter

public void registerWidgetConverter(String category,
                           WidgetConverterDescriptor widgetConverter)

unregisterWidgetConverter

public void unregisterWidgetConverter(String category,
                             WidgetConverterDescriptor widgetConverter)

getWidgetType

public WidgetType getWidgetType(String category,
                       String typeName)

Description copied from interface: LayoutStore

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 LayoutStore

getWidgetTypeDefinition

public WidgetTypeDefinition getWidgetTypeDefinition(String category,
                                           String typeName)

Description copied from interface: LayoutStore

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

Specified by:

getWidgetTypeDefinition in interface LayoutStore

getWidgetTypeDefinitions

public List<WidgetTypeDefinition> getWidgetTypeDefinitions(String category)

Description copied from interface: LayoutStore

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

Specified by:

getWidgetTypeDefinitions in interface LayoutStore

getLayoutTypeDefinition

public LayoutTypeDefinition getLayoutTypeDefinition(String category,
                                           String typeName)

Specified by:

getLayoutTypeDefinition in interface LayoutStore

getLayoutTypeDefinitions

public List<LayoutTypeDefinition> getLayoutTypeDefinitions(String category)

Specified by:

getLayoutTypeDefinitions in interface LayoutStore

getLayoutDefinition

public LayoutDefinition getLayoutDefinition(String category,
                                   String layoutName)

Description copied from interface: LayoutStore

Returns the registered layout definition for this name.

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

Specified by:

getLayoutDefinition in interface LayoutStore

getLayoutDefinitionNames

public List<String> getLayoutDefinitionNames(String category)

Description copied from interface: LayoutStore

Returns the names of all the registered layout definitions

Specified by:

getLayoutDefinitionNames in interface LayoutStore

getWidgetDefinition

public WidgetDefinition getWidgetDefinition(String category,
                                   String widgetName)

Description copied from interface: LayoutStore

Returns the registered widget definition for this name.

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

Specified by:

getWidgetDefinition in interface LayoutStore

getLayoutConverters

public List<LayoutDefinitionConverter> getLayoutConverters(String category)

Specified by:

getLayoutConverters in interface LayoutStore

getWidgetConverters

public List<WidgetDefinitionConverter> getWidgetConverters(String category)

Specified by:

getWidgetConverters in interface LayoutStore