org.esa.beam.framework.ui.tool
Interface DrawingEditor

Deprecated. since BEAM 4.7, no replacement

@Deprecated
public interface DrawingEditor

An editor which is used by tools to draw themselfes and to let them add, remove and query figures.

Version:

$Revision$ $Date$

Author:

Norman Fomferra

Nested Class Summary

static class

DrawingEditor.InsertMode Deprecated.

Method Summary

void	addFigure(Figure figure) Deprecated. since BEAM 4.6, use insertFigure(Figure, InsertMode) instead
Figure[]	getAllFigures() Deprecated. Gets all figures.
Figure	getFigureAt(int index) Deprecated. Gets the figure at the specified index.
Figure[]	getFiguresWithAttribute(String name) Deprecated. Gets all figures having an attribute with the given name.
Figure[]	getFiguresWithAttribute(String name, Object value) Deprecated. Gets all figures having an attribute with the given name and value.
int	getNumFigures() Deprecated. Returns the number of figures.
Figure[]	getSelectedFigures() Deprecated. Gets all selected figures.
AbstractTool	getSelectTool() Deprecated.
Tool	getTool() Deprecated.
void	handleSelection(Rectangle rectangle) Deprecated. Called if a selection occurred.
void	insertFigure(Figure figure, DrawingEditor.InsertMode insertMode) Deprecated. Adds a new figure to the drawing using the specified insertion mode.
void	removeFigure(Figure figure) Deprecated. Removes a figure from the drawing.
void	repaint() Deprecated. Repaints the drawing.
void	repaintTool() Deprecated. Repaints the current tool (if any).
void	setTool(Tool tool) Deprecated.

Method Detail

getTool

Tool getTool()

Deprecated.

Returns:

The current tool for this drawing.

setTool

void setTool(Tool tool)

Deprecated.

Parameters:

tool - The current tool for this drawing.

getSelectTool

AbstractTool getSelectTool()

Deprecated.

Returns:

A special "select" tool, may be null.

handleSelection

void handleSelection(Rectangle rectangle)

Deprecated.

Called if a selection occurred.

Parameters:

rectangle - The selection rectangle in view coordinates.

repaintTool

void repaintTool()

Deprecated.

Repaints the current tool (if any).

repaint

void repaint()

Deprecated.

Repaints the drawing.

addFigure

@Deprecated
void addFigure(Figure figure)

Deprecated. since BEAM 4.6, use insertFigure(Figure, InsertMode) instead

Adds a new figure to the drawing and replaces any existing figure.

Parameters:

figure - The figure to add to the this drawing.

insertFigure

void insertFigure(Figure figure,
                  DrawingEditor.InsertMode insertMode)

Deprecated.

Adds a new figure to the drawing using the specified insertion mode.

Parameters:

figure - The figure to add to this drawing.

insertMode - Specifies how to add the figure to this drawing.

removeFigure

void removeFigure(Figure figure)

Deprecated.

Removes a figure from the drawing.

Parameters:

figure - The figure to remove from this drawing.

getNumFigures

int getNumFigures()

Deprecated.

Returns the number of figures.

Returns:

The number of figures

getFigureAt

Figure getFigureAt(int index)

Deprecated.

Gets the figure at the specified index.

Parameters:

index - The index of the figure to retrieve.

Returns:

The figure, never null

getAllFigures

Figure[] getAllFigures()

Deprecated.

Gets all figures.

Returns:

the figure array which is empty if no figures where found, never null

getSelectedFigures

Figure[] getSelectedFigures()

Deprecated.

Gets all selected figures.

Returns:

the figure array which is empty if no figures where found, never null

getFiguresWithAttribute

Figure[] getFiguresWithAttribute(String name)

Deprecated.

Gets all figures having an attribute with the given name.

Parameters:

name - the attribute name

Returns:

the figure array which is empty if no figures where found, never null

getFiguresWithAttribute

Figure[] getFiguresWithAttribute(String name,
                                 Object value)

Deprecated.

Gets all figures having an attribute with the given name and value.

Parameters:

name - the attribute name, must not be null

value - the attribute value, must not be null

Returns:

the figure array which is empty if no figures where found, never null