Package com.bc.ceres.swing.figure.support

Class DefaultFigureCollection

java.lang.Object

com.bc.ceres.swing.figure.AbstractFigure

com.bc.ceres.swing.figure.support.DefaultFigureCollection

All Implemented Interfaces:

Figure, FigureCollection, Restorable, Cloneable

Direct Known Subclasses:

DefaultFigureSelection

public class DefaultFigureCollection
extends AbstractFigure
implements FigureCollection

Nested Class Summary

Nested classes/interfaces inherited from interface com.bc.ceres.swing.figure.Figure

Figure.Rank

Field Summary

Fields inherited from class com.bc.ceres.swing.figure.AbstractFigure

NO_FIGURES, NO_HANDLES

Constructor Summary

Constructors

Constructor	Description
DefaultFigureCollection()
DefaultFigureCollection(Figure[] figures)

Method Summary

Modifier and Type	Method	Description
protected boolean	addFigureImpl(int index, Figure figure)	The default implementation throws an [@code IllegalStateException}.
protected boolean	addFigureImpl(Figure figure)
Object	clone()
protected Rectangle2D	computeBounds()
boolean	contains(Figure figure)	The default implementation returns false.
Handle[]	createHandles(int selectionStage)	The default implementation returns an empty array.
Object	createMemento()	The default implementation returns [@code null}.
void	dispose()	Disposes this figure.
void	draw(Rendering rendering)	Draws this figure using the given rendering.
Rectangle2D	getBounds()
Figure	getFigure(int index)	The default implementation throws an [@code IllegalStateException}.
Figure	getFigure(Point2D p, AffineTransform m2v)	The default implementation returns null.
int	getFigureCount()	The default implementation returns 0.
int	getFigureIndex(Figure figure)	The default implementation returns 0.
Figure[]	getFigures()	The default implementation returns an empty array.
Figure[]	getFigures(Shape shape)	The default implementation returns an empty array.
int	getMaxSelectionStage()	The default implementation returns zero.
Figure.Rank	getRank()
boolean	isCloseTo(Point2D point, AffineTransform m2v)	Tests if the given point is "close to" this figure.
boolean	isCollection()	Tests if this figure is a figure collection.
boolean	isSelectable()	The default implementation returns false.
boolean	isSelected()	Tests if the figure is selected.
void	move(double dx, double dy)	Moves the figure by the given delta in model coordinates.
protected boolean	removeFigureImpl(Figure figure)	The default implementation throws an [@code IllegalStateException}.
protected Figure[]	removeFiguresImpl()
void	rotate(Point2D point, double theta)	Rotates the figure by the given angle.
void	scale(Point2D refPoint, double sx, double sy)	Scales the figure by the given scale factors.
void	setMemento(Object memento)	The default implementation does nothing.
void	setSelected(boolean selected)	Sets the selected state.

Methods inherited from class com.bc.ceres.swing.figure.AbstractFigure

addChangeListener, addFigure, addFigure, addFigures, addFiguresImpl, addSegment, createScaleHandles, fireFigureChanged, fireFigureChanged, fireFiguresAdded, fireFiguresRemoved, getChangeListeners, getEffectiveStyle, getHandleStyle, getNormalStyle, getSegment, getSelectedHandleStyle, getSelectedStyle, removeAllFigures, removeChangeListener, removeFigure, removeFigures, removeFiguresImpl, removeSegment, setNormalStyle, setSegment, setSelectable, setSelectedStyle

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.bc.ceres.swing.figure.Figure

addChangeListener, addFigure, addFigure, addFigures, addSegment, getChangeListeners, getEffectiveStyle, getNormalStyle, getSegment, getSelectedStyle, removeAllFigures, removeChangeListener, removeFigure, removeFigures, removeSegment, setNormalStyle, setSegment, setSelectedStyle

Constructor Detail

DefaultFigureCollection

public DefaultFigureCollection()

DefaultFigureCollection

public DefaultFigureCollection(Figure[] figures)

Method Detail

isSelectable

public boolean isSelectable()

Description copied from class: AbstractFigure

The default implementation returns false.

Specified by:

isSelectable in interface Figure

Overrides:

isSelectable in class AbstractFigure

Returns:

Always false.

isSelected

public boolean isSelected()

Description copied from interface: Figure

Tests if the figure is selected.

Specified by:

isSelected in interface Figure

Overrides:

isSelected in class AbstractFigure

Returns:

true, if so.

setSelected

public void setSelected(boolean selected)

Description copied from interface: Figure

Sets the selected state.

Specified by:

setSelected in interface Figure

Overrides:

setSelected in class AbstractFigure

Parameters:

selected - The selected state.

isCollection

public boolean isCollection()

Description copied from interface: Figure

Tests if this figure is a figure collection.

Specified by:

isCollection in interface Figure

Returns:

true, if so.

getRank

public Figure.Rank getRank()

Specified by:

getRank in interface Figure

Returns:

The figure's rank.

dispose

public void dispose()

Description copied from interface: Figure

Disposes this figure. Indicates that it will no longer be used.

Specified by:

dispose in interface Figure

Overrides:

dispose in class AbstractFigure

clone

public Object clone()

Specified by:

clone in interface Figure

Overrides:

clone in class AbstractFigure

Returns:

A clone of this figure.

getMaxSelectionStage

public int getMaxSelectionStage()

Description copied from class: AbstractFigure

The default implementation returns zero.

Specified by:

getMaxSelectionStage in interface Figure

Overrides:

getMaxSelectionStage in class AbstractFigure

Returns:

Always 0.

createHandles

public Handle[] createHandles(int selectionStage)

Description copied from class: AbstractFigure

The default implementation returns an empty array. Clients should override in order to create an array of handles suitable for the given selection stage.

Specified by:

createHandles in interface Figure

Overrides:

createHandles in class AbstractFigure

Parameters:

selectionStage - The selection stage. 1 <= selectionLevel <= AbstractFigure.getMaxSelectionStage()

Returns:

The array of handles.

isCloseTo

public boolean isCloseTo(Point2D point,
                         AffineTransform m2v)

Description copied from interface: Figure

Tests if the given point is "close to" this figure.

Specified by:

isCloseTo in interface Figure

Parameters:

point - Point in model coordinates.

m2v - Current model-to-view transformation.

Returns:

true, if the point is close to this figure.

contains

public boolean contains(Figure figure)

Description copied from class: AbstractFigure

The default implementation returns false.

Specified by:

contains in interface Figure

Overrides:

contains in class AbstractFigure

Parameters:

figure - A figure.

Returns:

Always false.

getFigureCount

public int getFigureCount()

Description copied from class: AbstractFigure

The default implementation returns 0.

Specified by:

getFigureCount in interface Figure

Overrides:

getFigureCount in class AbstractFigure

Returns:

Always 0.

getFigureIndex

public int getFigureIndex(Figure figure)

Description copied from class: AbstractFigure

The default implementation returns 0.

Specified by:

getFigureIndex in interface Figure

Overrides:

getFigureIndex in class AbstractFigure

Parameters:

figure - The child figure to look up.

Returns:

Always 0.

getFigure

public Figure getFigure(int index)

Description copied from class: AbstractFigure

The default implementation throws an [@code IllegalStateException}.

Specified by:

getFigure in interface Figure

Overrides:

getFigure in class AbstractFigure

Parameters:

index - The child index.

Returns:

Does never return normally.

getFigure

public Figure getFigure(Point2D p,
                        AffineTransform m2v)

Description copied from class: AbstractFigure

The default implementation returns null.

Specified by:

getFigure in interface Figure

Overrides:

getFigure in class AbstractFigure

Parameters:

p - Point in model coordinates.

m2v - Current model-to-view transformation.

Returns:

Always null.

getFigures

public Figure[] getFigures(Shape shape)

Description copied from class: AbstractFigure

The default implementation returns an empty array.

Specified by:

getFigures in interface Figure

Overrides:

getFigures in class AbstractFigure

Parameters:

shape - The shape defining the area in which the figures must be contained.

Returns:

Always an empty array.

getFigures

public Figure[] getFigures()

Description copied from class: AbstractFigure

The default implementation returns an empty array.

Specified by:

getFigures in interface Figure

Overrides:

getFigures in class AbstractFigure

Returns:

Always an empty array.

addFigureImpl

protected boolean addFigureImpl(Figure figure)

Overrides:

addFigureImpl in class AbstractFigure

addFigureImpl

protected boolean addFigureImpl(int index,
                                Figure figure)

Description copied from class: AbstractFigure

The default implementation throws an [@code IllegalStateException}.

Overrides:

addFigureImpl in class AbstractFigure

Parameters:

index - The index.

figure - The figure.

Returns:

Does never return normally.

removeFigureImpl

protected boolean removeFigureImpl(Figure figure)

Description copied from class: AbstractFigure

The default implementation throws an [@code IllegalStateException}.

Overrides:

removeFigureImpl in class AbstractFigure

Parameters:

figure - The figure.

Returns:

Does never return normally.

removeFiguresImpl

protected Figure[] removeFiguresImpl()

Overrides:

removeFiguresImpl in class AbstractFigure

getBounds

public Rectangle2D getBounds()

Specified by:

getBounds in interface Figure

Returns:

The figure bounds in model coordinates.

move

public void move(double dx,
                 double dy)

Description copied from interface: Figure

Moves the figure by the given delta in model coordinates.

Specified by:

move in interface Figure

Overrides:

move in class AbstractFigure

Parameters:

dx - Delta X in model coordinates.

dy - Delta Y in model coordinates.

scale

public void scale(Point2D refPoint,
                  double sx,
                  double sy)

Description copied from interface: Figure

Scales the figure by the given scale factors.

Specified by:

scale in interface Figure

Overrides:

scale in class AbstractFigure

Parameters:

refPoint - The reference point in model coordinates.

sx - Scale X factor.

sy - Scale Y factor.

rotate

public void rotate(Point2D point,
                   double theta)

Description copied from interface: Figure

Rotates the figure by the given angle.

Specified by:

rotate in interface Figure

Overrides:

rotate in class AbstractFigure

Parameters:

point - The reference point in model coordinates.

theta - The rotation angle in degree.

draw

public void draw(Rendering rendering)

Description copied from interface: Figure

Draws this figure using the given rendering.

Specified by:

draw in interface Figure

Parameters:

rendering - The rendering used to draw the figure.

createMemento

public Object createMemento()

Description copied from class: AbstractFigure

The default implementation returns [@code null}. Clients should override in order to produce something more meaningful.

Specified by:

createMemento in interface Restorable

Overrides:

createMemento in class AbstractFigure

Returns:

Always null.

setMemento

public void setMemento(Object memento)

Description copied from class: AbstractFigure

The default implementation does nothing. Clients should override in order to evaluate the passed in memento. object.

Specified by:

setMemento in interface Restorable

Overrides:

setMemento in class AbstractFigure

Parameters:

memento - A memento object.

computeBounds

protected Rectangle2D computeBounds()