de.gsi.chart.plugins

Class Panner

java.lang.Object

de.gsi.chart.plugins.ChartPlugin

de.gsi.chart.plugins.Panner

public class Panner
extends ChartPlugin

Allows dragging the visible plot area along X and/or Y axis, changing the visible axis range.

Reacts on MouseEvent.DRAG_DETECTED event accepted by mouse filter.

Panner works properly only if both X and Y axis are instances of DefaultNumericAxis.

Author:

Grzegorz Kruk

Property Summary

Type	Property and Description
ObjectProperty<AxisMode>	axisMode The mode defining axis along which the pan operation is allowed.
ObjectProperty<Cursor>	dragCursor Mouse cursor to be used during drag operation.

Properties inherited from class de.gsi.chart.plugins.ChartPlugin

addButtonsToToolBarProperty, chartProperty

Field Summary

Fields

Modifier and Type	Field and Description
static Predicate<MouseEvent>	DEFAULT_MOUSE_FILTER Default pan mouse filter passing on left mouse button with control key down.

Constructor Summary

Constructors

Constructor and Description
Panner() Creates a new instance of Panner class with XY axisMode.
Panner(AxisMode panMode) Creates a new instance of Panner class.

Method Summary

Modifier and Type	Method and Description
ObjectProperty<AxisMode>	axisModeProperty() The mode defining axis along which the pan operation is allowed.
ObjectProperty<Cursor>	dragCursorProperty() Mouse cursor to be used during drag operation.
AxisMode	getAxisMode() Returns the value of the axisModeProperty().
Cursor	getDragCursor() Returns the value of the dragCursorProperty()
Predicate<MouseEvent>	getMouseFilter() Returns MouseEvent filter triggering pan operation.
void	setAxisMode(AxisMode mode) Sets the value of the axisModeProperty().
void	setDragCursor(Cursor cursor) Sets value of the dragCursorProperty().
void	setMouseFilter(Predicate<MouseEvent> mouseFilter) Sets the filter determining whether given MouseEvent triggered on event type should start the panning operation.

Methods inherited from class de.gsi.chart.plugins.ChartPlugin

addButtonsToToolBarProperty, chartProperty, getChart, getChartChildren, getLocationInPlotArea, isAddButtonsToToolBar, layoutChildren, registerInputEventHandler, setAddButtonsToToolBar, setChart, toDataPoint, toDisplayPoint

Methods inherited from class java.lang.Object

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

Property Detail

axisMode

public final ObjectProperty<AxisMode> axisModeProperty

The mode defining axis along which the pan operation is allowed. By default initialized to AxisMode.XY.

See Also:

getAxisMode(), setAxisMode(AxisMode)

dragCursor

public final ObjectProperty<Cursor> dragCursorProperty

Mouse cursor to be used during drag operation.

See Also:

getDragCursor(), setDragCursor(Cursor)

Field Detail

DEFAULT_MOUSE_FILTER

public static final Predicate<MouseEvent> DEFAULT_MOUSE_FILTER

Default pan mouse filter passing on left mouse button with control key down.

Constructor Detail

Panner

public Panner()

Creates a new instance of Panner class with XY axisMode.

Panner

public Panner(AxisMode panMode)

Creates a new instance of Panner class.

Parameters:

panMode - initial value for the axisMode property

Method Detail

axisModeProperty

public final ObjectProperty<AxisMode> axisModeProperty()

The mode defining axis along which the pan operation is allowed. By default initialized to AxisMode.XY.

See Also:

getAxisMode(), setAxisMode(AxisMode)

dragCursorProperty

public final ObjectProperty<Cursor> dragCursorProperty()

Mouse cursor to be used during drag operation.

See Also:

getDragCursor(), setDragCursor(Cursor)

getAxisMode

public final AxisMode getAxisMode()

Returns the value of the axisModeProperty().

Returns:

current mode

getDragCursor

public final Cursor getDragCursor()

Returns the value of the dragCursorProperty()

Returns:

the current cursor

getMouseFilter

public Predicate<MouseEvent> getMouseFilter()

Returns MouseEvent filter triggering pan operation.

Returns:

filter used to test whether given MouseEvent should start panning operation

See Also:

setMouseFilter(Predicate)

setAxisMode

public final void setAxisMode(AxisMode mode)

Sets the value of the axisModeProperty().

Parameters:

mode - the mode to be used

setDragCursor

public final void setDragCursor(Cursor cursor)

Sets value of the dragCursorProperty().

Parameters:

cursor - the cursor to be used by the plugin

setMouseFilter

public void setMouseFilter(Predicate<MouseEvent> mouseFilter)

Sets the filter determining whether given MouseEvent triggered on event type should start the panning operation.

By default it is initialized to DEFAULT_MOUSE_FILTER.

Parameters:

mouseFilter - the mouse filter to be used. Can be set to null to start panning on any DRAG_DETECTED event.