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

Class NamedSymbol

java.lang.Object

com.bc.ceres.swing.figure.support.NamedSymbol

All Implemented Interfaces:

Symbol

public class NamedSymbol
extends Object
implements Symbol

A symbol with a (well-known) name.

Since:

Ceres 0.13

Field Summary

Fields

Modifier and Type	Field	Description
static NamedSymbol	CIRCLE
static NamedSymbol	CROSS
static NamedSymbol	PIN
static NamedSymbol	PLUS
static NamedSymbol	SQUARE
static NamedSymbol	STAR

Constructor Summary

Constructors

Constructor	Description
NamedSymbol(String name, Symbol symbol)

Method Summary

Modifier and Type	Method	Description
void	draw(Rendering rendering, FigureStyle style)	Draws the symbol on the given rendering using the given style.
Rectangle2D	getBounds()	The bounds of the symbol.
String	getName()
Symbol	getSymbol()
static NamedSymbol	getSymbol(String name)
boolean	isHitBy(double x, double y)	Tests weather this symbol is hit by the given point.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PLUS

public static final NamedSymbol PLUS

CROSS

public static final NamedSymbol CROSS

STAR

public static final NamedSymbol STAR

SQUARE

public static final NamedSymbol SQUARE

CIRCLE

public static final NamedSymbol CIRCLE

PIN

public static final NamedSymbol PIN

Constructor Detail

NamedSymbol

public NamedSymbol(String name,
                   Symbol symbol)

Method Detail

getSymbol

public static NamedSymbol getSymbol(String name)

getName

public String getName()

getSymbol

public Symbol getSymbol()

isHitBy

public boolean isHitBy(double x,
                       double y)

Description copied from interface: Symbol

Tests weather this symbol is hit by the given point.

Specified by:

isHitBy in interface Symbol

Parameters:

x - The X-coordinate of the point in symbol coordinates using view units.

y - The Y-coordinate of the point in symbol coordinates using view units.

Returns:

true, if so.

getBounds

public Rectangle2D getBounds()

Description copied from interface: Symbol

The bounds of the symbol.

Specified by:

getBounds in interface Symbol

Returns:

The bounds of the symbol in symbol coordinates using view units.

draw

public void draw(Rendering rendering,
                 FigureStyle style)

Description copied from interface: Symbol

Draws the symbol on the given rendering using the given style. The rendering's graphics is transformed so that drawing can be done directly in symbol coordinates using view units, e.g.

     rendering.getGraphics().draw(symbolShape);
 

or

     rendering.getGraphics().drawRenderedImage(symbolImage, null);
 

Specified by:

draw in interface Symbol

Parameters:

rendering - The rendering.

style - The style.

toString

public String toString()

Overrides:

toString in class Object