All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class CH.ifa.draw.standard.CompositeFigure

java.lang.Object
   |
   +----CH.ifa.draw.standard.AbstractFigure
           |
           +----CH.ifa.draw.standard.CompositeFigure

public abstract class CompositeFigure

extends AbstractFigure

implements FigureChangeListener

Composite
CompositeFigure enables to treat a composition of figures like a single figure.

See Also:

Figure

fFigures

The figures that this figure is composed of

CompositeFigure()

add(Figure)

Adds a figure to the list of figures.

addAll(Vector)

Adds a vector of figures.

basicMoveBy(int, int)

Moves all the given figures by x and y.

bringToFront(Figure)

Brings a figure to the front.

draw(Graphics)

Draws all the contained figures

figureAt(int)

Gets a figure at the given index.

figureChanged(FigureChangeEvent)

figureCount()

Gets number of child figures.

figureInvalidated(FigureChangeEvent)

Propagates the figureInvalidated event to my listener.

figureRemoved(FigureChangeEvent)

figureRequestRemove(FigureChangeEvent)

Propagates the removeFromDrawing request up to the container.

figureRequestUpdate(FigureChangeEvent)

Propagates the requestUpdate request up to the container.

figures()

Returns an Enumeration for accessing the contained figures.

figuresReverse()

Returns an Enumeration for accessing the contained figures in the reverse drawing order.

findFigure(int, int)

Finds a top level Figure.

findFigure(Rectangle)

Finds a top level Figure that intersects the given rectangle.

findFigure(Rectangle, Figure)

Finds a top level Figure that intersects the given rectangle.

findFigureInside(int, int)

Finds a figure but descends into a figure's children.

findFigureInsideWithout(int, int, Figure)

Finds a figure but descends into a figure's children.

findFigureWithout(int, int, Figure)

Finds a top level Figure, but supresses the passed in figure.

includes(Figure)

Checks if the composite figure has the argument as one of its children.

orphan(Figure)

Removes a figure from the figure list, but doesn't release it.

orphanAll(Vector)

Removes a vector of figures from the figure's list without releasing the figures.

read(StorableInput)

Reads the contained figures from StorableInput.

release()

Releases the figure and all its children.

remove(Figure)

Removes a figure from the composite.

removeAll()

Removes all children.

removeAll(Vector)

Removes a vector of figures.

replace(Figure, Figure)

Replaces a figure in the drawing without removing it from the drawing.

sendToBack(Figure)

Sends a figure to the back of the drawing.

write(StorableOutput)

Writes the contained figures to the StorableOutput.

 protected Vector fFigures

The figures that this figure is composed of

See Also:

add, remove

 protected CompositeFigure()

 public Figure add(Figure figure)

Adds a figure to the list of figures. Initializes the the figure's container.

 public void addAll(Vector newFigures)

Adds a vector of figures.

See Also:

add

 public Figure remove(Figure figure)

Removes a figure from the composite.

See Also:

removeAll

 public void removeAll(Vector figures)

Removes a vector of figures.

See Also:

remove

 public void removeAll()

Removes all children.

See Also:

remove

 public synchronized Figure orphan(Figure figure)

Removes a figure from the figure list, but doesn't release it. Use this method to temporarily manipulate a figure outside of the drawing.

 public void orphanAll(Vector newFigures)

Removes a vector of figures from the figure's list without releasing the figures.

See Also:

orphan

 public synchronized void replace(Figure figure,
                                  Figure replacement)

Replaces a figure in the drawing without removing it from the drawing.

 public synchronized void sendToBack(Figure figure)

Sends a figure to the back of the drawing.

 public synchronized void bringToFront(Figure figure)

Brings a figure to the front.

 public void draw(Graphics g)

Draws all the contained figures

Overrides:

draw in class AbstractFigure

See Also:

draw

 public Figure figureAt(int i)

Gets a figure at the given index.

 public final FigureEnumeration figures()

Returns an Enumeration for accessing the contained figures. The figures are returned in the drawing order.

Overrides:

figures in class AbstractFigure

 public int figureCount()

Gets number of child figures.

 public final FigureEnumeration figuresReverse()

Returns an Enumeration for accessing the contained figures in the reverse drawing order.

 public Figure findFigure(int x,
                          int y)

Finds a top level Figure. Use this call for hit detection that should not descend into the figure's children.

 public Figure findFigure(Rectangle r)

Finds a top level Figure that intersects the given rectangle.

 public Figure findFigureWithout(int x,
                                 int y,
                                 Figure without)

Finds a top level Figure, but supresses the passed in figure. Use this method to ignore a figure that is temporarily inserted into the drawing.

Parameters:

x - the x coordinate

y - the y coordinate

without - the figure to be ignored during the find.

 public Figure findFigure(Rectangle r,
                          Figure without)

Finds a top level Figure that intersects the given rectangle. It supresses the passed in figure. Use this method to ignore a figure that is temporarily inserted into the drawing.

 public Figure findFigureInside(int x,
                                int y)

Finds a figure but descends into a figure's children. Use this method to implement click-through hit detection, that is, you want to detect the inner most figure containing the given point.

Overrides:

findFigureInside in class AbstractFigure

 public Figure findFigureInsideWithout(int x,
                                       int y,
                                       Figure without)

Finds a figure but descends into a figure's children. It supresses the passed in figure. Use this method to ignore a figure that is temporarily inserted into the drawing.

 public boolean includes(Figure figure)

Checks if the composite figure has the argument as one of its children.

Overrides:

includes in class AbstractFigure

 protected void basicMoveBy(int x,
                            int y)

Moves all the given figures by x and y. Doesn't announce any changes. Subclassers override basicMoveBy. Clients usually call moveBy.

Overrides:

basicMoveBy in class AbstractFigure

See Also:

moveBy

 public void release()

Releases the figure and all its children.

Overrides:

release in class AbstractFigure

 public void figureInvalidated(FigureChangeEvent e)

Propagates the figureInvalidated event to my listener.

See Also:

FigureChangeListener

 public void figureRequestRemove(FigureChangeEvent e)

Propagates the removeFromDrawing request up to the container.

See Also:

FigureChangeListener

 public void figureRequestUpdate(FigureChangeEvent e)

Propagates the requestUpdate request up to the container.

See Also:

FigureChangeListener

 public void figureChanged(FigureChangeEvent e)

 public void figureRemoved(FigureChangeEvent e)

 public void write(StorableOutput dw)

Writes the contained figures to the StorableOutput.

Overrides:

write in class AbstractFigure

 public void read(StorableInput dr) throws IOException

Reads the contained figures from StorableInput.

Overrides:

read in class AbstractFigure

All Packages  Class Hierarchy  This Package  Previous  Next  Index