de.gsi.chart.axes.spi.format

Class AbstractFormatter

java.lang.Object

javafx.util.StringConverter<Number>

de.gsi.chart.axes.spi.format.AbstractFormatter

All Implemented Interfaces:

AxisLabelFormatter

Direct Known Subclasses:

DefaultFormatter, DefaultLogFormatter, DefaultTimeFormatter, SimpleFormatter

public abstract class AbstractFormatter
extends StringConverter<Number>
implements AxisLabelFormatter

Author:

rstein

Property Summary

Type	Property and Description
DoubleProperty	schmittTriggerThreshold sets the min/max threshold when to change from one formatter domain to the other
ObjectProperty<TickUnitSupplier>	tickUnitSupplier Strategy to compute major tick unit when auto-range is on or when axis bounds change.

Field Summary

Fields

Modifier and Type	Field and Description
protected FormatterLabelCache	labelCache
protected double	localSchmidtTriggerThreshold
protected List<Double>	majorTickMarksCopy
protected double	rangeMax
protected double	rangeMin
protected DoubleProperty	schmittTriggerThreshold
protected double	unitScaling

Constructor Summary

Constructors

Constructor and Description
AbstractFormatter()
AbstractFormatter(Axis axis) Construct a DefaultFormatter for the given NumberAxis

Method Summary

Modifier and Type	Method and Description
protected double	getLogRange()
protected double	getRange()
TickUnitSupplier	getTickUnitSupplier() Returns the value of the tickUnitSupplierProperty().
protected abstract void	rangeUpdated()
DoubleProperty	schmittTriggerThresholdProperty() sets the min/max threshold when to change from one formatter domain to the other
void	setTickUnitSupplier(TickUnitSupplier supplier) Sets the value of the tickUnitSupplierProperty().
ObjectProperty<TickUnitSupplier>	tickUnitSupplierProperty() Strategy to compute major tick unit when auto-range is on or when axis bounds change.
void	updateFormatter(List<Double> newMajorTickMarks, double unitScaling) Called just before new TickMarks are computed

Methods inherited from class javafx.util.StringConverter

fromString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.gsi.chart.axes.AxisLabelFormatter

fromString, toString

Property Detail

schmittTriggerThreshold

public DoubleProperty schmittTriggerThresholdProperty

sets the min/max threshold when to change from one formatter domain to the other

tickUnitSupplier

public ObjectProperty<TickUnitSupplier> tickUnitSupplierProperty

Strategy to compute major tick unit when auto-range is on or when axis bounds change. By default initialised to DefaultTickUnitSupplier.

See TickUnitSupplier for more information about the expected behaviour of the strategy.

Specified by:

tickUnitSupplierProperty in interface AxisLabelFormatter

See Also:

getTickUnitSupplier(), setTickUnitSupplier(TickUnitSupplier)

Field Detail

labelCache

protected FormatterLabelCache labelCache

majorTickMarksCopy

protected List<Double> majorTickMarksCopy

unitScaling

protected double unitScaling

rangeMin

protected double rangeMin

rangeMax

protected double rangeMax

localSchmidtTriggerThreshold

protected double localSchmidtTriggerThreshold

schmittTriggerThreshold

protected DoubleProperty schmittTriggerThreshold

Constructor Detail

AbstractFormatter

public AbstractFormatter()

AbstractFormatter

public AbstractFormatter(Axis axis)

Construct a DefaultFormatter for the given NumberAxis

Parameters:

axis - The axis to format tick marks for

Method Detail

getLogRange

protected double getLogRange()

getRange

protected double getRange()

getTickUnitSupplier

public TickUnitSupplier getTickUnitSupplier()

Returns the value of the tickUnitSupplierProperty().

Specified by:

getTickUnitSupplier in interface AxisLabelFormatter

Returns:

the TickUnitSupplier

rangeUpdated

protected abstract void rangeUpdated()

schmittTriggerThresholdProperty

public DoubleProperty schmittTriggerThresholdProperty()

sets the min/max threshold when to change from one formatter domain to the other

setTickUnitSupplier

public void setTickUnitSupplier(TickUnitSupplier supplier)

Sets the value of the tickUnitSupplierProperty().

Specified by:

setTickUnitSupplier in interface AxisLabelFormatter

Parameters:

supplier - the tick unit supplier. If null, the default one will be used

tickUnitSupplierProperty

public ObjectProperty<TickUnitSupplier> tickUnitSupplierProperty()

Strategy to compute major tick unit when auto-range is on or when axis bounds change. By default initialised to DefaultTickUnitSupplier.

See TickUnitSupplier for more information about the expected behaviour of the strategy.

Specified by:

tickUnitSupplierProperty in interface AxisLabelFormatter

See Also:

getTickUnitSupplier(), setTickUnitSupplier(TickUnitSupplier)

updateFormatter

public void updateFormatter(List<Double> newMajorTickMarks,
                            double unitScaling)

Description copied from interface: AxisLabelFormatter

Called just before new TickMarks are computed

Specified by:

updateFormatter in interface AxisLabelFormatter

Parameters:

newMajorTickMarks - for which the labels should be computed

unitScaling - scaling applied to the raw data set units