org.nuxeo.ecm.platform.forms.layout.api
Interface LayoutDefinition

All Superinterfaces:

Serializable

All Known Implementing Classes:

LayoutDefinitionImpl, LayoutDescriptor

public interface LayoutDefinition
extends Serializable

Layout definition interface.

Author:

Anahide Tchertchian

Method Summary

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

Method Detail

getName

String getName()

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

getTemplate

String getTemplate(String mode)

Returns template to use in a given mode.

getTemplates

Map<String,String> getTemplates()

Returns templates by mode

getWidgetDefinition

WidgetDefinition getWidgetDefinition(String name)

Returns the widget definition with given name.

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

getRows

LayoutRowDefinition[] getRows()

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']].

getColumns

int getColumns()

Returns the maximum number of columns.

getProperties

Map<String,Serializable> getProperties(String layoutMode)

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

getProperties

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

Returns a map of properties by mode.