Package com.amalgamasimulation.charts.visualsets

Class GanttPolylineVisualSet<T>

java.lang.Object

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

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

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

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

Type Parameters:

T - visual set data elements type

All Implemented Interfaces:

IClipboardTextPropertyOwner<Double>, IGanttChartRowPropertyOwner, ILegendNodePropertiesOwner, IMinMaxValuePropertyOwner, IUpdatePolicyPropertyOwner, IAbstractChartVisualSet, IGanttChartVisualSet

public class GanttPolylineVisualSet<T>
extends AbstractPolylineVisualSet<T>
implements IGanttChartRowPropertyOwner, IGanttChartVisualSet

Visual set for drawing polylines.

Can be drawn on TimeGanttChart.

Polylines are drawn within a single GanttChartRow that does not have its own numerical vertical axis.

A drawn polyline is usually used not for the purpose of represents exact values, but for the purpose of understanding the general profile of changing values.

The minimum Y-value within the data elements corresponds to the lower bound of the GanttChartRow, and the maximum value corresponds to the upper one. The remaining values are drawn relative to the minimum and maximum.

Author:

Aleksey Kirillov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	GanttPolylineVisualSet.GanttPolylineVisualElement	Internal class that represents visual element for polyline data element.

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

AbstractPolylineVisualSet.AbstractPolylineVisualElement

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

AbstractLineVisualSet.AbstractLineVisualElement, AbstractLineVisualSet.Extrapolation, AbstractLineVisualSet.PointsAndLinesStyle

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.AbstractPolylineVisualSet

clipboardTextExtractor

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

extrapolation, legendTextProvider, lineColor, lineStyle, lineWidth, maxValueProvider, pointsAndLinesStyle, pointSize, 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
GanttPolylineVisualSet(String name, GanttChartRow ganttChartRow, Supplier<List<T>> dataElementsProvider, Function<T,Double> argumentExtractor, Function<T,Double> valueExtractor)	Constructs a GanttPolylineVisualSet with given name, GanttChartRow, data elements and arguments/value extractors, i.e.
GanttPolylineVisualSet(String name, Supplier<List<T>> dataElementsProvider, Function<T,Double> argumentExtractor, Function<T,Double> valueExtractor)	Constructs a GanttPolylineVisualSet with given name, data elements and arguments/value extractors, i.e.

Method Summary

Modifier and Type	Method	Description
GanttPolylineVisualSet<T>	addContextMenuHandler(VisualSet.ContextMenuHandler<T> contextMenuHandler)	Adds the action to be executed every time a context menu for given data element is called.
GanttPolylineVisualSet<T>	addMouseEnterHandler(BiConsumer<T,javafx.scene.input.MouseEvent> handler)	Adds the action to be executed every time mouse enters to any visual element borders.
GanttPolylineVisualSet<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.
GanttPolylineVisualSet<T>	addMousePressedHandler(BiConsumer<T,javafx.scene.input.MouseEvent> handler)	Adds the action to be executed every time a mouse button is pressed.
GanttPolylineVisualSet<T>	addVisibilityChangeHandler(Consumer<VisibilityChangeDescriptor<? extends IAbstractChartVisualSet>> visibilityChangeHandler)	Adds the action to be executed every time the visibility of this VisualSet is changed.
GanttPolylineVisualSet<T>.GanttPolylineVisualElement	createVisualElement(T contents)	Creates a new instance of VisualSet<T>.VisualElement corresponding to the current VisualSet type.
GanttChartRow	getGanttChartRow()	Returns the reference to the GanttChartRow row on which the visuals will be drawn
protected int	getInjectionIndex(List<VisualSet<T>.VisualElement> list, VisualSet<T>.VisualElement element, T contents, int contentsIndex, Map<VisualSet<T>.VisualElement,Double> beginArgumentsCache)
double	getRowHeightFraction()	Returns the fraction height of the region in which polyline is drawn.
List<GanttPolylineVisualSet<T>.GanttPolylineVisualElement>	getVisualElements(boolean recalculationRequired)	Returns the list of visual elements corresponding to current data elements.
GanttPolylineVisualSet<T>	setClipboardText(Function<Double,String> clipboardText)	Sets the conversion method from values of each plot data element into text that will be copied to clipboard.
GanttPolylineVisualSet<T>	setExtrapolation(AbstractLineVisualSet.Extrapolation extrapolation)	Sets the of the plot i.e.
GanttPolylineVisualSet<T>	setLegendText(Supplier<String> legendTextProvider)	Sets the Legend label text represents this visual set.
GanttPolylineVisualSet<T>	setLineColor(Color color)	Sets the line color of the plot.
GanttPolylineVisualSet<T>	setLineStyle(LineStyle lineStyle)	Sets the LineStyle of the plot i.e.
GanttPolylineVisualSet<T>	setLineWidth(double width)	Sets the width of the line, in pixels.
GanttPolylineVisualSet<T>	setMaxValue(Supplier<Double> maxValueProvider)	Sets the supplier of max value.
GanttPolylineVisualSet<T>	setMouseTransparent(boolean mouseTransparent)	Sets the value of the property mouseTransparent.
GanttPolylineVisualSet<T>	setPointsAndLinesStyle(AbstractLineVisualSet.PointsAndLinesStyle pointsAndLinesStyle)	Sets the AbstractLineVisualSet.PointsAndLinesStyle of the plot i.e.
GanttPolylineVisualSet<T>	setPointSize(double pointSize)	Sets the diameter of the point, in pixels.
GanttPolylineVisualSet<T>	setRowHeightFraction(double rowHeightFraction)	Sets the fraction height of the region in which polyline is drawn.
GanttPolylineVisualSet<T>	setTooltipText(Function<T,String> tooltipText)	Adds tooltip text to display when the mouse is hovered over a visual element representing given data element.
GanttPolylineVisualSet<T>	setUpdatePolicy(VisualSet.UpdatePolicy updatePolicy)	Sets the new VisualSet.UpdatePolicy i.e.

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

getClipboardText, getValue

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

getExtrapolation, getLegendColor, getLegendText, getLineColor, getLineStyle, getLineWidth, getMaxValue, getMinValue, getPointsAndLinesStyle, getPointSize, getValue

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

addVisualElement, addVisualElement, addVisualSetChangeHandler, clearDependencies, getArgument, getContents, getContextMenuHandlers, getDataElements, 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

Constructor Details

GanttPolylineVisualSet

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

Constructs a GanttPolylineVisualSet 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. Creates a default GanttChartRow based on the given name.

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

GanttPolylineVisualSet

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

Constructs a GanttPolylineVisualSet with given name, GanttChartRow, 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

ganttChartRow - GanttChartRow which displays this visual set i.e. the Y-axis value

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

setRowHeightFraction

public GanttPolylineVisualSet<T> setRowHeightFraction(double rowHeightFraction)

Sets the fraction height of the region in which polyline is drawn. Fraction is calculated relative to the height of the region allocated for corresponding GanttChartRow.

The value must be greater than zero and not greater than 1.

The default value is 1.

Parameters:

rowHeightFraction - new row height fraction

Returns:

the fraction height of the region in which polyline is drawn

getRowHeightFraction

public double getRowHeightFraction()

Returns the fraction height of the region in which polyline is drawn.

Returns:

the fraction height of the region in which polyline is drawn

setTooltipText

public GanttPolylineVisualSet<T> setTooltipText(Function<T,String> tooltipText)

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 AbstractPolylineVisualSet<T>

Parameters:

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

Returns:

reference to this object

setLineColor

public GanttPolylineVisualSet<T> setLineColor(Color color)

Description copied from class: AbstractLineVisualSet

Sets the line color of the plot. Transparent and semi-transparent colors are allowed.

Overrides:

setLineColor in class AbstractLineVisualSet<T>

Parameters:

color - the line color of the plot

Returns:

reference to this object

setLineWidth

public GanttPolylineVisualSet<T> setLineWidth(double width)

Description copied from class: AbstractLineVisualSet

Sets the width of the line, in pixels.

Overrides:

setLineWidth in class AbstractLineVisualSet<T>

Parameters:

width - the width of the line, in pixels

Returns:

reference to this object

setPointSize

public GanttPolylineVisualSet<T> setPointSize(double pointSize)

Description copied from class: AbstractLineVisualSet

Sets the diameter of the point, in pixels.

Overrides:

setPointSize in class AbstractLineVisualSet<T>

Parameters:

pointSize - the diameter of the point, in pixels

Returns:

reference to this object

setPointsAndLinesStyle

public GanttPolylineVisualSet<T> setPointsAndLinesStyle(AbstractLineVisualSet.PointsAndLinesStyle pointsAndLinesStyle)

Description copied from class: AbstractLineVisualSet

Sets the AbstractLineVisualSet.PointsAndLinesStyle of the plot i.e. the methodology of drawing the visual elements for data elements.

Overrides:

setPointsAndLinesStyle in class AbstractLineVisualSet<T>

Parameters:

pointsAndLinesStyle - the AbstractLineVisualSet.PointsAndLinesStyle of the plot i.e. the methodology of drawing the visual elements for data elements

Returns:

reference to this object

setClipboardText

public GanttPolylineVisualSet<T> setClipboardText(Function<Double,String> clipboardText)

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>

Overrides:

setClipboardText in class AbstractPolylineVisualSet<T>

Parameters:

clipboardText - 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

setMaxValue

public GanttPolylineVisualSet<T> setMaxValue(Supplier<Double> maxValueProvider)

Description copied from class: AbstractLineVisualSet

Sets the supplier of max value. This value allows to set some "natural" max value of the data being displayed It will be used when scaling the Y-axis of the chart.

Overrides:

setMaxValue in class AbstractLineVisualSet<T>

Parameters:

maxValueProvider - the supplier of max value

Returns:

reference to this object

addContextMenuHandler

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

setLegendText

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

Overrides:

setLegendText in class AbstractLineVisualSet<T>

Parameters:

legendTextProvider - the Legend label text represents this visual set

Returns:

reference to this object

setLineStyle

public GanttPolylineVisualSet<T> setLineStyle(LineStyle lineStyle)

Description copied from class: AbstractLineVisualSet

Sets the LineStyle of the plot i.e. the methodology of drawing the lines for data elements.

Overrides:

setLineStyle in class AbstractLineVisualSet<T>

Parameters:

lineStyle - the LineStyle of the plot i.e. the methodology of drawing the lines for data elements

Returns:

reference to this object

getVisualElements

public List<GanttPolylineVisualSet<T>.GanttPolylineVisualElement> 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 IGanttChartVisualSet

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

getInjectionIndex

protected int getInjectionIndex(List<VisualSet<T>.VisualElement> list,
 VisualSet<T>.VisualElement element,
 T contents,
 int contentsIndex,
 Map<VisualSet<T>.VisualElement,Double> beginArgumentsCache)

Overrides:

getInjectionIndex in class AbstractPolylineVisualSet<T>

setUpdatePolicy

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

createVisualElement

public GanttPolylineVisualSet<T>.GanttPolylineVisualElement createVisualElement(T contents)

Description copied from class: VisualSet

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

Overrides:

createVisualElement in class AbstractPolylineVisualSet<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

setExtrapolation

public GanttPolylineVisualSet<T> setExtrapolation(AbstractLineVisualSet.Extrapolation extrapolation)

Description copied from class: AbstractLineVisualSet

Sets the of the plot i.e. mode of extending a line to the maximum argument among all visual sets or to the current argument along the horizontal axis. Applicable only for AbstractLineVisualSet.

Overrides:

setExtrapolation in class AbstractLineVisualSet<T>

Parameters:

extrapolation - the AbstractLineVisualSet.Extrapolation of the plot

Returns:

reference to this object

setMouseTransparent

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

getGanttChartRow

public GanttChartRow getGanttChartRow()

Description copied from interface: IGanttChartRowPropertyOwner

Returns the reference to the GanttChartRow row on which the visuals will be drawn

Specified by:

getGanttChartRow in interface IGanttChartRowPropertyOwner

Returns:

the reference to the GanttChartRow row on which the visuals will be drawn