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

Interface ItemContainer<ITEM,SELF extends ItemContainer<ITEM,SELF>>

Type Parameters:

ITEM - is the generic type of the contained item.

SELF - is the generic type of this container itself.

All Superinterfaces:

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

All Known Subinterfaces:

NodeContainer<NODE,SELF>

All Known Implementing Classes:

AbstractItemContainer, AbstractNodeContainer, ItemContainerGwt

public interface ItemContainer<ITEM,SELF extends ItemContainer<ITEM,SELF>>
extends AttributeWriteSelected, AttributeWriteSelectionMode, AttributeReadValue<ITEM>

This is the interface for a container for an <ITEM> of a data set widget. It can be implemented toolkit specific implementation that contains the raw widget to render the item.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
ITEM	getItem()
ITEM	getItemEdited()
ITEM	getItemOriginal()
ITEM	getValue() This method does the same as getItem().
boolean	isContainerForItem(ITEM row)
void	setItemEdited(ITEM row)
void	setItemOriginal(ITEM row)

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

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

getSelectionMode

Method Detail

getItemOriginal

ITEM getItemOriginal()

Returns:

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

See Also:

getItemEdited()

setItemOriginal

void setItemOriginal(ITEM row)

Parameters:

row - is the original row to set.

getItemEdited

ITEM getItemEdited()

Returns:

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

setItemEdited

void setItemEdited(ITEM row)

Parameters:

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

getItem

ITEM getItem()

Returns:

the edited row if not null else the original row.

getValue

ITEM getValue()

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

Specified by:

getValue in interface AttributeReadValue<ITEM>

Returns:

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

isContainerForItem

boolean isContainerForItem(ITEM row)

Parameters:

row - is the <ROW> to check.

Returns:

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