Interface Container.Ordered

Interface for Container classes whose Items can be traversed in order.

Synopsis

Inheritance Path.  com.itmill.toolkit.data.Container.Ordered

addItemAfter(Object)

Parameters

previousItemId

Id of the previous item in ordered container.

return

Returns item id the the created new item or null if the operation fails.

Add new item after the given item.

Adding an item after null item adds the item as first item of the ordered container.

addItemAfter(Object, Object)

Parameters

previousItemId

Id of the previous item in ordered container.

newItemId

Id of the new item to be added.

return

Returns new item or null if the operation fails.

Add new item after the given item.

Adding an item after null item adds the item as first item of the ordered container.

firstItemId()

Parameters

return

ID of the first Item in the Container

Gets the ID of the first Item in the Container.

isFirstId(Object)

Parameters

itemId

ID of an Item in the Container

return

true if the Item is first in the Container, false if not

Tests if the Item corresponding to the given Item ID is the first Item in the Container.

isLastId(Object)

Parameters

return

true if the Item is last in the Container, false if not

Tests if the Item corresponding to the given Item ID is the last Item in the Container.

lastItemId()

Parameters

return

ID of the last Item in the Container

Gets the ID of the last Item in the Container..

nextItemId(Object)

Parameters

itemId

ID of an Item in the Container

return

ID of the next Item or null

Gets the ID of the Item following the Item that corresponds to itemId . If the given Item is the last or not found in the Container, null is returned.

prevItemId(Object)

Parameters

itemId

ID of an Item in the Container

return

ID of the previous Item or null

Gets the ID of the Item preceding the Item that corresponds to itemId . If the given Item is the first or not found in the Container, null is returned.