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

Interface LayoutRowDefinition

All Superinterfaces:

Serializable

All Known Implementing Classes:

LayoutRowDefinitionImpl

public interface LayoutRowDefinition
extends Serializable

Layout row definition interface.

Author:

Anahide Tchertchian

Method Summary

Modifier and Type	Method	Description
LayoutRowDefinition	clone()	Returns a clone instance of this row definition.
String	getDefaultName(int index)	Returns the default name for this row, given an index.
String	getName()	Returns the row name
Map<String,Map<String,Serializable>>	getProperties()	Returns properties by mode.
Map<String,Serializable>	getProperties(String layoutMode)	Returns a map of properties to use in a given mode.
int	getSize()	Returns the row size
WidgetReference[]	getWidgetReferences()	Returns the list of widget references to use at a given row.
boolean	isAlwaysSelected()	Return true if this row should be considered always selected
boolean	isSelectedByDefault()	Returns true if this row should be considered selected by default

Method Details

getName

String getName()

Returns the row name

getDefaultName

String getDefaultName(int index)

Returns the default name for this row, given an index.

Since:

6.0

isSelectedByDefault

boolean isSelectedByDefault()

Returns true if this row should be considered selected by default

isAlwaysSelected

boolean isAlwaysSelected()

Return true if this row should be considered always selected

getSize

int getSize()

Returns the row size

getWidgetReferences

WidgetReference[] getWidgetReferences()

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

Since:

5.5

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 properties by mode.

clone

LayoutRowDefinition clone()

Returns a clone instance of this row definition.

Useful for conversion of layout definition during export.

Since:

5.5