net.sf.jaxodraw.gui.handle

Class AbstractJaxoHandle

java.lang.Object

net.sf.jaxodraw.gui.handle.AbstractJaxoHandle

All Implemented Interfaces:

JaxoHandle

Direct Known Subclasses:

JaxoDefaultHandle, JaxoRoundHandle

public abstract class AbstractJaxoHandle
extends java.lang.Object
implements JaxoHandle

An abstract class for handles.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.awt.Color	DEFAULT_COLOR The default color of a handle: JaxoColor.RED.
static java.awt.Color	DEFAULT_FILL_COLOR The default fill color of a handle: JaxoColor.GRAYSCALE150.
static java.awt.Color	DEFAULT_SECONDARY_COLOR The default secondary color of a handle: JaxoColor.NAVY_BLUE.
static int	DEFAULT_SIZE The default size of a handle.
static java.awt.Stroke	DEFAULT_STROKE The default stroke for a handle.

Constructor Summary

Constructors

Constructor and Description
AbstractJaxoHandle()

Method Summary

Modifier and Type	Method and Description
java.awt.Rectangle	getBounds(int x, int y) Return an enclosing Rectangle that completely contains this handle at the given position.
java.awt.Color	getColor() Returns the color of this handle.
java.awt.Color	getFillColor() Returns the fill color of this handle.
java.awt.Color	getSecondaryColor() Returns the secondary color of this handle.
int	getSize() The handle size.
java.awt.Stroke	getStroke() Returns the stroke of this handle.
void	paint(JaxoGraphics2D g2, int x, int y) Paints an unmarked handle at (x, y).
void	paint(JaxoGraphics2D g2, int x, int y, boolean marked) Paints a handle at (x, y).
void	paint(JaxoGraphics2D g2, int x, int y, boolean marked, boolean secondary) Paint the handle at a given position.
abstract void	paint(JaxoGraphics2D g2, int x, int y, boolean marked, java.awt.Color handleColor) Paints the handle to the given graphics context.
void	paintSecondary(JaxoGraphics2D g2, int x, int y) Paints an unmarked handle in secondary color at (x, y).
void	paintSecondary(JaxoGraphics2D g2, int x, int y, boolean marked) Paints a handle in secondary color at (x, y).
void	setColor(java.awt.Color c) Sets the color of this handle.
void	setFillColor(java.awt.Color c) Sets the fill color of this fhandle.
void	setSecondaryColor(java.awt.Color c) Sets the secondary color of this handle.
void	setSize(int value) Sets the handle size.
void	setStroke(java.awt.Stroke newStroke) Sets the stroke of this handle.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.jaxodraw.object.JaxoHandle

contains

Field Detail

DEFAULT_SIZE

public static final int DEFAULT_SIZE

The default size of a handle.

See Also:

Constant Field Values

DEFAULT_STROKE

public static final java.awt.Stroke DEFAULT_STROKE

The default stroke for a handle.

DEFAULT_COLOR

public static final java.awt.Color DEFAULT_COLOR

The default color of a handle: JaxoColor.RED.

DEFAULT_SECONDARY_COLOR

public static final java.awt.Color DEFAULT_SECONDARY_COLOR

The default secondary color of a handle: JaxoColor.NAVY_BLUE.

DEFAULT_FILL_COLOR

public static final java.awt.Color DEFAULT_FILL_COLOR

The default fill color of a handle: JaxoColor.GRAYSCALE150.

Constructor Detail

AbstractJaxoHandle

public AbstractJaxoHandle()

Method Detail

getColor

public final java.awt.Color getColor()

Returns the color of this handle.

Returns:

The color of this handle.

setColor

public final void setColor(java.awt.Color c)

Sets the color of this handle.

Parameters:

c - The color of this handle.

getFillColor

public final java.awt.Color getFillColor()

Returns the fill color of this handle.

Returns:

The fill color of this handle.

setFillColor

public final void setFillColor(java.awt.Color c)

Sets the fill color of this fhandle.

Parameters:

c - The color to be set as fill color.

getSecondaryColor

public final java.awt.Color getSecondaryColor()

Returns the secondary color of this handle.

Returns:

The secondary color of this handle.

setSecondaryColor

public final void setSecondaryColor(java.awt.Color c)

Sets the secondary color of this handle.

Parameters:

c - The secondary color of this handle.

getSize

public final int getSize()

The handle size. The exact meaning of 'size' has to be defined by the implementation.

Returns:

The size of the handle.

setSize

public void setSize(int value)

Sets the handle size.

Parameters:

value - The new size.

getStroke

public final java.awt.Stroke getStroke()

Returns the stroke of this handle.

Returns:

The stroke of this handle.

setStroke

public final void setStroke(java.awt.Stroke newStroke)

Sets the stroke of this handle.

Parameters:

newStroke - The stroke property of thishandle.

paint

public void paint(JaxoGraphics2D g2,
                  int x,
                  int y)

Paints an unmarked handle at (x, y).

Parameters:

g2 - The graphics context to paint to.

x - The x position of the handle.

y - The y position of the handle.

paint

public void paint(JaxoGraphics2D g2,
                  int x,
                  int y,
                  boolean marked)

Paints a handle at (x, y).

Parameters:

g2 - The graphics context to paint to.

x - The x position of the handle.

y - The y position of the handle.

marked - True if the handle should be marked (selected).

paint

public void paint(JaxoGraphics2D g2,
                  int x,
                  int y,
                  boolean marked,
                  boolean secondary)

Paint the handle at a given position.

Specified by:

paint in interface JaxoHandle

Parameters:

g2 - The graphics context to paint to.

x - The x position of the handle.

y - The y position of the handle.

marked - True if the handle should be painted as marked. A marked handle is one that has been selected, eg for an edit operation.

secondary - True if this is a secondary handle. A secondary handle is one that cannot be selected in the current context.

paintSecondary

public void paintSecondary(JaxoGraphics2D g2,
                           int x,
                           int y)

Paints an unmarked handle in secondary color at (x, y).

Parameters:

g2 - The graphics context to paint to.

x - The x position of the handle.

y - The y position of the handle.

paintSecondary

public void paintSecondary(JaxoGraphics2D g2,
                           int x,
                           int y,
                           boolean marked)

Paints a handle in secondary color at (x, y).

Parameters:

g2 - The graphics context to paint to.

x - The x position of the handle.

y - The y position of the handle.

marked - True if the handle should be marked (selected).

paint

public abstract void paint(JaxoGraphics2D g2,
                           int x,
                           int y,
                           boolean marked,
                           java.awt.Color handleColor)

Paints the handle to the given graphics context.

Parameters:

g2 - The graphics context to paint to.

x - The x position of the handle.

y - The y position of the handle.

marked - True if the handle should be marked (selected).

handleColor - The color of the handle.

getBounds

public java.awt.Rectangle getBounds(int x,
                                    int y)

Return an enclosing Rectangle that completely contains this handle at the given position. This default implementation returns a square of length getSize() around the handle point.

Specified by:

getBounds in interface JaxoHandle

Parameters:

x - the x position of this handle.

y - the x position of this handle.

Returns:

the bounding box of this handle.