Module org.jfree.chart

Package org.jfree.chart.swing

Class DefaultSelectionZoomStrategy

java.lang.Object

org.jfree.chart.swing.DefaultSelectionZoomStrategy

All Implemented Interfaces:

Serializable, SelectionZoomStrategy

public class DefaultSelectionZoomStrategy
extends Object
implements SelectionZoomStrategy

This implementation can be extended to override default behavior.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_ZOOM_TRIGGER_DISTANCE	The minimum size required to perform a zoom on a rectangle
protected Point2D	zoomPoint	The zoom rectangle starting point (selected by the user with a mouse click).
protected Rectangle2D	zoomRectangle	The zoom rectangle (selected by the user with the mouse).

Constructor Summary

Constructors

Constructor	Description
DefaultSelectionZoomStrategy()

Method Summary

Modifier and Type	Method	Description
void	drawZoomRectangle(Graphics2D g2, boolean xor)	Draws zoom rectangle (if present).
boolean	getFillZoomRectangle()	Returns the flag that controls whether or not the zoom rectangle is filled when drawn.
Paint	getZoomFillPaint()	Returns the zoom rectangle fill paint.
Paint	getZoomOutlinePaint()	Returns the zoom rectangle outline paint.
Point2D	getZoomPoint()	The zoom rectangle starting point (selected by the user with a mouse click).
Rectangle2D	getZoomRectangle(boolean hZoom, boolean vZoom, Rectangle2D screenDataArea)	Creates and returns current zoom rectangle
int	getZoomTriggerDistance()	Returns the zoom trigger distance.
boolean	isActivated()	If controller currently tracking zoom rectangle
void	reset()	Removes zoom rectangle
void	setFillZoomRectangle(boolean flag)	A flag that controls how the zoom rectangle is drawn.
void	setZoomFillPaint(Paint paint)	Sets the zoom rectangle fill paint.
void	setZoomOutlinePaint(Paint paint)	Sets the zoom rectangle outline paint.
void	setZoomPoint(Point2D zoomPoint)
void	setZoomTriggerDistance(int distance)	Sets the zoom trigger distance.
void	updateZoomRectangleSelection(MouseEvent e, boolean hZoom, boolean vZoom, Rectangle2D scaledDataArea)	Updates zoom rectangle with new mouse position

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ZOOM_TRIGGER_DISTANCE

public static final int DEFAULT_ZOOM_TRIGGER_DISTANCE

The minimum size required to perform a zoom on a rectangle

See Also:

Constant Field Values

zoomPoint

protected Point2D zoomPoint

The zoom rectangle starting point (selected by the user with a mouse click). This is a point on the screen, not the chart (which may have been scaled up or down to fit the panel).

zoomRectangle

protected transient Rectangle2D zoomRectangle

The zoom rectangle (selected by the user with the mouse).

Constructor Detail

DefaultSelectionZoomStrategy

public DefaultSelectionZoomStrategy()

Method Detail

isActivated

public boolean isActivated()

Description copied from interface: SelectionZoomStrategy

If controller currently tracking zoom rectangle

Specified by:

isActivated in interface SelectionZoomStrategy

Returns:

true if zoomRectangle exists for this controller and false otherwise

getZoomPoint

public Point2D getZoomPoint()

Description copied from interface: SelectionZoomStrategy

The zoom rectangle starting point (selected by the user with a mouse click). This is a point on the screen, not the chart (which may have been scaled up or down to fit the panel).

Specified by:

getZoomPoint in interface SelectionZoomStrategy

setZoomPoint

public void setZoomPoint(Point2D zoomPoint)

Specified by:

setZoomPoint in interface SelectionZoomStrategy

setZoomTriggerDistance

public void setZoomTriggerDistance(int distance)

Description copied from interface: SelectionZoomStrategy

Sets the zoom trigger distance. This controls how far the mouse must move before a zoom action is triggered.

Specified by:

setZoomTriggerDistance in interface SelectionZoomStrategy

Parameters:

distance - the distance (in Java2D units).

getZoomTriggerDistance

public int getZoomTriggerDistance()

Description copied from interface: SelectionZoomStrategy

Returns the zoom trigger distance. This controls how far the mouse must move before a zoom action is triggered.

Specified by:

getZoomTriggerDistance in interface SelectionZoomStrategy

Returns:

The distance (in Java2D units).

getZoomOutlinePaint

public Paint getZoomOutlinePaint()

Description copied from interface: SelectionZoomStrategy

Returns the zoom rectangle outline paint.

Specified by:

getZoomOutlinePaint in interface SelectionZoomStrategy

Returns:

The zoom rectangle outline paint (never null).

See Also:

SelectionZoomStrategy.setZoomOutlinePaint(java.awt.Paint), SelectionZoomStrategy.setFillZoomRectangle(boolean)

setZoomOutlinePaint

public void setZoomOutlinePaint(Paint paint)

Description copied from interface: SelectionZoomStrategy

Sets the zoom rectangle outline paint.

Specified by:

setZoomOutlinePaint in interface SelectionZoomStrategy

Parameters:

paint - the paint (null not permitted).

See Also:

SelectionZoomStrategy.getZoomOutlinePaint(), SelectionZoomStrategy.getFillZoomRectangle()

getZoomFillPaint

public Paint getZoomFillPaint()

Description copied from interface: SelectionZoomStrategy

Returns the zoom rectangle fill paint.

Specified by:

getZoomFillPaint in interface SelectionZoomStrategy

Returns:

The zoom rectangle fill paint (never null).

See Also:

SelectionZoomStrategy.setZoomFillPaint(Paint), SelectionZoomStrategy.setFillZoomRectangle(boolean)

setZoomFillPaint

public void setZoomFillPaint(Paint paint)

Description copied from interface: SelectionZoomStrategy

Sets the zoom rectangle fill paint.

Specified by:

setZoomFillPaint in interface SelectionZoomStrategy

Parameters:

paint - the paint (null not permitted).

See Also:

SelectionZoomStrategy.getZoomFillPaint(), SelectionZoomStrategy.getFillZoomRectangle()

getFillZoomRectangle

public boolean getFillZoomRectangle()

Description copied from interface: SelectionZoomStrategy

Returns the flag that controls whether or not the zoom rectangle is filled when drawn.

Specified by:

getFillZoomRectangle in interface SelectionZoomStrategy

Returns:

A boolean.

setFillZoomRectangle

public void setFillZoomRectangle(boolean flag)

Description copied from interface: SelectionZoomStrategy

A flag that controls how the zoom rectangle is drawn.

Specified by:

setFillZoomRectangle in interface SelectionZoomStrategy

Parameters:

flag - true instructs to fill the rectangle on zoom, otherwise it will be outlined.

updateZoomRectangleSelection

public void updateZoomRectangleSelection(MouseEvent e,
                                         boolean hZoom,
                                         boolean vZoom,
                                         Rectangle2D scaledDataArea)

Description copied from interface: SelectionZoomStrategy

Updates zoom rectangle with new mouse position

Specified by:

updateZoomRectangleSelection in interface SelectionZoomStrategy

Parameters:

e - mouse event

hZoom - if horizontal zoom allowed

vZoom - if vertical zoom allowed

scaledDataArea - plot area in screen coordinates

getZoomRectangle

public Rectangle2D getZoomRectangle(boolean hZoom,
                                    boolean vZoom,
                                    Rectangle2D screenDataArea)

Description copied from interface: SelectionZoomStrategy

Creates and returns current zoom rectangle

Specified by:

getZoomRectangle in interface SelectionZoomStrategy

Parameters:

hZoom - if horizontal zoom acceptable

vZoom - if vertical zoom acceptable

screenDataArea - rectangle that describes plot on the screen

Returns:

rectangle in java2d screen coordinates selected by user

reset

public void reset()

Description copied from interface: SelectionZoomStrategy

Removes zoom rectangle

Specified by:

reset in interface SelectionZoomStrategy

drawZoomRectangle

public void drawZoomRectangle(Graphics2D g2,
                              boolean xor)

Description copied from interface: SelectionZoomStrategy

Draws zoom rectangle (if present). The drawing is performed in XOR mode, therefore when this method is called twice in a row, the second call will completely restore the state of the canvas.

Specified by:

drawZoomRectangle in interface SelectionZoomStrategy

Parameters:

g2 - the graphics device.

xor - use XOR for drawing?