de.gsi.chart.plugins

Class EditAxis

java.lang.Object

de.gsi.chart.plugins.ChartPlugin

de.gsi.chart.plugins.EditAxis

public class EditAxis
extends ChartPlugin

Allows editing of the chart axes (auto range, minimum/maximum range, etc.)

Author:

rstein

Property Summary

Type	Property and Description
BooleanProperty	animated When true zooming will be animated.
ObjectProperty<AxisMode>	axisMode The mode defining axis along which the zoom can be performed.
ObjectProperty<Duration>	zoomDuration Duration of the animated fade (in and out).

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

addButtonsToToolBarProperty, chartProperty

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_PREFERRED_HEIGHT
protected static int	DEFAULT_PREFERRED_WIDTH
protected static int	DEFAULT_SHUTDOWN_PERIOD
protected static int	DEFAULT_UPDATE_PERIOD
static String	STYLE_CLASS_AXIS_EDITOR

Constructor Summary

Constructors

Constructor and Description
EditAxis() Creates a new instance of EditAxis with animation disabled and with editMode initialized to AxisMode.XY.
EditAxis(AxisMode editMode) Creates a new instance of EditAxis with animation disabled
EditAxis(AxisMode editMode, boolean animated) Creates a new instance of EditAxis.
EditAxis(boolean animated) Creates a new instance of EditAxis with editMode initialized to AxisMode.XY.

Method Summary

Modifier and Type	Method and Description
BooleanProperty	animatedProperty() When true zooming will be animated.
ObjectProperty<AxisMode>	axisModeProperty() The mode defining axis along which the zoom can be performed.
AxisMode	getAxisMode() Returns the value of the axisModeProperty().
Duration	getZoomDuration() Returns the value of the zoomDurationProperty().
boolean	isAnimated() Returns the value of the animatedProperty().
void	setAnimated(boolean value) Sets the value of the animatedProperty().
void	setAxisMode(AxisMode mode) Sets the value of the axisModeProperty().
void	setZoomDuration(Duration duration) Sets the value of the zoomDurationProperty().
ObjectProperty<Duration>	zoomDurationProperty() Duration of the animated fade (in and out).

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

animated

public final BooleanProperty animatedProperty

When true zooming will be animated. By default it's false.

See Also:

isAnimated(), setAnimated(boolean)

axisMode

public final ObjectProperty<AxisMode> axisModeProperty

The mode defining axis along which the zoom can be performed. By default initialized to AxisMode.XY.

See Also:

getAxisMode(), setAxisMode(AxisMode)

zoomDuration

public final ObjectProperty<Duration> zoomDurationProperty

Duration of the animated fade (in and out). Used only when animatedProperty() is set to true. By default initialized to 500ms.

See Also:

getZoomDuration(), setZoomDuration(Duration)

Field Detail

STYLE_CLASS_AXIS_EDITOR

public static final String STYLE_CLASS_AXIS_EDITOR

See Also:

Constant Field Values

DEFAULT_SHUTDOWN_PERIOD

protected static final int DEFAULT_SHUTDOWN_PERIOD

See Also:

Constant Field Values

DEFAULT_UPDATE_PERIOD

protected static final int DEFAULT_UPDATE_PERIOD

See Also:

Constant Field Values

DEFAULT_PREFERRED_WIDTH

protected static final int DEFAULT_PREFERRED_WIDTH

See Also:

Constant Field Values

DEFAULT_PREFERRED_HEIGHT

protected static final int DEFAULT_PREFERRED_HEIGHT

See Also:

Constant Field Values

Constructor Detail

EditAxis

public EditAxis()

Creates a new instance of EditAxis with animation disabled and with editMode initialized to AxisMode.XY.

EditAxis

public EditAxis(AxisMode editMode)

Creates a new instance of EditAxis with animation disabled

Parameters:

editMode - initial value of editMode property

EditAxis

public EditAxis(AxisMode editMode,
                boolean animated)

Creates a new instance of EditAxis.

Parameters:

editMode - initial value of axisMode property

animated - initial value of animated property

EditAxis

public EditAxis(boolean animated)

Creates a new instance of EditAxis with editMode initialized to AxisMode.XY.

Parameters:

animated - initial value of animated property

Method Detail

animatedProperty

public final BooleanProperty animatedProperty()

When true zooming will be animated. By default it's false.

See Also:

isAnimated(), setAnimated(boolean)

axisModeProperty

public final ObjectProperty<AxisMode> axisModeProperty()

The mode defining axis along which the zoom can be performed. By default initialized to AxisMode.XY.

See Also:

getAxisMode(), setAxisMode(AxisMode)

getAxisMode

public final AxisMode getAxisMode()

Returns the value of the axisModeProperty().

Returns:

current mode

getZoomDuration

public final Duration getZoomDuration()

Returns the value of the zoomDurationProperty().

Returns:

the current zoom duration

isAnimated

public final boolean isAnimated()

Returns the value of the animatedProperty().

Returns:

true if zoom is animated, false otherwise

See Also:

getZoomDuration()

setAnimated

public final void setAnimated(boolean value)

Sets the value of the animatedProperty().

Parameters:

value - if true zoom will be animated

See Also:

setZoomDuration(Duration)

setAxisMode

public final void setAxisMode(AxisMode mode)

Sets the value of the axisModeProperty().

Parameters:

mode - the mode to be used

setZoomDuration

public final void setZoomDuration(Duration duration)

Sets the value of the zoomDurationProperty().

Parameters:

duration - duration of the zoom

zoomDurationProperty

public final ObjectProperty<Duration> zoomDurationProperty()

Duration of the animated fade (in and out). Used only when animatedProperty() is set to true. By default initialized to 500ms.

See Also:

getZoomDuration(), setZoomDuration(Duration)