Package com.amalgamasimulation.charts.axes

Class BarChartNumericYAxis

java.lang.Object

com.amalgamasimulation.charts.axes.AbstractAxis<Number>

com.amalgamasimulation.charts.axes.BarChartNumericYAxis

All Implemented Interfaces:

IAxisTitlePropertyOwner<Number>, IGetDisplayedRangePropertyOwner, IMaxValuePropertyOwner, INumericStylePropertyOwner, IValueInRangePropertyOwner

public class BarChartNumericYAxis
extends AbstractAxis<Number>
implements IMaxValuePropertyOwner, IGetDisplayedRangePropertyOwner, INumericStylePropertyOwner, IValueInRangePropertyOwner, IAxisTitlePropertyOwner<Number>

Class that represents an Y-axis drawn on a BarChart or HistogramChart area. It holds properties for axis ticks and labels along the axis. This axis does allow ranging operations.

Author:

Aleksey Kirillov

Field Summary

Fields

Modifier and Type	Field	Description
protected com.amalgamasimulation.charts.internals.charts.AbstractBarChartInternal	chartInternal
protected com.amalgamasimulation.charts.internals.axes.NumericYAxisInternal	yAxisInternal

Constructor Summary

Constructors

Constructor	Description
BarChartNumericYAxis(com.amalgamasimulation.charts.internals.charts.AbstractBarChartInternal chartInternal, com.amalgamasimulation.charts.internals.axes.NumericYAxisInternal yAxisInternal)	Constructs a BarChartInternal Y-axis with given NumericYAxisInternal

Method Summary

Modifier and Type	Method	Description
BarChartNumericYAxis	addDisplayedRangeChangeHandler(BiConsumer<Double,Double> handler)	Adds the action to be executed every time the displayed range changed.
BarChartNumericYAxis	clearDisplayedRangeChangeHandler()	Clear all the displayed range changed actions.
protected com.amalgamasimulation.charts.internals.axes.NumericYAxisInternal	getAxisInternal()
protected com.amalgamasimulation.charts.internals.charts.AbstractBarChartInternal	getChartInternal()
Pair<Double,Double>	getDisplayedRange()	Returns the currently displayed values range of axis.
double	getMaxValue()	Returns the maximum possible value that can be displayed on axis.
String	getTitle()	Returns the title of this axis, or null if title has not been specified.
javafx.scene.paint.Color	getTitleColor()	Returns the color of this axis title.
javafx.scene.text.Font	getTitleFont()	Returns the font of this axis title.
int	getTitleFontSize()	Returns the font size of this axis title.
boolean	isTitleVisible()	Checks whether this axis title should be drawn.
boolean	isValueDisplayed(double value)	Checks whether the value is displayed on this axis.
BarChartNumericYAxis	removeDisplayedRangeChangeHandler(BiConsumer<Double,Double> handler)	Removes the displayed range changed action.
BarChartNumericYAxis	setLabelsFormat(Function<Double,String> format)	Sets the formatter to axis labels, i.e.
BarChartNumericYAxis	setMaxValue(double value)	Sets the maximum possible value that can be displayed on axis.
BarChartNumericYAxis	setNumericStyle(AxisNumericStyle numericTicksAndLabels)	Sets the AxisNumericStyle that specifies the formatting and ticks details for axis in case it shows numeric values.
BarChartNumericYAxis	setTitle(String title)	Sets the new title to this axis.
BarChartNumericYAxis	setTitleColor(Color color)	Sets the new color to this axis title.
BarChartNumericYAxis	setTitleColor(javafx.scene.paint.Color color)	Sets the new color to this axis title.
BarChartNumericYAxis	setTitleFont(javafx.scene.text.Font font)	Sets the new font to this axis title.
BarChartNumericYAxis	setTitleFontSize(int fontSize)	Sets the new font size to this axis title.
BarChartNumericYAxis	setTitleVisible(boolean visible)	Specifies whether this axis title should be drawn.

Methods inherited from class com.amalgamasimulation.charts.axes.AbstractAxis

getLabelsColor, getLabelsFont, getLabelsFontSize, setGridLinesColor, setGridLinesColor, setGridLinesVisible, setGridLinesWidth, setLabelsColor, setLabelsColor, setLabelsFont, setLabelsFontSize

Methods inherited from class java.lang.Object

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

Field Details

chartInternal

protected com.amalgamasimulation.charts.internals.charts.AbstractBarChartInternal chartInternal

yAxisInternal

protected com.amalgamasimulation.charts.internals.axes.NumericYAxisInternal yAxisInternal

Constructor Details

BarChartNumericYAxis

public BarChartNumericYAxis(com.amalgamasimulation.charts.internals.charts.AbstractBarChartInternal chartInternal,
 com.amalgamasimulation.charts.internals.axes.NumericYAxisInternal yAxisInternal)

Constructs a BarChartInternal Y-axis with given NumericYAxisInternal

Parameters:

chartInternal - BarChartInternal which is the owner of this object

yAxisInternal - NumericYAxisInternal which is the internal axis logic aggregator

Method Details

getChartInternal

protected com.amalgamasimulation.charts.internals.charts.AbstractBarChartInternal getChartInternal()

Specified by:

getChartInternal in class AbstractAxis<Number>

getAxisInternal

protected com.amalgamasimulation.charts.internals.axes.NumericYAxisInternal getAxisInternal()

Specified by:

getAxisInternal in class AbstractAxis<Number>

setMaxValue

public BarChartNumericYAxis setMaxValue(double value)

Description copied from interface: IMaxValuePropertyOwner

Sets the maximum possible value that can be displayed on axis. The displayed range of axis cannot include values more than the specified value. Scrolling of axis is limited accordingly. Redraws this axis and it's parent chart.

Specified by:

setMaxValue in interface IMaxValuePropertyOwner

Parameters:

value - maximum possible value that can be displayed on axis

Returns:

reference to this object

getMaxValue

public double getMaxValue()

Description copied from interface: IMaxValuePropertyOwner

Returns the maximum possible value that can be displayed on axis.

Specified by:

getMaxValue in interface IMaxValuePropertyOwner

Returns:

the maximum possible value that can be displayed on axis

isValueDisplayed

public boolean isValueDisplayed(double value)

Description copied from interface: IValueInRangePropertyOwner

Checks whether the value is displayed on this axis.

Specified by:

isValueDisplayed in interface IValueInRangePropertyOwner

Parameters:

value - value to check

Returns:

true if the value is displayed on this axis, false otherwise

getDisplayedRange

public Pair<Double,Double> getDisplayedRange()

Description copied from interface: IGetDisplayedRangePropertyOwner

Returns the currently displayed values range of axis.

Specified by:

getDisplayedRange in interface IGetDisplayedRangePropertyOwner

Returns:

the pair contains minimum and maximum values of the currently displayed range

setNumericStyle

public BarChartNumericYAxis setNumericStyle(AxisNumericStyle numericTicksAndLabels)

Description copied from interface: INumericStylePropertyOwner

Sets the AxisNumericStyle that specifies the formatting and ticks details for axis in case it shows numeric values.

Specified by:

setNumericStyle in interface INumericStylePropertyOwner

Parameters:

numericTicksAndLabels - new AxisNumericStyle that specifies the formatting and ticks details for axis in case it shows numeric values

Returns:

reference to this object

addDisplayedRangeChangeHandler

public BarChartNumericYAxis addDisplayedRangeChangeHandler(BiConsumer<Double,Double> handler)

Description copied from interface: IGetDisplayedRangePropertyOwner

Adds the action to be executed every time the displayed range changed.

Specified by:

addDisplayedRangeChangeHandler in interface IGetDisplayedRangePropertyOwner

Parameters:

handler - new displayed range changed action

Returns:

reference to this object

removeDisplayedRangeChangeHandler

public BarChartNumericYAxis removeDisplayedRangeChangeHandler(BiConsumer<Double,Double> handler)

Description copied from interface: IGetDisplayedRangePropertyOwner

Removes the displayed range changed action.

Specified by:

removeDisplayedRangeChangeHandler in interface IGetDisplayedRangePropertyOwner

Parameters:

handler - removed displayed range changed action

Returns:

reference to this object

clearDisplayedRangeChangeHandler

public BarChartNumericYAxis clearDisplayedRangeChangeHandler()

Description copied from interface: IGetDisplayedRangePropertyOwner

Clear all the displayed range changed actions.

Specified by:

clearDisplayedRangeChangeHandler in interface IGetDisplayedRangePropertyOwner

Returns:

reference to this object

setLabelsFormat

public BarChartNumericYAxis setLabelsFormat(Function<Double,String> format)

Description copied from interface: INumericStylePropertyOwner

Sets the formatter to axis labels, i.e. the function that takes a Double value and produces a String that should be drawn to represent this value.

Specified by:

setLabelsFormat in interface INumericStylePropertyOwner

Parameters:

format - new axis labels formatter

Returns:

reference to this object

setTitle

public BarChartNumericYAxis setTitle(String title)

Description copied from interface: IAxisTitlePropertyOwner

Sets the new title to this axis. Redraws this axis and it's parent chart if title is changed.

Specified by:

setTitle in interface IAxisTitlePropertyOwner<Number>

Parameters:

title - new axis title

Returns:

reference to this object

See Also:

• Chart.redraw()

setTitleVisible

public BarChartNumericYAxis setTitleVisible(boolean visible)

Description copied from interface: IAxisTitlePropertyOwner

Specifies whether this axis title should be drawn. Redraws this axis and it's parent chart if visibility is changed.

Specified by:

setTitleVisible in interface IAxisTitlePropertyOwner<Number>

Parameters:

visible - new axis title visibility

Returns:

reference to this object

See Also:

• Chart.redraw()

setTitleFont

public BarChartNumericYAxis setTitleFont(javafx.scene.text.Font font)

Description copied from interface: IAxisTitlePropertyOwner

Sets the new font to this axis title. Redraws this axis and it's parent chart if font is changed.

Specified by:

setTitleFont in interface IAxisTitlePropertyOwner<Number>

Parameters:

font - new axis title font

Returns:

reference to this object

See Also:

• Chart.redraw()

setTitleFontSize

public BarChartNumericYAxis setTitleFontSize(int fontSize)

Description copied from interface: IAxisTitlePropertyOwner

Sets the new font size to this axis title. Redraws this axis and it's parent chart if font size is changed.

Specified by:

setTitleFontSize in interface IAxisTitlePropertyOwner<Number>

Parameters:

fontSize - new axis title font size

Returns:

reference to this object

See Also:

• Chart.redraw()

setTitleColor

public BarChartNumericYAxis setTitleColor(Color color)

Description copied from interface: IAxisTitlePropertyOwner

Sets the new color to this axis title. Redraws this axis and it's parent chart if color is changed.

Specified by:

setTitleColor in interface IAxisTitlePropertyOwner<Number>

Parameters:

color - new axis title color

Returns:

reference to this object

See Also:

• Chart.redraw()

setTitleColor

public BarChartNumericYAxis setTitleColor(javafx.scene.paint.Color color)

Description copied from interface: IAxisTitlePropertyOwner

Sets the new color to this axis title. Redraws this axis and it's parent chart if color is changed.

Specified by:

setTitleColor in interface IAxisTitlePropertyOwner<Number>

Parameters:

color - new axis title color

Returns:

reference to this object

See Also:

• Chart.redraw()

getTitleColor

public javafx.scene.paint.Color getTitleColor()

Description copied from interface: IAxisTitlePropertyOwner

Returns the color of this axis title.

Specified by:

getTitleColor in interface IAxisTitlePropertyOwner<Number>

Returns:

the color of this axis title

getTitle

public String getTitle()

Description copied from interface: IAxisTitlePropertyOwner

Returns the title of this axis, or null if title has not been specified.

Specified by:

getTitle in interface IAxisTitlePropertyOwner<Number>

Returns:

the title of this axis, or null if title has not been specified

isTitleVisible

public boolean isTitleVisible()

Description copied from interface: IAxisTitlePropertyOwner

Checks whether this axis title should be drawn.

Specified by:

isTitleVisible in interface IAxisTitlePropertyOwner<Number>

Returns:

true if this axis title should be drawn, false otherwise

getTitleFont

public javafx.scene.text.Font getTitleFont()

Description copied from interface: IAxisTitlePropertyOwner

Returns the font of this axis title.

Specified by:

getTitleFont in interface IAxisTitlePropertyOwner<Number>

Returns:

axis title font

getTitleFontSize

public int getTitleFontSize()

Description copied from interface: IAxisTitlePropertyOwner

Returns the font size of this axis title.

Specified by:

getTitleFontSize in interface IAxisTitlePropertyOwner<Number>

Returns:

the font size of this axis title