org.nuxeo.ecm.platform.forms.layout.api.impl

Class LayoutDefinitionImpl

java.lang.Object

org.nuxeo.ecm.platform.forms.layout.api.impl.LayoutDefinitionImpl

All Implemented Interfaces:

Serializable, LayoutDefinition

public class LayoutDefinitionImpl
extends Object
implements LayoutDefinition

Default implementation for a layout definition.

Useful to compute layouts independently from the layout service.

Since:

5.4

Author:

Anahide Tchertchian

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LayoutDefinitionImpl(String name, Map<String,Map<String,Serializable>> properties, Map<String,String> templates, LayoutRowDefinition[] rows, Map<String,WidgetDefinition> widgets)
LayoutDefinitionImpl(String name, Map<String,Map<String,Serializable>> properties, Map<String,String> templates, List<LayoutRowDefinition> rows, List<WidgetDefinition> widgetDefinitions)
LayoutDefinitionImpl(String name, String template, WidgetDefinition widgetDefinition)

Method Summary

Methods

Modifier and Type	Method and Description
LayoutDefinition	clone() Returns a clone instance of this layout definition.
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
WidgetDefinition	getWidgetDefinition(String name) Returns the widget definition with given name.
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)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LayoutDefinitionImpl

public LayoutDefinitionImpl(String name,
                    String template,
                    WidgetDefinition widgetDefinition)

LayoutDefinitionImpl

public LayoutDefinitionImpl(String name,
                    Map<String,Map<String,Serializable>> properties,
                    Map<String,String> templates,
                    List<LayoutRowDefinition> rows,
                    List<WidgetDefinition> widgetDefinitions)

LayoutDefinitionImpl

public LayoutDefinitionImpl(String name,
                    Map<String,Map<String,Serializable>> properties,
                    Map<String,String> templates,
                    LayoutRowDefinition[] rows,
                    Map<String,WidgetDefinition> widgets)

Method Detail

getColumns

public int getColumns()

Description copied from interface: LayoutDefinition

Returns the maximum number of columns.

Specified by:

getColumns in interface LayoutDefinition

getName

public String getName()

Description copied from interface: LayoutDefinition

Returns the layout name used to identify it within the layout service.

Specified by:

getName in interface LayoutDefinition

setName

public void setName(String name)

Specified by:

setName in interface LayoutDefinition

getProperties

public Map<String,Serializable> getProperties(String layoutMode)

Description copied from interface: LayoutDefinition

Returns a map of properties to use in a given mode.

Specified by:

getProperties in interface LayoutDefinition

getProperties

public Map<String,Map<String,Serializable>> getProperties()

Description copied from interface: LayoutDefinition

Returns a map of properties by mode.

Specified by:

getProperties in interface LayoutDefinition

setProperties

public void setProperties(Map<String,Map<String,Serializable>> properties)

Specified by:

setProperties in interface LayoutDefinition

getRows

public LayoutRowDefinition[] getRows()

Description copied from interface: LayoutDefinition

Returns the list of widget names to use at a given row.

For instance, this could describe a layout like: [['title'], ['description'], ['creationDate', '', 'modificationDate'], ['subject']].

Specified by:

getRows in interface LayoutDefinition

setRows

public void setRows(LayoutRowDefinition[] rows)

Specified by:

setRows in interface LayoutDefinition

getTemplate

public String getTemplate(String mode)

Description copied from interface: LayoutDefinition

Returns template to use in a given mode.

Specified by:

getTemplate in interface LayoutDefinition

getTemplates

public Map<String,String> getTemplates()

Description copied from interface: LayoutDefinition

Returns templates by mode

Specified by:

getTemplates in interface LayoutDefinition

setTemplates

public void setTemplates(Map<String,String> templates)

Specified by:

setTemplates in interface LayoutDefinition

getWidgetDefinition

public WidgetDefinition getWidgetDefinition(String name)

Description copied from interface: LayoutDefinition

Returns the widget definition with given name.

Returns null if a widget with this name is not found within the layout.

Specified by:

getWidgetDefinition in interface LayoutDefinition

getRenderingInfos

public Map<String,List<RenderingInfo>> getRenderingInfos()

Description copied from interface: LayoutDefinition

Returns the map of rendering information per mode.

Useful for preview management where some configuration needs to be changed: what's changed can be set as rendering information here to be displayed.

Specified by:

getRenderingInfos in interface LayoutDefinition

setRenderingInfos

public void setRenderingInfos(Map<String,List<RenderingInfo>> renderingInfos)

Specified by:

setRenderingInfos in interface LayoutDefinition

getRenderingInfos

public List<RenderingInfo> getRenderingInfos(String mode)

Description copied from interface: LayoutDefinition

Returns the list of rendering information for given mode.

Specified by:

getRenderingInfos in interface LayoutDefinition

clone

public LayoutDefinition clone()

Description copied from interface: LayoutDefinition

Returns a clone instance of this layout definition.

Useful for conversion of layout definition during export.

Specified by:

clone in interface LayoutDefinition

Overrides:

clone in class Object

isEmpty

public boolean isEmpty()

Description copied from interface: LayoutDefinition

Returns true if all widget references in this layout are empty

Specified by:

isEmpty in interface LayoutDefinition