com.itmill.toolkit.data
Interface Container.Ordered

All Superinterfaces:
Container
All Known Subinterfaces:
Container.Indexed, Container.Sortable
All Known Implementing Classes:
ContainerOrderedWrapper, HierarchicalContainer, IndexedContainer, QueryContainer, Table
Enclosing interface:
Container

public static interface Container.Ordered
extends Container

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


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.itmill.toolkit.data.Container
Container.Editor, Container.Filterable, Container.Hierarchical, Container.Indexed, Container.ItemSetChangeEvent, Container.ItemSetChangeListener, Container.ItemSetChangeNotifier, Container.Ordered, Container.PropertySetChangeEvent, Container.PropertySetChangeListener, Container.PropertySetChangeNotifier, Container.Sortable, Container.Viewer
 
Method Summary
 Object addItemAfter(Object previousItemId)
          Adds new item after the given item.
 Item addItemAfter(Object previousItemId, Object newItemId)
          Adds new item after the given item.
 Object firstItemId()
          Gets the ID of the first Item in the Container.
 boolean isFirstId(Object itemId)
          Tests if the Item corresponding to the given Item ID is the first Item in the Container.
 boolean isLastId(Object itemId)
          Tests if the Item corresponding to the given Item ID is the last Item in the Container.
 Object lastItemId()
          Gets the ID of the last Item in the Container..
 Object nextItemId(Object itemId)
          Gets the ID of the Item following the Item that corresponds to itemId.
 Object prevItemId(Object itemId)
          Gets the ID of the Item preceding the Item that corresponds to itemId.
 
Methods inherited from interface com.itmill.toolkit.data.Container
addContainerProperty, addItem, addItem, containsId, getContainerProperty, getContainerPropertyIds, getItem, getItemIds, getType, removeAllItems, removeContainerProperty, removeItem, size
 

Method Detail

nextItemId

Object nextItemId(Object itemId)
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.

Parameters:
itemId - ID of an Item in the Container
Returns:
ID of the next Item or null

prevItemId

Object prevItemId(Object itemId)
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.

Parameters:
itemId - ID of an Item in the Container
Returns:
ID of the previous Item or null

firstItemId

Object firstItemId()
Gets the ID of the first Item in the Container.

Returns:
ID of the first Item in the Container

lastItemId

Object lastItemId()
Gets the ID of the last Item in the Container..

Returns:
ID of the last Item in the Container

isFirstId

boolean isFirstId(Object itemId)
Tests if the Item corresponding to the given Item ID is the first Item in the Container.

Parameters:
itemId - ID of an Item in the Container
Returns:
true if the Item is first in the Container, false if not

isLastId

boolean isLastId(Object itemId)
Tests if the Item corresponding to the given Item ID is the last Item in the Container.

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

addItemAfter

Object addItemAfter(Object previousItemId)
                    throws UnsupportedOperationException
Adds new item after the given item.

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

Parameters:
previousItemId - Id of the previous item in ordered container.
Returns:
Returns item id the the created new item or null if the operation fails.
Throws:
UnsupportedOperationException

addItemAfter

Item addItemAfter(Object previousItemId,
                  Object newItemId)
                  throws UnsupportedOperationException
Adds new item after the given item.

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

Parameters:
previousItemId - Id of the previous item in ordered container.
newItemId - Id of the new item to be added.
Returns:
Returns new item or null if the operation fails.
Throws:
UnsupportedOperationException


Copyright © 2000-2009 IT Mill Ltd. All Rights Reserved.