Package com.vaadin.v7.data.util

Class ContainerOrderedWrapper

    • Constructor Detail

      • ContainerOrderedWrapper

        public ContainerOrderedWrapper​(Container toBeWrapped)
        Deprecated.
        Constructs a new ordered wrapper for an existing Container. Works even if the to-be-wrapped container already implements the Container.Ordered interface.
        Parameters:
        toBeWrapped - the container whose contents need to be ordered.

    • Method Detail

      • updateOrderWrapper

        public void updateOrderWrapper()
        Deprecated.
        Updates the wrapper's internal ordering information to include all Items in the underlying container.

        Note : If the contents of the wrapped container change without the wrapper's knowledge, this method needs to be called to update the ordering information of the Items.

      • firstItemId

        public java.lang.Object firstItemId()
        Deprecated.
        Description copied from interface: Container.Ordered
        Gets the ID of the first Item in the Container.
        Specified by:
        firstItemId in interface Container.Ordered
        Returns:
        ID of the first visible Item in the Container

      • isFirstId

        public boolean isFirstId​(java.lang.Object itemId)
        Deprecated.
        Description copied from interface: Container.Ordered
        Tests if the Item corresponding to the given Item ID is the first Item in the Container.
        Specified by:
        isFirstId in interface Container.Ordered
        Parameters:
        itemId - ID of an Item in the Container
        Returns:
        true if the Item is first visible item in the Container, false if not

      • isLastId

        public boolean isLastId​(java.lang.Object itemId)
        Deprecated.
        Description copied from interface: Container.Ordered
        Tests if the Item corresponding to the given Item ID is the last Item in the Container.
        Specified by:
        isLastId in interface Container.Ordered
        Returns:
        true if the Item is last visible item in the Container, false if not

      • lastItemId

        public java.lang.Object lastItemId()
        Deprecated.
        Description copied from interface: Container.Ordered
        Gets the ID of the last Item in the Container..
        Specified by:
        lastItemId in interface Container.Ordered
        Returns:
        ID of the last visible Item in the Container

      • nextItemId

        public java.lang.Object nextItemId​(java.lang.Object itemId)
        Deprecated.
        Description copied from interface: Container.Ordered
        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.
        Specified by:
        nextItemId in interface Container.Ordered
        Parameters:
        itemId - ID of a visible Item in the Container
        Returns:
        ID of the next visible Item or null

      • prevItemId

        public java.lang.Object prevItemId​(java.lang.Object itemId)
        Deprecated.
        Description copied from interface: Container.Ordered
        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.
        Specified by:
        prevItemId in interface Container.Ordered
        Parameters:
        itemId - ID of a visible Item in the Container
        Returns:
        ID of the previous visible Item or null

      • addContainerProperty

        public boolean addContainerProperty​(java.lang.Object propertyId,
                                    java.lang.Class<?> type,
                                    java.lang.Object defaultValue)
                             throws java.lang.UnsupportedOperationException
        Deprecated.
        Registers a new Property to all Items in the Container.
        Specified by:
        addContainerProperty in interface Container
        Parameters:
        propertyId - the ID of the new Property.
        type - the Data type of the new Property.
        defaultValue - the value all created Properties are initialized to.
        Returns:
        true if the operation succeeded, false if not
        Throws:
        java.lang.UnsupportedOperationException - if the container does not support explicitly adding container properties

      • addItem

        public java.lang.Object addItem()
                         throws java.lang.UnsupportedOperationException
        Deprecated.
        Creates a new Item into the Container, assigns it an automatic ID, and adds it to the ordering.
        Specified by:
        addItem in interface Container
        Returns:
        the autogenerated ID of the new Item or null if the operation failed
        Throws:
        java.lang.UnsupportedOperationException - if the addItem is not supported.

      • addItem

        public Item addItem​(java.lang.Object itemId)
             throws java.lang.UnsupportedOperationException
        Deprecated.
        Registers a new Item by its ID to the underlying container and to the ordering.
        Specified by:
        addItem in interface Container
        Parameters:
        itemId - the ID of the Item to be created.
        Returns:
        the added Item or null if the operation failed
        Throws:
        java.lang.UnsupportedOperationException - if the addItem is not supported.

      • removeAllItems

        public boolean removeAllItems()
                       throws java.lang.UnsupportedOperationException
        Deprecated.
        Removes all items from the underlying container and from the ordering.
        Specified by:
        removeAllItems in interface Container
        Returns:
        true if the operation succeeded, otherwise false
        Throws:
        java.lang.UnsupportedOperationException - if the removeAllItems is not supported.

      • removeItem

        public boolean removeItem​(java.lang.Object itemId)
                   throws java.lang.UnsupportedOperationException
        Deprecated.
        Removes an Item specified by the itemId from the underlying container and from the ordering.
        Specified by:
        removeItem in interface Container
        Parameters:
        itemId - the ID of the Item to be removed.
        Returns:
        true if the operation succeeded, false if not
        Throws:
        java.lang.UnsupportedOperationException - if the removeItem is not supported.

      • removeContainerProperty

        public boolean removeContainerProperty​(java.lang.Object propertyId)
                                throws java.lang.UnsupportedOperationException
        Deprecated.
        Removes the specified Property from the underlying container and from the ordering.

        Note : The Property will be removed from all the Items in the Container.

        Specified by:
        removeContainerProperty in interface Container
        Parameters:
        propertyId - the ID of the Property to remove.
        Returns:
        true if the operation succeeded, false if not
        Throws:
        java.lang.UnsupportedOperationException - if the removeContainerProperty is not supported.

      • containsId

        public boolean containsId​(java.lang.Object itemId)
        Deprecated.
        Description copied from interface: Container
        Tests if the Container contains the specified Item.

        Filtering can hide items so that they will not be visible through the container API, and this method should respect visibility of items (i.e. only indicate visible items as being in the container) if feasible for the container.

        Specified by:
        containsId in interface Container
        Parameters:
        itemId - ID the of Item to be tested
        Returns:
        boolean indicating if the Container holds the specified Item

      • getItem

        public Item getItem​(java.lang.Object itemId)
        Deprecated.
        Description copied from interface: Container
        Gets the Item with the given Item ID from the Container. If the Container does not contain the requested Item, null is returned.

        Containers should not return Items that are filtered out.

        Specified by:
        getItem in interface Container
        Parameters:
        itemId - ID of the Item to retrieve
        Returns:
        the Item with the given ID or null if the Item is not found in the Container

      • getItemIds

        public java.util.Collection<?> getItemIds()
        Deprecated.
        Description copied from interface: Container
        Gets the ID's of all visible (after filtering and sorting) Items stored in the Container. The ID's cannot be modified through the returned collection.

        If the container is Container.Ordered, the collection returned by this method should follow that order. If the container is Container.Sortable, the items should be in the sorted order.

        Calling this method for large lazy containers can be an expensive operation and should be avoided when practical.

        Specified by:
        getItemIds in interface Container
        Returns:
        unmodifiable collection of Item IDs

      • getContainerProperty

        public Property getContainerProperty​(java.lang.Object itemId,
                                     java.lang.Object propertyId)
        Deprecated.
        Description copied from interface: Container
        Gets the Property identified by the given itemId and propertyId from the Container. If the Container does not contain the item or it is filtered out, or the Container does not have the Property, null is returned.
        Specified by:
        getContainerProperty in interface Container
        Parameters:
        itemId - ID of the visible Item which contains the Property
        propertyId - ID of the Property to retrieve
        Returns:
        Property with the given ID or null

      • getContainerPropertyIds

        public java.util.Collection<?> getContainerPropertyIds()
        Deprecated.
        Description copied from interface: Container
        Gets the ID's of all Properties stored in the Container. The ID's cannot be modified through the returned collection.
        Specified by:
        getContainerPropertyIds in interface Container
        Returns:
        unmodifiable collection of Property IDs

      • getType

        public java.lang.Class<?> getType​(java.lang.Object propertyId)
        Deprecated.
        Description copied from interface: Container
        Gets the data type of all Properties identified by the given Property ID.
        Specified by:
        getType in interface Container
        Parameters:
        propertyId - ID identifying the Properties
        Returns:
        data type of the Properties

      • size

        public int size()
        Deprecated.
        Description copied from interface: Container
        Gets the number of visible Items in the Container.

        Filtering can hide items so that they will not be visible through the container API.

        Specified by:
        size in interface Container
        Returns:
        number of Items in the Container

      • addItemAfter

        public Item addItemAfter​(java.lang.Object previousItemId,
                         java.lang.Object newItemId)
                  throws java.lang.UnsupportedOperationException
        Deprecated.
        Description copied from interface: Container.Ordered
        Adds a new item after the given item.

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

        Specified by:
        addItemAfter in interface Container.Ordered
        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:
        java.lang.UnsupportedOperationException - if the operation is not supported by the container
        See Also:
        Ordered: adding items in filtered or sorted containers

      • addItemAfter

        public java.lang.Object addItemAfter​(java.lang.Object previousItemId)
                              throws java.lang.UnsupportedOperationException
        Deprecated.
        Description copied from interface: Container.Ordered
        Adds a new item after the given item.

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

        Specified by:
        addItemAfter in interface Container.Ordered
        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:
        java.lang.UnsupportedOperationException - if the operation is not supported by the container
        See Also:
        Ordered: adding items in filtered or sorted containers