Package com.amalgamasimulation.charts.visualsets

Class RangeRegionVisualSet<T>

java.lang.Object

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

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

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

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

Type Parameters:

T - visual set data elements type

All Implemented Interfaces:

IBeginEndArgumentPropertyOwner<T>, IClipboardTextPropertyOwner<Pair<Double,Double>>, IMinMaxValuePropertyOwner, IUpdatePolicyPropertyOwner, IAbstractChartVisualSet, ILineChartVisualSet

public class RangeRegionVisualSet<T>
extends AbstractRegionVisualSet<T>
implements ILineChartVisualSet, IMinMaxValuePropertyOwner, IClipboardTextPropertyOwner<Pair<Double,Double>>

Visual set for drawing regions with limited ranges along Y-axis.

Can be drawn on AbstractLineChart.

Each region is defined by a pair of begin and end values on the X-axis and fills the full height of the chart's content area on the Y-axis.

Author:

Aleksey Kirillov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	RangeRegionVisualSet.RangeRegionVisualElement	Internal class that represents visual element for region data element.

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

AbstractRegionVisualSet.AbstractRegionVisualElement

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

LabeledVisualSet.LabeledVisualElement

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

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

Field Summary

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

labelColorExtractors, labelFontSizeExtractors, labelTextExtractors, labelTextSidesList

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
RangeRegionVisualSet(String name, Supplier<List<T>> dataElementsProvider, Function<T,Double> beginArgumentExtractor, Function<T,Double> endArgumentExtractor)

Method Summary

Modifier and Type	Method	Description
RangeRegionVisualSet<T>	addContextMenuHandler(VisualSet.ContextMenuHandler<T> contextMenuHandler)	Adds the action to be executed every time a context menu for given data element is called.
RangeRegionVisualSet<T>	addMouseEnterHandler(BiConsumer<T,javafx.scene.input.MouseEvent> handler)	Adds the action to be executed every time mouse enters to any visual element borders.
RangeRegionVisualSet<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.
RangeRegionVisualSet<T>	addMousePressedHandler(BiConsumer<T,javafx.scene.input.MouseEvent> handler)	Adds the action to be executed every time a mouse button is pressed.
RangeRegionVisualSet<T>	addVisibilityChangeHandler(Consumer<VisibilityChangeDescriptor<? extends IAbstractChartVisualSet>> visibilityChangeHandler)	Adds the action to be executed every time the visibility of this VisualSet is changed.
RangeRegionVisualSet<T>.RangeRegionVisualElement	createVisualElement(T contents)	Creates a new instance of VisualSet<T>.VisualElement corresponding to the current VisualSet type.
String	getClipboardText(Pair<Double,Double> object)	Returns the text that will be copied to clipboard for the given object.
double	getMaxValue()	Returns the maximum Y-axis value for all data elements.
double	getMaxValue(T element)	Returns the Y-axis max value for given data element.
double	getMinValue()	Returns the minimum Y-axis value for all data elements.
double	getMinValue(T element)	Returns the Y-axis min value for given data element.
List<RangeRegionVisualSet<T>.RangeRegionVisualElement>	getVisualElements(boolean recalculationRequired)	Returns the list of visual elements corresponding to current data elements.
RangeRegionVisualSet<T>	setBackgroundColor(Function<T,Color> backgroundColorExtractor)	Sets the background color for each data element.
RangeRegionVisualSet<T>	setBorderColor(Function<T,Color> borderColorExtractor)	Sets the border color for each data element.
RangeRegionVisualSet<T>	setBorderWidth(Function<T,Double> borderWidthExtractor)	Sets the border width in pixels for each data element.
RangeRegionVisualSet<T>	setClipboardText(Function<Pair<Double,Double>,String> clipboardTextExtractor)	Sets the conversion method from values of each plot data element into text that will be copied to clipboard.
RangeRegionVisualSet<T>	setLabelText(LabelSide labelSide, Function<? extends T,String> labelTextExtractor, Function<? extends T,Double> labelTextSizeExtractor, Function<? extends T,Color> labelTextColorExtractor)	Sets the labels of the rectangles representing plot data elements.
RangeRegionVisualSet<T>	setMaxValue(Function<T,Double> maxValueExtractor)	Sets the Y-axis max value for each data element.
RangeRegionVisualSet<T>	setMinValue(Function<T,Double> minValueExtractor)	Sets the Y-axis min value for each data element.
RangeRegionVisualSet<T>	setMouseTransparent(boolean mouseTransparent)	Sets the value of the property mouseTransparent.
RangeRegionVisualSet<T>	setTooltipText(Function<T,String> tooltipTextExtractor)	Adds tooltip text to display when the mouse is hovered over a visual element representing given data element.
RangeRegionVisualSet<T>	setUpdatePolicy(VisualSet.UpdatePolicy updatePolicy)	Sets the new VisualSet.UpdatePolicy i.e.

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

getBackgroundColor, getBeginArgument, getBorderColor, getBorderWidth, getEndArgument

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

getLabelColor, getLabelFontSize, getLabelSides, getLabelText

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

Constructor Details

RangeRegionVisualSet

public RangeRegionVisualSet(String name,
 Supplier<List<T>> dataElementsProvider,
 Function<T,Double> beginArgumentExtractor,
 Function<T,Double> endArgumentExtractor)

Method Details

setBackgroundColor

public RangeRegionVisualSet<T> setBackgroundColor(Function<T,Color> backgroundColorExtractor)

Description copied from class: AbstractRegionVisualSet

Sets the background color for each data element. The color may be different for different data elements.

Overrides:

setBackgroundColor in class AbstractRegionVisualSet<T>

Parameters:

backgroundColorExtractor - the background color extractor, i.e. method returning color depending on the data element

Returns:

reference to this object

setBorderColor

public RangeRegionVisualSet<T> setBorderColor(Function<T,Color> borderColorExtractor)

Description copied from class: AbstractRegionVisualSet

Sets the border color for each data element. The color may be different for different data elements.

Overrides:

setBorderColor in class AbstractRegionVisualSet<T>

Parameters:

borderColorExtractor - the border color extractor, i.e. method returning color depending on the data element

Returns:

reference to this object

setBorderWidth

public RangeRegionVisualSet<T> setBorderWidth(Function<T,Double> borderWidthExtractor)

Description copied from class: AbstractRegionVisualSet

Sets the border width in pixels for each data element. The width may be different for different data elements.

Overrides:

setBorderWidth in class AbstractRegionVisualSet<T>

Parameters:

borderWidthExtractor - the border width extractor, i.e. method returning width in pixels depending on the data element

Returns:

reference to this object

setLabelText

public RangeRegionVisualSet<T> setLabelText(LabelSide labelSide,
 Function<? extends T,String> labelTextExtractor,
 Function<? extends T,Double> labelTextSizeExtractor,
 Function<? extends T,Color> labelTextColorExtractor)

Description copied from class: LabeledVisualSet

Sets the labels of the rectangles representing plot data elements. The label of each rectangle is set independently of the labels on other sides of this rectangle or the labels on other rectangles. The label will not be displayed if the specified text is empty.

Overrides:

setLabelText in class AbstractRegionVisualSet<T>

Parameters:

labelSide - the LabelSide of rectangle where the corresponding label will be drawn

labelTextExtractor - the text of the label

labelTextSizeExtractor - the font size of the label

labelTextColorExtractor - the color of the label

Returns:

reference to this object

setTooltipText

public RangeRegionVisualSet<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.

Overrides:

setTooltipText in class AbstractRegionVisualSet<T>

Parameters:

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

Returns:

reference to this object

setUpdatePolicy

public RangeRegionVisualSet<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

addContextMenuHandler

public RangeRegionVisualSet<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 RangeRegionVisualSet<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 RangeRegionVisualSet<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 RangeRegionVisualSet<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 RangeRegionVisualSet<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 RangeRegionVisualSet<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

setMinValue

public RangeRegionVisualSet<T> setMinValue(Function<T,Double> minValueExtractor)

Sets the Y-axis min value for each data element.

Parameters:

minValueExtractor - the Y-axis min value extractor, i.e. method returning Y-axis min value depending on the data element

Returns:

reference to this object

setMaxValue

public RangeRegionVisualSet<T> setMaxValue(Function<T,Double> maxValueExtractor)

Sets the Y-axis max value for each data element.

Parameters:

maxValueExtractor - the Y-axis max value extractor, i.e. method returning Y-axis max value depending on the data element

Returns:

reference to this object

getMinValue

public double getMinValue(T element)

Returns the Y-axis min value for given data element.

Parameters:

element - data element for which the Y-axis min value is being checked

Returns:

the Y-axis begin value for given data element

getMaxValue

public double getMaxValue(T element)

Returns the Y-axis max value for given data element.

Parameters:

element - data element for which the Y-axis max value is being checked

Returns:

the Y-axis max value for given data element

getVisualElements

public List<RangeRegionVisualSet<T>.RangeRegionVisualElement> 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 RangeRegionVisualSet<T>.RangeRegionVisualElement 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()

setClipboardText

public RangeRegionVisualSet<T> setClipboardText(Function<Pair<Double,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

getClipboardText

public String getClipboardText(Pair<Double,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