de.gsi.chart.plugins

Class AbstractDataFormattingPlugin

java.lang.Object

de.gsi.chart.plugins.ChartPlugin

de.gsi.chart.plugins.AbstractDataFormattingPlugin

Direct Known Subclasses:

CrosshairIndicator, DataPointTooltip

public abstract class AbstractDataFormattingPlugin
extends ChartPlugin

An abstract plugin with associated formatters for X and Y value of the data. For details see formatData(de.gsi.chart.Chart, de.gsi.dataset.spi.utils.Tuple<java.lang.Number, java.lang.Number>).

Author:

Grzegorz Kruk, rstein

Property Summary

Type	Property and Description
ObjectProperty<StringConverter<Number>>	xValueFormatter StringConverter used to format X values.
ObjectProperty<StringConverter<Number>>	yValueFormatter StringConverter used to format Y values.

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

addButtonsToToolBarProperty, chartProperty

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDataFormattingPlugin() Creates a new instance of AbstractDataIndicator.

Method Summary

Modifier and Type	Method and Description
protected String	formatData(Chart chart, Tuple<Number,Number> data) Formats the data to be displayed by this plugin.
StringConverter<Number>	getXValueFormatter() Returns the value of the xValueFormatterProperty().
StringConverter<Number>	getYValueFormatter() Returns the value of the xValueFormatterProperty().
void	setXValueFormatter(StringConverter<Number> formatter) Sets the value of the xValueFormatterProperty().
void	setYValueFormatter(StringConverter<Number> formatter) Sets the value of the xValueFormatterProperty().
ObjectProperty<StringConverter<Number>>	xValueFormatterProperty() StringConverter used to format X values.
ObjectProperty<StringConverter<Number>>	yValueFormatterProperty() StringConverter used to format Y values.

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

xValueFormatter

public final ObjectProperty<StringConverter<Number>> xValueFormatterProperty

StringConverter used to format X values. If null a default will be used.

See Also:

getXValueFormatter(), setXValueFormatter(StringConverter)

yValueFormatter

public final ObjectProperty<StringConverter<Number>> yValueFormatterProperty

StringConverter used to format Y values. If null a default will be used.

See Also:

getYValueFormatter(), setYValueFormatter(StringConverter)

Constructor Detail

AbstractDataFormattingPlugin

protected AbstractDataFormattingPlugin()

Creates a new instance of AbstractDataIndicator.

Method Detail

formatData

protected String formatData(Chart chart,
                            Tuple<Number,Number> data)

Formats the data to be displayed by this plugin. Uses the specified xValueFormatterProperty() and yValueFormatterProperty() to obtain the corresponding formatters. If it is null and the axis is a ValueAxis - the method will use tick label formatter. If this one is also not initialized - a default formatter is used.

Can be overridden to modify formatting of the data.

Parameters:

chart - reference to chart

data - the data point to be formatted

Returns:

formatted data

getXValueFormatter

public final StringConverter<Number> getXValueFormatter()

Returns the value of the xValueFormatterProperty().

Returns:

the X value formatter

getYValueFormatter

public final StringConverter<Number> getYValueFormatter()

Returns the value of the xValueFormatterProperty().

Returns:

the X value formatter

setXValueFormatter

public final void setXValueFormatter(StringConverter<Number> formatter)

Sets the value of the xValueFormatterProperty().

Parameters:

formatter - the X value formatter

setYValueFormatter

public final void setYValueFormatter(StringConverter<Number> formatter)

Sets the value of the xValueFormatterProperty().

Parameters:

formatter - the X value formatter

xValueFormatterProperty

public final ObjectProperty<StringConverter<Number>> xValueFormatterProperty()

StringConverter used to format X values. If null a default will be used.

See Also:

getXValueFormatter(), setXValueFormatter(StringConverter)

yValueFormatterProperty

public final ObjectProperty<StringConverter<Number>> yValueFormatterProperty()

StringConverter used to format Y values. If null a default will be used.

See Also:

getYValueFormatter(), setYValueFormatter(StringConverter)