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

Interface LayoutRow

All Superinterfaces:

Serializable

All Known Implementing Classes:

LayoutRowImpl

public interface LayoutRow
extends Serializable

Layout row interface.

A layout row is a list Widget instances, built from a LayoutRowDefinition in a given mode. It gives information about the widgets presentation.

Author:

Anahide Tchertchian

Method Summary

Modifier and Type	Method and Description
String	getName()
Map<String,Serializable>	getProperties() Get properties to use in this mode.
Serializable	getProperty(String name) Returns property with given name in this mode.
int	getSize()
String	getTagConfigId() Returns the unique identifier of this widget to be used in tag configuration.
Widget[]	getWidgets()
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

String getName()

getTagConfigId

String getTagConfigId()

Returns the unique identifier of this widget to be used in tag configuration.

Since:

5.4.2

See Also:

Layout#getTagConfigId()}.

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

getWidgets

Widget[] getWidgets()

getSize

int getSize()

getProperties

Map<String,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

Serializable getProperty(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