Interface LayoutStore
-
- All Superinterfaces:
Serializable
- All Known Implementing Classes:
LayoutStoreImpl
public interface LayoutStore extends Serializable
Layout store interface.It manages registries of layout definitions, widget types, widget definitions and converters.
- Since:
- 5.5
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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 definitionsLayoutTypeDefinition
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
registerLayout(String category, LayoutDefinition layoutDef)
void
registerLayoutType(String category, LayoutTypeDefinition desc)
void
registerWidget(String category, WidgetDefinition widgetDef)
void
registerWidgetType(String category, WidgetTypeDefinition desc)
void
unregisterLayout(String category, LayoutDefinition layoutDef)
void
unregisterLayoutType(String category, LayoutTypeDefinition desc)
void
unregisterWidget(String category, WidgetDefinition widgetDef)
void
unregisterWidgetType(String category, WidgetTypeDefinition desc)
-
-
-
Method Detail
-
getCategories
List<String> getCategories()
Returns categories of layout and widgets definitions and instances held by this service.
-
getWidgetType
WidgetType getWidgetType(String category, 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 category, String typeName)
Returns the widget type definition with given name, or null if no widget type with this name is found.
-
getWidgetTypeDefinitions
List<WidgetTypeDefinition> getWidgetTypeDefinitions(String category)
Returns the widget type definitions for all the registered widget types.
-
getLayoutTypeDefinition
LayoutTypeDefinition getLayoutTypeDefinition(String category, String typeName)
- Since:
- 6.0
-
getLayoutTypeDefinitions
List<LayoutTypeDefinition> getLayoutTypeDefinitions(String category)
- Since:
- 6.0
-
getLayoutDefinition
LayoutDefinition getLayoutDefinition(String category, 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(String category)
Returns the names of all the registered layout definitions
-
getWidgetDefinition
WidgetDefinition getWidgetDefinition(String category, String widgetName)
Returns the registered widget definition for this name.If the no definition is found with this name, return null.
-
getLayoutConverters
List<LayoutDefinitionConverter> getLayoutConverters(String category)
-
getWidgetConverters
List<WidgetDefinitionConverter> getWidgetConverters(String category)
-
registerWidgetType
void registerWidgetType(String category, WidgetTypeDefinition desc)
-
unregisterWidgetType
void unregisterWidgetType(String category, WidgetTypeDefinition desc)
-
registerLayoutType
void registerLayoutType(String category, LayoutTypeDefinition desc)
- Since:
- 6.0
-
unregisterLayoutType
void unregisterLayoutType(String category, LayoutTypeDefinition desc)
- Since:
- 6.0
-
registerLayout
void registerLayout(String category, LayoutDefinition layoutDef)
-
unregisterLayout
void unregisterLayout(String category, LayoutDefinition layoutDef)
-
registerWidget
void registerWidget(String category, WidgetDefinition widgetDef)
-
unregisterWidget
void unregisterWidget(String category, WidgetDefinition widgetDef)
-
-