org.esa.beam.framework.draw
Interface Figure

All Superinterfaces:

Cloneable, Drawable, Serializable

All Known Implementing Classes:

AbstractFigure, AreaFigure, LineFigure, ShapeFigure

Deprecated. since BEAM 4.7, no replacement

@Deprecated
public interface Figure
extends Drawable, Cloneable, Serializable

The interface of a graphical figure. A figure knows its center point, its bounding box and can draw itself. A figure can be composed of several sub-figures. Figures also can have an open ended set of attributes. An attribute is identified by a string and has an arbitrary type.

To interact and manipulate with a figure it can provide handles (see FigureHandle).

A handle can manipulate a figure's shape or its attributes.

A default implementation for the Figure interface are provided by the AbstractFigure class.

Version:

$Revision$ $Date$

Author:

Norman Fomferra

See Also:

FigureHandle, AbstractFigure

Field Summary

static String	FILL_COMPOSITE_KEY Deprecated. The attribute key used to determine which composite to use for the shape's interior.
static String	FILL_PAINT_KEY Deprecated. The attribute key used to determine which fill pattern to use for the shape's interior.
static String	FILL_STROKE_KEY Deprecated. The attribute key used to determine which stroke to use for the shape's interior.
static String	FILLED_KEY Deprecated. The attribute key used to determine whether or not this figure has a filled interior.
static String	OUTL_COLOR_KEY Deprecated. The attribute key used to determine which fill pattern to use for the out-line.
static String	OUTL_COMPOSITE_KEY Deprecated. The attribute key used to determine which composite to use for the out-line.
static String	OUTL_STROKE_KEY Deprecated. The attribute key used to determine which stroke to use for the out-line.
static String	OUTLINED_KEY Deprecated. The attribute key used to determine whether or not this figure has an out-line.
static String	TOOL_INPUT_EVENT_KEY Deprecated. since BEAM 4.6, no replacement

Method Summary

void	addFigureChangeListener(FigureChangeListener listener) Deprecated. Adds a listener for this figure.
Figure	clone() Deprecated. Returns a Clone of this figure
boolean	containsPoint(double x, double y) Deprecated. Checks if a point is inside the figure.
FigureHandle[]	createHandles() Deprecated. Returns the handles used to manipulate the figure.
Figure[]	decompose() Deprecated. Decomposes a figure into its parts.
void	dispose() Deprecated. Releases a figure's resources.
Figure	findFigureInside(double x, double y) Deprecated. Returns the figure that contains the given point.
Area	getAsArea() Deprecated. Gets the figure as an area.
Object	getAttribute(String name) Deprecated. Returns the named attribute or null if a a figure doesn't have an attribute.
Map<String,Object>	getAttributes() Deprecated. Returns the attributes of this figure as a Map.
Rectangle2D	getBounds() Deprecated. Gets the bounding box of the figure
Point2D	getCenterPoint() Deprecated. Gets the figure's center.
Figure[]	getFigures() Deprecated. Returns an Enumeration of the figures contained in this figure
Shape	getShape() Deprecated. Gets a shape representation of this figure.
int	getZValue() Deprecated. Gets the z value (back-to-front ordering) of this figure.
boolean	includes(Figure figure) Deprecated. Checks whether the given figure is contained in this figure.
boolean	isOneDimensional() Deprecated. Determines whether figure is a (one-dimensional) line in a two-dimensional space.
void	removeFigureChangeListener(FigureChangeListener listener) Deprecated. Removes a listener for this figure.
void	setAttribute(String name, Object value) Deprecated. Sets the named attribute to the new value
void	setAttributes(Map<String,Object> attributes) Deprecated. Sets multiple attributes
void	setZValue(int zValue) Deprecated. Sets the z value (back-to-front ordering) of this figure.

Methods inherited from interface org.esa.beam.framework.draw.Drawable

draw

Field Detail

TOOL_INPUT_EVENT_KEY

@Deprecated
static final String TOOL_INPUT_EVENT_KEY

Deprecated. since BEAM 4.6, no replacement

See Also:

Constant Field Values

FILLED_KEY

static final String FILLED_KEY

Deprecated.

The attribute key used to determine whether or not this figure has a filled interior. The value must be an instance of java.lang.Boolean.

See Also:

Constant Field Values

FILL_PAINT_KEY

static final String FILL_PAINT_KEY

Deprecated.

The attribute key used to determine which fill pattern to use for the shape's interior. The value must be an instance of java.awt.Paint.

See Also:

Constant Field Values

FILL_STROKE_KEY

static final String FILL_STROKE_KEY

Deprecated.

The attribute key used to determine which stroke to use for the shape's interior. The value must be an instance of java.awt.Stroke.

See Also:

Constant Field Values

FILL_COMPOSITE_KEY

static final String FILL_COMPOSITE_KEY

Deprecated.

The attribute key used to determine which composite to use for the shape's interior. The value must be an instance of java.awt.Composite.

See Also:

Constant Field Values

OUTLINED_KEY

static final String OUTLINED_KEY

Deprecated.

The attribute key used to determine whether or not this figure has an out-line. The value must be an instance of java.lang.Boolean.

See Also:

Constant Field Values

OUTL_COLOR_KEY

static final String OUTL_COLOR_KEY

Deprecated.

The attribute key used to determine which fill pattern to use for the out-line. The value must be an instance of java.awt.Paint.

See Also:

Constant Field Values

OUTL_STROKE_KEY

static final String OUTL_STROKE_KEY

Deprecated.

The attribute key used to determine which stroke to use for the out-line. The value must be an instance of java.awt.Stroke.

See Also:

Constant Field Values

OUTL_COMPOSITE_KEY

static final String OUTL_COMPOSITE_KEY

Deprecated.

The attribute key used to determine which composite to use for the out-line. The value must be an instance of java.awt.Composite.

See Also:

Constant Field Values

Method Detail

getCenterPoint

Point2D getCenterPoint()

Deprecated.

Gets the figure's center.

getBounds

Rectangle2D getBounds()

Deprecated.

Gets the bounding box of the figure

getShape

Shape getShape()

Deprecated.

Gets a shape representation of this figure.

If the figure does not have a shape represenation, the method returns null.

Returns:

a shape representation of this figure or null if no such exists.

createHandles

FigureHandle[] createHandles()

Deprecated.

Returns the handles used to manipulate the figure. createHandles is a Factory Method for creating handle objects.

Returns:

an array of handles

See Also:

FigureHandle

getFigures

Figure[] getFigures()

Deprecated.

Returns an Enumeration of the figures contained in this figure

findFigureInside

Figure findFigureInside(double x,
                        double y)

Deprecated.

Returns the figure that contains the given point.

containsPoint

boolean containsPoint(double x,
                      double y)

Deprecated.

Checks if a point is inside the figure.

includes

boolean includes(Figure figure)

Deprecated.

Checks whether the given figure is contained in this figure.

decompose

Figure[] decompose()

Deprecated.

Decomposes a figure into its parts. A figure is considered as a part of itself.

isOneDimensional

boolean isOneDimensional()

Deprecated.

Determines whether figure is a (one-dimensional) line in a two-dimensional space.

getAsArea

Area getAsArea()

Deprecated.

Gets the figure as an area. One-dimensional figures are returned as line strokes with a width of 1 unit.

dispose

void dispose()

Deprecated.

Releases a figure's resources. Release is called when a figure is removed from a drawing. Informs the listeners that the figure is removed by calling figureRemoved.

getZValue

int getZValue()

Deprecated.

Gets the z value (back-to-front ordering) of this figure. Z values are not guaranteed to not skip numbers.

setZValue

void setZValue(int zValue)

Deprecated.

Sets the z value (back-to-front ordering) of this figure. Z values are not guaranteed to not skip numbers.

getAttributes

Map<String,Object> getAttributes()

Deprecated.

Returns the attributes of this figure as a Map.

getAttribute

Object getAttribute(String name)

Deprecated.

Returns the named attribute or null if a a figure doesn't have an attribute. All figures support the attribute names FillColor and FrameColor

setAttribute

void setAttribute(String name,
                  Object value)

Deprecated.

Sets the named attribute to the new value

setAttributes

void setAttributes(Map<String,Object> attributes)

Deprecated.

Sets multiple attributes

addFigureChangeListener

void addFigureChangeListener(FigureChangeListener listener)

Deprecated.

Adds a listener for this figure.

Parameters:

listener - the listener to be added

removeFigureChangeListener

void removeFigureChangeListener(FigureChangeListener listener)

Deprecated.

Removes a listener for this figure.

Parameters:

listener - the listener to be removed

clone

Figure clone()

Deprecated.

Returns a Clone of this figure