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

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

LayoutImpl

public interface Layout
extends java.io.Serializable

Layout interface.

A layout is a group of Widget instances, built from a LayoutDefinition in a given mode.

Author:

Anahide Tchertchian

Method Summary

int	getColumns() Returns the maximum number of columns.
java.lang.String	getId() Returns the layout id, unique within the facelet context.
java.lang.String	getMode() Returns the layout mode.
java.lang.String	getName() Returns the layout name used to identify it within the layout service.
java.util.Map<java.lang.String,java.io.Serializable>	getProperties() Get properties to use in this mode.
java.io.Serializable	getProperty(java.lang.String name) Returns property with given name in this mode.
LayoutRow[]	getRows() Returns the table of widgets.
java.lang.String	getTemplate() Returns the template used to render widgets.
Widget	getWidget(java.lang.String name) Returns widget with given name.
java.util.Map<java.lang.String,Widget>	getWidgetMap() Returns a widget map, with widget name as key.
void	setId(java.lang.String id) Sets the layout id, unique within the facelet context.
void	setProperty(java.lang.String name, java.io.Serializable value) Sets property with given name on the layout.

Method Detail

getId

java.lang.String getId()

Returns the layout id, unique within the facelet context.

setId

void setId(java.lang.String id)

Sets the layout id, unique within the facelet context.

getName

java.lang.String getName()

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

getMode

java.lang.String getMode()

Returns the layout mode.

getTemplate

java.lang.String getTemplate()

Returns the template used to render widgets.

getRows

LayoutRow[] getRows()

Returns the table of widgets.

This list is computed from the LayoutDefinition rows.

Widgets that are not found are ignored.

getColumns

int getColumns()

Returns the maximum number of columns.

getWidget

Widget getWidget(java.lang.String name)

Returns widget with given name.

Only widgets of the first level are retrieved.

Since:

5.2M4

getWidgetMap

java.util.Map<java.lang.String,Widget> getWidgetMap()

Returns a widget map, with widget name as key.

Only widgets of the first level are retrieved.

Since:

5.2M4

getProperties

java.util.Map<java.lang.String,java.io.Serializable> getProperties()

Get properties to use in this mode.

The way that properties will be mapped to rendered components is managed by the widget type.

Since:

5.3.1

getProperty

java.io.Serializable getProperty(java.lang.String name)

Returns property with given name in this mode.

Parameters:

name - the property name.

Returns:

the property value or null if not found.

Since:

5.3.1

setProperty

void setProperty(java.lang.String name,
                 java.io.Serializable value)

Sets property with given name on the layout. If there is already a property with this name on the layout, it will be overridden.

Parameters:

name - the property name.

value - the property value or null if not found.

Since:

5.3.2