org.apache.pivot.wtk.media.drawing
Class Group

java.lang.Object
  extended by org.apache.pivot.wtk.media.drawing.Shape
      extended by org.apache.pivot.wtk.media.drawing.Group
All Implemented Interfaces:
Iterable<Shape>, Sequence<Shape>
Direct Known Subclasses:
Canvas

public class Group
extends Shape
implements Sequence<Shape>, Iterable<Shape>

Shape representing a collection of other shapes.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.pivot.wtk.media.drawing.Shape
Shape.Rotate, Shape.Scale, Shape.Transform, Shape.TransformSequence, Shape.Translate
 
Nested classes/interfaces inherited from interface org.apache.pivot.collections.Sequence
Sequence.Tree
 
Constructor Summary
Group()
           
 
Method Summary
 int add(Shape shape)
          Adds an item to the sequence.
 void draw(Graphics2D graphics)
           
 Shape get(int index)
          Retrieves the item at the given index.
 ListenerList<GroupListener> getGroupListeners()
           
 int getLength()
          Returns the length of the sequence.
 int indexOf(Shape shape)
          Returns the index of an item in the sequence.
 void insert(Shape shape, int index)
          Inserts an item into the sequence at a specific index.
 Iterator<Shape> iterator()
           
 Sequence<Shape> remove(int index, int count)
          Removes one or more items from the sequence.
 int remove(Shape shape)
          Removes the first occurrence of the given item from the sequence.
 void setFill(Paint fill)
           
 void setStroke(Paint stroke)
           
 void setStrokeThickness(int strokeThickness)
           
 Shape update(int index, Shape shape)
          Updates the item at the given index.
protected  void validate()
           
 
Methods inherited from class org.apache.pivot.wtk.media.drawing.Shape
getBounds, getFill, getOrigin, getParent, getShapeListeners, getShapeTransformListeners, getStroke, getStrokeThickness, getTransformedBounds, getTransforms, getX, getY, invalidate, isValid, isVisible, setBounds, setFill, setOrigin, setOrigin, setParent, setStroke, setVisible, setX, setY, update, update, update
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Group

public Group()
Method Detail

setFill

public void setFill(Paint fill)
Overrides:
setFill in class Shape

setStroke

public void setStroke(Paint stroke)
Overrides:
setStroke in class Shape

setStrokeThickness

public void setStrokeThickness(int strokeThickness)
Overrides:
setStrokeThickness in class Shape

draw

public void draw(Graphics2D graphics)
Specified by:
draw in class Shape

validate

protected void validate()
Overrides:
validate in class Shape

add

public int add(Shape shape)
Description copied from interface: Sequence
Adds an item to the sequence.

Specified by:
add in interface Sequence<Shape>
Parameters:
shape - The item to be added to the sequence.
Returns:
The index at which the item was added, or -1 if the item was not added to the sequence.

insert

public void insert(Shape shape,
                   int index)
Description copied from interface: Sequence
Inserts an item into the sequence at a specific index.

Specified by:
insert in interface Sequence<Shape>
Parameters:
shape - The item to be added to the sequence.
index - The index at which the item should be inserted. Must be a value between 0 and getLength().

update

public Shape update(int index,
                    Shape shape)
Description copied from interface: Sequence
Updates the item at the given index.

Specified by:
update in interface Sequence<Shape>
Parameters:
index - The index of the item to update.
shape - The item that will replace any existing value at the given index.
Returns:
The item that was previously stored at the given index.

remove

public int remove(Shape shape)
Description copied from interface: Sequence
Removes the first occurrence of the given item from the sequence.

Specified by:
remove in interface Sequence<Shape>
Parameters:
shape - The item to remove.
Returns:
The index of the item that was removed, or -1 if the item could not be found.
See Also:
Sequence.remove(int, int)

remove

public Sequence<Shape> remove(int index,
                              int count)
Description copied from interface: Sequence
Removes one or more items from the sequence.

Specified by:
remove in interface Sequence<Shape>
Parameters:
index - The starting index to remove.
count - The number of items to remove, beginning with index.
Returns:
A sequence containing the items that were removed.

get

public Shape get(int index)
Description copied from interface: Sequence
Retrieves the item at the given index.

Specified by:
get in interface Sequence<Shape>
Parameters:
index - The index of the item to retrieve.

indexOf

public int indexOf(Shape shape)
Description copied from interface: Sequence
Returns the index of an item in the sequence.

Specified by:
indexOf in interface Sequence<Shape>
Parameters:
shape - The item to locate.
Returns:
The index of first occurrence of the item if it exists in the sequence; -1, otherwise.

getLength

public int getLength()
Description copied from interface: Sequence
Returns the length of the sequence.

Specified by:
getLength in interface Sequence<Shape>
Returns:
The number of items in the sequence.

iterator

public Iterator<Shape> iterator()
Specified by:
iterator in interface Iterable<Shape>

getGroupListeners

public ListenerList<GroupListener> getGroupListeners()