public interface LayoutDefinition extends Serializable
Modifier and Type | Method and Description |
---|---|
LayoutDefinition |
clone()
Returns a clone instance of this layout definition.
|
List<String> |
getAliases()
Return alias names for this layout definition (useful for compatibility on old layout names).
|
int |
getColumns()
Returns the maximum number of columns.
|
String |
getName()
Returns the layout name used to identify it within the layout service.
|
Map<String,Map<String,Serializable>> |
getProperties()
Returns a map of properties by mode.
|
Map<String,Serializable> |
getProperties(String layoutMode)
Returns a map of properties to use in a given mode.
|
Map<String,List<RenderingInfo>> |
getRenderingInfos()
Returns the map of rendering information per mode.
|
List<RenderingInfo> |
getRenderingInfos(String mode)
Returns the list of rendering information for given mode.
|
LayoutRowDefinition[] |
getRows()
Returns the list of widget names to use at a given row.
|
String |
getTemplate(String mode)
Returns template to use in a given mode.
|
Map<String,String> |
getTemplates()
Returns templates by mode
|
String |
getType()
Return the layout type, or null if not defined.
|
String |
getTypeCategory() |
WidgetDefinition |
getWidgetDefinition(String name)
Returns the widget definition with given name.
|
boolean |
isDynamic() |
boolean |
isEmpty()
Returns true if all widget references in this layout are empty
|
void |
setName(String name) |
void |
setProperties(Map<String,Map<String,Serializable>> properties) |
void |
setRenderingInfos(Map<String,List<RenderingInfo>> renderingInfos) |
void |
setRows(LayoutRowDefinition[] rows) |
void |
setTemplates(Map<String,String> templates) |
String getType()
Since 6.0, the layout type can hold templates and properties configuration, so that layout does not need to define them again.
String getTypeCategory()
String getTemplate(String mode)
Map<String,String> getTemplates()
void setTemplates(Map<String,String> templates)
WidgetDefinition getWidgetDefinition(String name)
Returns null if a widget with this name is not found within the layout.
LayoutRowDefinition[] getRows()
For instance, this could describe a layout like: [['title'], ['description'], ['creationDate', '', 'modificationDate'], ['subject']].
void setRows(LayoutRowDefinition[] rows)
int getColumns()
Map<String,Serializable> getProperties(String layoutMode)
Map<String,Map<String,Serializable>> getProperties()
void setProperties(Map<String,Map<String,Serializable>> properties)
Map<String,List<RenderingInfo>> getRenderingInfos()
Useful for preview management where some configuration needs to be changed: what's changed can be set as rendering information here to be displayed.
List<RenderingInfo> getRenderingInfos(String mode)
void setRenderingInfos(Map<String,List<RenderingInfo>> renderingInfos)
List<String> getAliases()
boolean isEmpty()
boolean isDynamic()
LayoutDefinition clone()
Useful for conversion of layout definition during export.
Copyright © 2015 Nuxeo SA. All rights reserved.