Package com.amalgamasimulation.charts.visualsets

Class LineBarVisualSet<T>

java.lang.Object

com.amalgamasimulation.charts.visualsets.VisualSet<T>

com.amalgamasimulation.charts.visualsets.LineBarVisualSet<T>

Type Parameters:

T - visual set data elements type

All Implemented Interfaces:

IClipboardTextPropertyOwner<Double>, ILegendNodePropertiesOwner, IMinMaxValuePropertyOwner, IUpdatePolicyPropertyOwner, IAbstractChartVisualSet, ILineChartVisualSet

public class LineBarVisualSet<T>
extends VisualSet<T>
implements ILegendNodePropertiesOwner, IMinMaxValuePropertyOwner, IUpdatePolicyPropertyOwner, IClipboardTextPropertyOwner<Double>, ILineChartVisualSet

Visual set for drawing bars.

Can be drawn on AbstractLineChart.

Used to draw visuals corresponding to the statistical data. The bottom of the bar is always drawn at zero on the Y-axis and the top is at actual element value on the Y-axis.

Author:

Aleksey Kirillov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LineBarVisualSet.BarAlignment	Enum represents the bar alignment i.e.
class	LineBarVisualSet.LineBarVisualElement	Internal class that represents visual element for bar data element.

Nested classes/interfaces inherited from class com.amalgamasimulation.charts.visualsets.VisualSet

VisualSet.ContextMenuHandler<T>, VisualSet.UpdatePolicy, VisualSet.VisualElement

Field Summary

Fields

Modifier and Type	Field	Description
protected LineBarVisualSet.BarAlignment	barAlignment
protected Color	barColor
protected double	barWidth
protected Function<Double,String>	clipboardTextExtractor
protected Supplier<String>	legendTextProvider
protected Function<T,Double>	valueExtractor

Fields inherited from class com.amalgamasimulation.charts.visualsets.VisualSet

argumentExtractor, contentsToBeginArguments, contentsToEndArguments, contentsToVisualElements, contextMenuHandlers, dataElementsProvider, listeners, maxArgument, maxValueCache, minArgument, minValueCache, mouseEnterHandlers, mouseExitHandlers, mousePressedHandlers, mouseTransparent, name, needsUpdate, oldContentsList, tooltipTextExtractor, updatePolicy, visibilityChangeHandlers, visualElementsList

Constructor Summary

Constructors

Constructor	Description
LineBarVisualSet(String name, Supplier<List<T>> dataElementsProvider, Function<T,Double> argumentExtractor, Function<T,Double> valueExtractor)	Constructs a LineBarVisualSet with given name, data elements and arguments/value extractors, i.e.

Method Summary

Modifier and Type	Method	Description
LineBarVisualSet<T>	addContextMenuHandler(VisualSet.ContextMenuHandler<T> contextMenuHandler)	Adds the action to be executed every time a context menu for given data element is called.
LineBarVisualSet<T>	addMouseEnterHandler(BiConsumer<T,javafx.scene.input.MouseEvent> handler)	Adds the action to be executed every time mouse enters to any visual element borders.
LineBarVisualSet<T>	addMouseExitHandler(BiConsumer<T,javafx.scene.input.MouseEvent> handler)	Adds the action to be executed every time the mouse exits the previously entered element's bounds.
LineBarVisualSet<T>	addMousePressedHandler(BiConsumer<T,javafx.scene.input.MouseEvent> handler)	Adds the action to be executed every time a mouse button is pressed.
LineBarVisualSet<T>	addVisibilityChangeHandler(Consumer<VisibilityChangeDescriptor<? extends IAbstractChartVisualSet>> visibilityChangeHandler)	Adds the action to be executed every time the visibility of this VisualSet is changed.
LineBarVisualSet<T>.LineBarVisualElement	createVisualElement(T contents)	Creates a new instance of VisualSet<T>.VisualElement corresponding to the current VisualSet type.
LineBarVisualSet.BarAlignment	getBarAlignment()	Returns the current LineBarVisualSet.BarAlignment.
Color	getBarColor()	Returns the bar color of the plot.
double	getBarWidth()	Returns the bar width of the plot, in pixels.
String	getClipboardText(Double object)	Returns the text that will be copied to clipboard for the given object.
Color	getLegendColor()	Returns the color of the Legend's icon corresponding to this VisualSet
String	getLegendText()	Returns the Legend label text represents this visual set.
double	getMaxValue()	Returns the maximum Y-axis value for all data elements.
double	getMinValue()	Returns the minimum Y-axis value for all data elements.
double	getValue(double argument)	Returns the value of the given X-axis argument.
double	getValue(T element)	Returns the value of the given data element.
List<LineBarVisualSet<T>.LineBarVisualElement>	getVisualElements(boolean recalculationRequired)	Returns the list of visual elements corresponding to current data elements.
LineBarVisualSet<T>	setBarAlignment(LineBarVisualSet.BarAlignment barAlignment)	Sets the LineBarVisualSet.BarAlignment i.e.
LineBarVisualSet<T>	setBarColor(Color barColor)	Sets the fill color of the bar.
LineBarVisualSet<T>	setBarWidth(double barWidth)	Sets the width of the bar, in pixels.
LineBarVisualSet<T>	setClipboardText(Function<Double,String> clipboardTextExtractor)	Sets the conversion method from values of each plot data element into text that will be copied to clipboard.
LineBarVisualSet<T>	setLegendText(Supplier<String> legendTextProvider)	Sets the Legend label text represents this visual set.
LineBarVisualSet<T>	setMouseTransparent(boolean mouseTransparent)	Sets the value of the property mouseTransparent.
LineBarVisualSet<T>	setTooltipText(Function<T,String> tooltipTextExtractor)	Adds tooltip text to display when the mouse is hovered over a visual element representing given data element.
LineBarVisualSet<T>	setUpdatePolicy(VisualSet.UpdatePolicy updatePolicy)	Sets the new VisualSet.UpdatePolicy i.e.

Methods inherited from class com.amalgamasimulation.charts.visualsets.VisualSet

addVisualElement, addVisualElement, addVisualSetChangeHandler, clearDependencies, getArgument, getContents, getContextMenuHandlers, getDataElements, getInjectionIndex, getMaxArgument, getMinArgument, getMouseEnterHandlers, getMouseExitHandlers, getMousePressedHandlers, getName, getTooltipText, getUpdatePolicy, getVisibilityChangeHandlers, getVisibleVisualElementIndex, getVisibleVisualElementsCount, isMouseTransparent, isNeedsUpdate, recalculateVisualElements, removeContextMenuHandler, removeMouseEnterHandler, removeMouseExitHandler, removeMousePressedHandler, removeVisibilityChangeHandler, removeVisualElement, removeVisualSetChangeHandler, sortVisualElements, toString, update, updateMinMaxArgumentsValues

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amalgamasimulation.charts.visualsets.types.IAbstractChartVisualSet

addVisualSetChangeHandler, getContents, getMaxArgument, getMinArgument, getName, getUpdatePolicy, getVisibilityChangeHandlers, getVisibleVisualElementsCount, isMouseTransparent, removeVisibilityChangeHandler, removeVisualSetChangeHandler

Methods inherited from interface com.amalgamasimulation.charts.visualsets.IUpdatePolicyPropertyOwner

getUpdatePolicy

Field Details

barAlignment

protected LineBarVisualSet.BarAlignment barAlignment

barColor

protected Color barColor

barWidth

protected double barWidth

valueExtractor

protected Function<T,Double> valueExtractor

clipboardTextExtractor

protected Function<Double,String> clipboardTextExtractor

legendTextProvider

protected Supplier<String> legendTextProvider

Constructor Details

LineBarVisualSet

public LineBarVisualSet(String name,
 Supplier<List<T>> dataElementsProvider,
 Function<T,Double> argumentExtractor,
 Function<T,Double> valueExtractor)

Constructs a LineBarVisualSet with given name, data elements and arguments/value extractors, i.e. a functions that specifies the rule for extracting an argument/value from a data element.

Parameters:

name - visual set name is used to sort and name the visual sets on the chart

dataElementsProvider - data elements list provider. The provider is invalidated every time the chart is being redrawn

argumentExtractor - a function that specifies the rule for extracting an argument from a data element

valueExtractor - a function that specifies the rule for extracting a value from a data element

Method Details

setBarColor

public LineBarVisualSet<T> setBarColor(Color barColor)

Sets the fill color of the bar. Transparent and semi-transparent colors are allowed.

Parameters:

barColor - the bar fill color

Returns:

reference to this object

setBarWidth

public LineBarVisualSet<T> setBarWidth(double barWidth)

Sets the width of the bar, in pixels.

Parameters:

barWidth - the width of the bar, in pixels

Returns:

reference to this object

setBarAlignment

public LineBarVisualSet<T> setBarAlignment(LineBarVisualSet.BarAlignment barAlignment)

Sets the LineBarVisualSet.BarAlignment i.e. a way to draw bars relative to a grid line on the corresponding argument along the X-axis.

Parameters:

barAlignment - new way to draw bars relative to a grid line on the corresponding argument along the X-axis

Returns:

the current LineBarVisualSet.BarAlignment

getBarAlignment

public LineBarVisualSet.BarAlignment getBarAlignment()

Returns the current LineBarVisualSet.BarAlignment.

Returns:

the current LineBarVisualSet.BarAlignment

getBarColor

public Color getBarColor()

Returns the bar color of the plot.

Returns:

the bar color of the plot

getBarWidth

public double getBarWidth()

Returns the bar width of the plot, in pixels.

Returns:

the bar color of the plot

getValue

public double getValue(T element)

Returns the value of the given data element.

Parameters:

element - data element for which the value is being checked

Returns:

the value of the given data element

setClipboardText

public LineBarVisualSet<T> setClipboardText(Function<Double,String> clipboardTextExtractor)

Description copied from interface: IClipboardTextPropertyOwner

Sets the conversion method from values of each plot data element into text that will be copied to clipboard.

Specified by:

setClipboardText in interface IClipboardTextPropertyOwner<T>

Parameters:

clipboardTextExtractor - an extractor that converts the value of each plot data element into text that will be copied to the clipboard

Returns:

reference to this object

setTooltipText

public LineBarVisualSet<T> setTooltipText(Function<T,String> tooltipTextExtractor)

Description copied from class: VisualSet

Adds tooltip text to display when the mouse is hovered over a visual element representing given data element.

Specified by:

setTooltipText in class VisualSet<T>

Parameters:

tooltipTextExtractor - a function that specifies the rule for extracting a tooltip text from a data element

Returns:

reference to this object

getClipboardText

public String getClipboardText(Double object)

Description copied from interface: IClipboardTextPropertyOwner

Returns the text that will be copied to clipboard for the given object.

Specified by:

getClipboardText in interface IClipboardTextPropertyOwner<T>

Parameters:

object - object for which the clipboard text is being checked

Returns:

the text that will be copied to clipboard for the given object

addContextMenuHandler

public LineBarVisualSet<T> addContextMenuHandler(VisualSet.ContextMenuHandler<T> contextMenuHandler)

Description copied from class: VisualSet

Adds the action to be executed every time a context menu for given data element is called.

Overrides:

addContextMenuHandler in class VisualSet<T>

Parameters:

contextMenuHandler - context menu call action

Returns:

reference to this object

addMouseEnterHandler

public LineBarVisualSet<T> addMouseEnterHandler(BiConsumer<T,javafx.scene.input.MouseEvent> handler)

Description copied from class: VisualSet

Adds the action to be executed every time mouse enters to any visual element borders.

Overrides:

addMouseEnterHandler in class VisualSet<T>

Parameters:

handler - new mouse enter action

Returns:

reference to this object

addMouseExitHandler

public LineBarVisualSet<T> addMouseExitHandler(BiConsumer<T,javafx.scene.input.MouseEvent> handler)

Description copied from class: VisualSet

Adds the action to be executed every time the mouse exits the previously entered element's bounds.

Overrides:

addMouseExitHandler in class VisualSet<T>

Parameters:

handler - new mouse exit action

Returns:

reference to this object

addMousePressedHandler

public LineBarVisualSet<T> addMousePressedHandler(BiConsumer<T,javafx.scene.input.MouseEvent> handler)

Description copied from class: VisualSet

Adds the action to be executed every time a mouse button is pressed.

Overrides:

addMousePressedHandler in class VisualSet<T>

Parameters:

handler - new mouse button pressed action

Returns:

reference to this object

addVisibilityChangeHandler

public LineBarVisualSet<T> addVisibilityChangeHandler(Consumer<VisibilityChangeDescriptor<? extends IAbstractChartVisualSet>> visibilityChangeHandler)

Description copied from interface: IAbstractChartVisualSet

Adds the action to be executed every time the visibility of this VisualSet is changed.

Specified by:

addVisibilityChangeHandler in interface IAbstractChartVisualSet

Overrides:

addVisibilityChangeHandler in class VisualSet<T>

Parameters:

visibilityChangeHandler - visibility change action

Returns:

reference to this object

setMouseTransparent

public LineBarVisualSet<T> setMouseTransparent(boolean mouseTransparent)

Description copied from interface: IAbstractChartVisualSet

Sets the value of the property mouseTransparent. If true, this VisualSet is completely transparent to mouse events. When choosing target for mouse event, VisualSets with mouseTransparent set to true won't be taken into account.

Specified by:

setMouseTransparent in interface IAbstractChartVisualSet

Overrides:

setMouseTransparent in class VisualSet<T>

Parameters:

mouseTransparent - new value of property mouseTransparent

Returns:

reference to this object

setUpdatePolicy

public LineBarVisualSet<T> setUpdatePolicy(VisualSet.UpdatePolicy updatePolicy)

Description copied from interface: IAbstractChartVisualSet

Sets the new VisualSet.UpdatePolicy i.e. the VisualSet update control rule.

Specified by:

setUpdatePolicy in interface IAbstractChartVisualSet

Specified by:

setUpdatePolicy in interface IUpdatePolicyPropertyOwner

Overrides:

setUpdatePolicy in class VisualSet<T>

Parameters:

updatePolicy - new VisualSet.UpdatePolicy i.e. the VisualSet update control rule

Returns:

reference to this object

setLegendText

public LineBarVisualSet<T> setLegendText(Supplier<String> legendTextProvider)

Description copied from interface: ILegendNodePropertiesOwner

Sets the Legend label text represents this visual set.

Specified by:

setLegendText in interface ILegendNodePropertiesOwner

Parameters:

legendTextProvider - the Legend label text represents this visual set

Returns:

reference to this object

getLegendText

public String getLegendText()

Description copied from interface: ILegendNodePropertiesOwner

Returns the Legend label text represents this visual set.

Specified by:

getLegendText in interface ILegendNodePropertiesOwner

Returns:

the Legend label text represents this visual set

getValue

public double getValue(double argument)

Returns the value of the given X-axis argument.

Parameters:

argument - X-axis argument for which the value is being checked

Returns:

the value of the given X-axis argument

getVisualElements

public List<LineBarVisualSet<T>.LineBarVisualElement> getVisualElements(boolean recalculationRequired)

Description copied from interface: IAbstractChartVisualSet

Returns the list of visual elements corresponding to current data elements. Cannot be changed by the user.

Specified by:

getVisualElements in interface IAbstractChartVisualSet

Specified by:

getVisualElements in interface ILineChartVisualSet

Overrides:

getVisualElements in class VisualSet<T>

Parameters:

recalculationRequired - flag of the need to recalculate the visual elements

Returns:

the list of visual elements corresponding to current data elements

createVisualElement

public LineBarVisualSet<T>.LineBarVisualElement createVisualElement(T contents)

Description copied from class: VisualSet

Creates a new instance of VisualSet<T>.VisualElement corresponding to the current VisualSet type.

Specified by:

createVisualElement in class VisualSet<T>

Parameters:

contents - data element for which the VisualSet<T>.VisualElement is being checked

Returns:

a new instance of VisualSet<T>.VisualElement corresponding to the current VisualSet type

getMinValue

public double getMinValue()

Description copied from interface: IMinMaxValuePropertyOwner

Returns the minimum Y-axis value for all data elements. The minimum value is recalculated and cached at the moment the chart is redrawn. The method returns the value stored in the cache.

Specified by:

getMinValue in interface IMinMaxValuePropertyOwner

Returns:

the minimum Y-axis value for all data elements

See Also:

• Chart.redraw()

getMaxValue

public double getMaxValue()

Description copied from interface: IMinMaxValuePropertyOwner

Returns the maximum Y-axis value for all data elements. The maximum value is recalculated and cached at the moment the chart is redrawn. The method returns the value stored in the cache.

Specified by:

getMaxValue in interface IMinMaxValuePropertyOwner

Returns:

the maximum Y-axis value for all data elements

See Also:

• Chart.redraw()

getLegendColor

public Color getLegendColor()

Description copied from interface: ILegendNodePropertiesOwner

Returns the color of the Legend's icon corresponding to this VisualSet

Specified by:

getLegendColor in interface ILegendNodePropertiesOwner

Returns:

the color of the Legend's icon corresponding to this VisualSet