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

Interface LayoutManager

All Superinterfaces:
Serializable
All Known Implementing Classes:
AbstractLayoutManager
public interface LayoutManager extends Serializable
Layout manager interface.

It manages access to layout definitions, widget definitions and widget types for a given category.

Author:
Anahide Tchertchian

  • Method Details

    • getDefaultStoreCategory

      String getDefaultStoreCategory()
      Return the default category used for storage
      Since:
      5.5

    • 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

    • getLayoutTypeDefinition

      LayoutTypeDefinition getLayoutTypeDefinition(String typeName)
      Returns the layout type definition with given name, or null if no layout type with this name is found.
      Since:
      6.0

    • getLayoutTypeDefinitions

      List<LayoutTypeDefinition> getLayoutTypeDefinitions()
      Returns the layout type definitions for all the registered layout types.
      Since:
      6.0

    • 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.5

    • 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