li.netcat.chart.util.elem
Class SymbolElement

java.lang.Object
  li.netcat.chart.util.elem.Element
      li.netcat.chart.util.elem.SymbolElement

public class SymbolElement

extends Element

Immutable, basic element of a line chart that defines a small reference symbol. It contains the shape, the paint and the position of the center of the symbol.

Author:

Arthur Marxer

Constructor Summary

SymbolElement(java.awt.Shape symbol, java.awt.Paint paint, float x, float y, java.lang.Object perspective)
Constructs a new symbol element and initializes its fields to the given values.

SymbolElement(java.awt.Shape symbol, java.awt.Paint paint, float x, float y, java.lang.Object perspective, LogicalPoint point)
Constructs a new symbol element and initializes its fields to the given values.

Method Summary

boolean	contains(java.awt.Point p) Returns true if this element contains the given point.
java.awt.geom.Rectangle2D.Float	getBounds(java.awt.geom.Rectangle2D.Float out) Returns the bounds of this element in float precision.
java.awt.Paint	getPaint() Returns the paint that is used to fill the outline of the symbol.
java.awt.Shape	getSymbol() Returns the outline of the symbol.
float	getX() Returns the x-coordinate of the center of the symbol.
float	getY() Returns the y-coordinate of the center of the symbol.

Methods inherited from class li.netcat.chart.util.elem.Element

getLogicalPoint, getPerspective

Methods inherited from class java.lang.Object

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

Constructor Detail

SymbolElement

public SymbolElement(java.awt.Shape symbol,
                     java.awt.Paint paint,
                     float x,
                     float y,
                     java.lang.Object perspective)

Constructs a new symbol element and initializes its fields to the given values.

Parameters:

paint - The paint used to fill the symbol, not null.

x - The x-coordinate of the center of the symbol.

y - The y-coordinate of the center of the symbol.

perspective - The perspective position of this element.

See Also:

PerspectivePart

SymbolElement

public SymbolElement(java.awt.Shape symbol,
                     java.awt.Paint paint,
                     float x,
                     float y,
                     java.lang.Object perspective,
                     LogicalPoint point)

Constructs a new symbol element and initializes its fields to the given values.

Parameters:

paint - The paint used to fill the symbol, not null.

x - The x-coordinate of the center of the symbol.

y - The y-coordinate of the center of the symbol.

perspective - The perspective position of this element.

point - The logical point to which this element points to.

See Also:

PerspectivePart

Method Detail

getSymbol

public java.awt.Shape getSymbol()

Returns the outline of the symbol.

Returns:

The outline of the symbol.

getPaint

public java.awt.Paint getPaint()

Returns the paint that is used to fill the outline of the symbol.

Returns:

The paint that is used to fill the outline of the symbol.

getX

public float getX()

Returns the x-coordinate of the center of the symbol.

Returns:

The x-coordinate of the center of the symbol.

getY

public float getY()

Returns the y-coordinate of the center of the symbol.

Returns:

The y-coordinate of the center of the symbol.

getBounds

public java.awt.geom.Rectangle2D.Float getBounds(java.awt.geom.Rectangle2D.Float out)

Description copied from class: Element

Returns the bounds of this element in float precision.

Specified by:

getBounds in class Element

Parameters:

out - The return value, not null.

Returns:

The bounds of this element in float precision.

contains

public boolean contains(java.awt.Point p)

Description copied from class: Element

Returns true if this element contains the given point.

Specified by:

contains in class Element