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

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

LayoutColumnDescriptor, LayoutRowDefinitionImpl, LayoutRowDescriptor

public interface LayoutRowDefinition
extends java.io.Serializable

Layout row definition interface.

Author:

Anahide Tchertchian

Method Summary

java.lang.String	getName() Returns the row name
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.Serializable>>	getProperties() Returns properties by mode.
java.util.Map<java.lang.String,java.io.Serializable>	getProperties(java.lang.String layoutMode) Returns a map of properties to use in a given mode.
int	getSize() Returns the row size
java.lang.String[]	getWidgets() Returns the list of widget names 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 Detail

getName

java.lang.String getName()

Returns the row name

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

getWidgets

java.lang.String[] getWidgets()

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

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

getProperties

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

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

getProperties

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

Returns properties by mode.