com.androidplot.util

Interface ZIndexable<ElementType>

Type Parameters:

ElementType -

All Known Implementing Classes:

LayoutManager, ListOrganizer, ZHash, ZLinkedList

public interface ZIndexable<ElementType>

Encapsulates the concept of z-indexable objects; Each object is stored above or below each other object and may be moved up and down in the queue relative to other elements in the hash or absolutely to the front or back of the queue. Note that the method names correspond to the order of items drawn directly on top of one another using an iterator; the first element drawn (lowest z-index) is effectively the "bottom" element.

Method Summary

Modifier and Type	Method and Description
List<ElementType>	elements()
boolean	moveAbove(ElementType objectToMove, ElementType reference) Move above the specified element
boolean	moveBeneath(ElementType objectToMove, ElementType reference) Move beneath the specified element
boolean	moveDown(ElementType key) Move down by one element
boolean	moveToBottom(ElementType key) Move beneath all other elements
boolean	moveToTop(ElementType element) Move above all other elements
boolean	moveUp(ElementType key) Move up by one element

Method Detail

moveToTop

boolean moveToTop(ElementType element)

Move above all other elements

Parameters:

element -

Returns:

moveAbove

boolean moveAbove(ElementType objectToMove,
                  ElementType reference)

Move above the specified element

Parameters:

objectToMove -

reference -

Returns:

moveBeneath

boolean moveBeneath(ElementType objectToMove,
                    ElementType reference)

Move beneath the specified element

Parameters:

objectToMove -

reference -

Returns:

moveToBottom

boolean moveToBottom(ElementType key)

Move beneath all other elements

Parameters:

key -

Returns:

moveUp

boolean moveUp(ElementType key)

Move up by one element

Parameters:

key -

Returns:

moveDown

boolean moveDown(ElementType key)

Move down by one element

Parameters:

key -

Returns:

elements

List<ElementType> elements()