We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.data.
Interface Container.Ordered
-
All Superinterfaces:
All Known Subinterfaces:
All Known Implementing Classes:
AbstractBeanContainer, AbstractInMemoryContainer, BeanContainer, BeanItemContainer, ContainerOrderedWrapper, GeneratedPropertyContainer, HierarchicalContainer, HierarchicalContainerOrderedWrapper, IndexedContainer, SQLContainer, Table, TreeTable
Enclosing interface:
public static interface Container.Ordered extends ContainerInterface for Container classes whose
Items can be traversed in order.If the container is filtered or sorted, the traversal applies to the filtered and sorted view.
The
addItemAfter()methods should apply filters to the added item after inserting it, possibly hiding it immediately. If the container is being sorted, they may add items at the correct sorted position instead of the given position. See alsoContainer.FilterableandContainer.Sortablefor more information.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.vaadin.data.Container
Container.Editor, Container.Filter, Container.Filterable, Container.Hierarchical, Container.Indexed, Container.ItemSetChangeEvent, Container.ItemSetChangeListener, Container.ItemSetChangeNotifier, Container.Ordered, Container.PropertySetChangeEvent, Container.PropertySetChangeListener, Container.PropertySetChangeNotifier, Container.SimpleFilterable, Container.Sortable, Container.Viewer
-
-
Method Summary
All Methods Modifier and Type Method and Description ObjectaddItemAfter(Object previousItemId)Adds a new item after the given item.
ItemaddItemAfter(Object previousItemId, Object newItemId)Adds a new item after the given item.
ObjectfirstItemId()Gets the ID of the first Item in the Container.
booleanisFirstId(Object itemId)Tests if the Item corresponding to the given Item ID is the first Item in the Container.
booleanisLastId(Object itemId)Tests if the Item corresponding to the given Item ID is the last Item in the Container.
ObjectlastItemId()Gets the ID of the last Item in the Container..
ObjectnextItemId(Object itemId)Gets the ID of the Item following the Item that corresponds to
itemId.ObjectprevItemId(Object itemId)Gets the ID of the Item preceding the Item that corresponds to
itemId.-
Methods inherited from interface com.vaadin.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,nullis returned.Parameters:
itemId- ID of a visible Item in the ContainerReturns:
ID of the next visible 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,nullis returned.Parameters:
itemId- ID of a visible Item in the ContainerReturns:
ID of the previous visible Item or
null
-
firstItemId
Object firstItemId()Gets the ID of the first Item in the Container.
Returns:
ID of the first visible Item in the Container
-
lastItemId
Object lastItemId()Gets the ID of the last Item in the Container..
Returns:
ID of the last visible 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 ContainerReturns:
trueif the Item is first visible item in the Container,falseif not
-
isLastId
boolean isLastId(Object itemId)Tests if the Item corresponding to the given Item ID is the last Item in the Container.
Returns:
trueif the Item is last visible item in the Container,falseif not
-
addItemAfter
Object addItemAfter(Object previousItemId) throws UnsupportedOperationExceptionAdds a 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 visible item in ordered container after which to insert the new item.Returns:
item id the the created new item or null if the operation fails.
Throws:
UnsupportedOperationException- if the operation is not supported by the containerSee Also:
-
addItemAfter
Item addItemAfter(Object previousItemId, Object newItemId) throws UnsupportedOperationExceptionAdds a 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 visible item in ordered container after which to insert the new item.newItemId- Id of the new item to be added.Returns:
new item or null if the operation fails.
Throws:
UnsupportedOperationException- if the operation is not supported by the containerSee Also:
-
-