net.sf.mmm.client.ui.base.widget.complex

Class AbstractItemContainer<ITEM,SELF extends AbstractItemContainer<ITEM,SELF>>

java.lang.Object

net.sf.mmm.client.ui.base.widget.complex.AbstractItemContainer<ITEM,SELF>

Type Parameters:

ITEM - is the generic type of the contained row.

SELF - is the generic type of this container itself.

All Implemented Interfaces:

AttributeReadSelected, AttributeReadSelectionMode, AttributeWriteSelected, AttributeWriteSelectionMode, ItemContainer<ITEM,SELF>, AttributeReadValue<ITEM>

Direct Known Subclasses:

AbstractNodeContainer, ItemContainerGwt

public abstract class AbstractItemContainer<ITEM,SELF extends AbstractItemContainer<ITEM,SELF>>
extends Object
implements ItemContainer<ITEM,SELF>

This is the abstract base implementation of ItemContainer.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private ITEM	itemEdited
private ITEM	itemOriginal
private AbstractUiWidgetAbstractDataSet<?,?,ITEM,SELF>	uiWidget

Constructor Summary

Constructors

Constructor and Description
AbstractItemContainer(AbstractUiWidgetAbstractDataSet<?,?,ITEM,SELF> widget) The constructor.

Method Summary

Modifier and Type	Method and Description
ITEM	getItem()
ITEM	getItemEdited()
ITEM	getItemOriginal()
SelectionMode	getSelectionMode() This method gets the SelectionMode.
protected AbstractUiWidgetAbstractDataSet<?,?,ITEM,SELF>	getUiWidget()
ITEM	getValue() This method does the same as ItemContainer.getItem().
boolean	isContainerForItem(ITEM row)
void	setItemEdited(ITEM row)
void	setItemOriginal(ITEM row)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteSelected

setSelected

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadSelected

isSelected

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteSelectionMode

setSelectionMode

Field Detail

uiWidget

private final AbstractUiWidgetAbstractDataSet<?,?,ITEM,SELF extends AbstractItemContainer<ITEM,SELF>> uiWidget

See Also:

getUiWidget()

itemOriginal

private ITEM itemOriginal

See Also:

getItemOriginal()

itemEdited

private ITEM itemEdited

See Also:

getItemEdited()

Constructor Detail

AbstractItemContainer

public AbstractItemContainer(AbstractUiWidgetAbstractDataSet<?,?,ITEM,SELF> widget)

The constructor.

Parameters:

widget - is the widget creating and owning this AbstractItemContainer.

Method Detail

getUiWidget

protected AbstractUiWidgetAbstractDataSet<?,?,ITEM,SELF> getUiWidget()

Returns:

the AbstractUiWidgetAbstractDataSet that created this AbstractItemContainer.

getItemOriginal

public ITEM getItemOriginal()

Specified by:

getItemOriginal in interface ItemContainer<ITEM,SELF extends AbstractItemContainer<ITEM,SELF>>

Returns:

the original <ROW> value provided by the end-user for this row in a data-table.

See Also:

ItemContainer.getItemEdited()

setItemOriginal

public void setItemOriginal(ITEM row)

Specified by:

setItemOriginal in interface ItemContainer<ITEM,SELF extends AbstractItemContainer<ITEM,SELF>>

Parameters:

row - is the original row to set.

getItemEdited

public ITEM getItemEdited()

Specified by:

getItemEdited in interface ItemContainer<ITEM,SELF extends AbstractItemContainer<ITEM,SELF>>

Returns:

the copy of the original row that is lazily created on first editing. Will be null before the row has been edited.

setItemEdited

public void setItemEdited(ITEM row)

Specified by:

setItemEdited in interface ItemContainer<ITEM,SELF extends AbstractItemContainer<ITEM,SELF>>

Parameters:

row - is the edited row to set. Should to be a copy of the original row. May be null to reset.

getItem

public ITEM getItem()

Specified by:

getItem in interface ItemContainer<ITEM,SELF extends AbstractItemContainer<ITEM,SELF>>

Returns:

the edited row if not null else the original row.

getValue

public ITEM getValue()

This method does the same as ItemContainer.getItem(). This method gets the value of this object.

Specified by:

getValue in interface ItemContainer<ITEM,SELF extends AbstractItemContainer<ITEM,SELF>>

Specified by:

getValue in interface AttributeReadValue<ITEM>

Returns:

the value of this object. May be null unless otherwise stated.

isContainerForItem

public boolean isContainerForItem(ITEM row)

Specified by:

isContainerForItem in interface ItemContainer<ITEM,SELF extends AbstractItemContainer<ITEM,SELF>>

Parameters:

row - is the <ROW> to check.

Returns:

true if this is the ItemContainer responsible for the given row false otherwise.

getSelectionMode

public SelectionMode getSelectionMode()

This method gets the SelectionMode.

Specified by:

getSelectionMode in interface AttributeReadSelectionMode

Returns:

the SelectionMode. Must not be null.