org.nuxeo.ecm.platform.forms.layout.api.impl
Class LayoutRowDefinitionImpl

java.lang.Object
  org.nuxeo.ecm.platform.forms.layout.api.impl.LayoutRowDefinitionImpl

All Implemented Interfaces:

java.io.Serializable, LayoutRowDefinition

public class LayoutRowDefinitionImpl
extends java.lang.Object
implements LayoutRowDefinition

Default implementation for a layout row definition.

Useful to compute rows independently from the layout service.

Since:

5.4

Author:

Anahide Tchertchian

See Also:

Serialized Form

Constructor Summary

LayoutRowDefinitionImpl(java.lang.String name, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.Serializable>> properties, java.util.List<java.lang.String> widgets, boolean alwaysSelected, boolean selectedByDefault)

LayoutRowDefinitionImpl(java.lang.String name, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.Serializable>> properties, java.lang.String[] widgets, boolean alwaysSelected, boolean selectedByDefault)

LayoutRowDefinitionImpl(java.lang.String name, java.lang.String widget)

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LayoutRowDefinitionImpl

public LayoutRowDefinitionImpl(java.lang.String name,
                               java.lang.String widget)

LayoutRowDefinitionImpl

public LayoutRowDefinitionImpl(java.lang.String name,
                               java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.Serializable>> properties,
                               java.util.List<java.lang.String> widgets,
                               boolean alwaysSelected,
                               boolean selectedByDefault)

LayoutRowDefinitionImpl

public LayoutRowDefinitionImpl(java.lang.String name,
                               java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.Serializable>> properties,
                               java.lang.String[] widgets,
                               boolean alwaysSelected,
                               boolean selectedByDefault)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: LayoutRowDefinition

Returns the row name

Specified by:

getName in interface LayoutRowDefinition

getProperties

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

Description copied from interface: LayoutRowDefinition

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

Specified by:

getProperties in interface LayoutRowDefinition

getProperties

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

Description copied from interface: LayoutRowDefinition

Returns properties by mode.

Specified by:

getProperties in interface LayoutRowDefinition

getSize

public int getSize()

Description copied from interface: LayoutRowDefinition

Returns the row size

Specified by:

getSize in interface LayoutRowDefinition

getWidgets

public java.lang.String[] getWidgets()

Description copied from interface: LayoutRowDefinition

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

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

Specified by:

getWidgets in interface LayoutRowDefinition

isAlwaysSelected

public boolean isAlwaysSelected()

Description copied from interface: LayoutRowDefinition

Return true if this row should be considered always selected

Specified by:

isAlwaysSelected in interface LayoutRowDefinition

isSelectedByDefault

public boolean isSelectedByDefault()

Description copied from interface: LayoutRowDefinition

Returns true if this row should be considered selected by default

Specified by:

isSelectedByDefault in interface LayoutRowDefinition