Package com.amalgamasimulation.charts.visualsets

Class TriangleMarkerVisualSet<T>

java.lang.Object

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

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

Type Parameters:

T - visual set data elements type

All Implemented Interfaces:

IGanttChartRowPropertyOwner, IUpdatePolicyPropertyOwner, IAbstractChartVisualSet, IGanttChartVisualSet

public class TriangleMarkerVisualSet<T>
extends VisualSet<T>
implements IGanttChartRowPropertyOwner, IGanttChartVisualSet

Visual set for drawing triangle markers.

Can be drawn on AbstractGanttChart.

Usually used in common with a GanttVisualSet to mark specific areas on gantt-rectangles. The triangle can be drawn in different directions (i.e. point up or down) and on different sides of the gantt-rectangle (i.e. on rectangle top or bottom side).

Author:

Aleksey Kirillov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TriangleMarkerVisualSet.Direction	Enum represents the direction of the vertex of the triangle.
static enum	TriangleMarkerVisualSet.Side	Enum represents the side of the intended rectangle, relative to which the triangle is drawn.
class	TriangleMarkerVisualSet.TriangleMarkerVisualElement	Internal class that represents visual element for triangle marker 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 Function<T,Color>	borderColorExtractor
protected Function<T,Double>	borderWidthExtractor
protected Function<T,TriangleMarkerVisualSet.Direction>	directionExtractor
protected Function<T,Color>	fillColorExtractor
protected GanttChartRow	ganttChartRow
protected Function<T,Double>	heightExtractor
protected Function<T,Double>	rowHeightFractionExtractor
protected Function<T,TriangleMarkerVisualSet.Side>	sideExtractor
protected Function<T,Double>	widthExtractor

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
TriangleMarkerVisualSet(String name, GanttChartRow ganttChartRow, Supplier<List<T>> elementsProvider, Function<T,Double> argumentExtractor)	Constructs a TriangleMarkerVisualSet with given name, GanttChartRow, data elements and arguments extractors, i.e.
TriangleMarkerVisualSet(String name, Supplier<List<T>> dataElementsProvider, Function<T,Double> argumentExtractor)	Constructs a TriangleMarkerVisualSet with given name, data elements and arguments extractors, i.e.

Method Summary

Modifier and Type	Method	Description
TriangleMarkerVisualSet<T>	addContextMenuHandler(VisualSet.ContextMenuHandler<T> contextMenuHandler)	Adds the action to be executed every time a context menu for given data element is called.
TriangleMarkerVisualSet<T>	addMouseEnterHandler(BiConsumer<T,javafx.scene.input.MouseEvent> handler)	Adds the action to be executed every time mouse enters to any visual element borders.
TriangleMarkerVisualSet<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.
TriangleMarkerVisualSet<T>	addMousePressedHandler(BiConsumer<T,javafx.scene.input.MouseEvent> handler)	Adds the action to be executed every time a mouse button is pressed.
TriangleMarkerVisualSet<T>	addVisibilityChangeHandler(Consumer<VisibilityChangeDescriptor<? extends IAbstractChartVisualSet>> visibilityChangeHandler)	Adds the action to be executed every time the visibility of this VisualSet is changed.
TriangleMarkerVisualSet<T>.TriangleMarkerVisualElement	createVisualElement(T contents)	Creates a new instance of VisualSet<T>.VisualElement corresponding to the current VisualSet type.
Color	getBorderColor(T element)	Returns the border color for given data element.
double	getBorderWidth(T element)	Returns the border width in pixels for given data element.
TriangleMarkerVisualSet.Direction	getDirection(T element)	Returns the drawing TriangleMarkerVisualSet.Direction for given data element.
Color	getFillColor(T element)	Returns the fill color for given data element.
GanttChartRow	getGanttChartRow()	Returns the reference to the GanttChartRow row on which the visuals will be drawn
double	getHeight(T element)	Returns the height in pixels for given data element.
double	getRowHeightFraction(T element)	Returns the fraction height of the region in which polyline is drawn.
TriangleMarkerVisualSet.Side	getSide(T element)	Returns the drawing TriangleMarkerVisualSet.Side for given data element.
List<TriangleMarkerVisualSet<T>.TriangleMarkerVisualElement>	getVisualElements(boolean recalculationRequired)	Returns the list of visual elements corresponding to current data elements.
double	getWidth(T element)	Returns the width in pixels for given data element.
TriangleMarkerVisualSet<T>	setBorderColor(Function<T,Color> borderColorExtractor)	Sets the border color for each data element.
TriangleMarkerVisualSet<T>	setBorderWidth(Function<T,Double> borderWidthExtractor)	Sets the border width in pixels for each data element.
TriangleMarkerVisualSet<T>	setDirection(Function<T,TriangleMarkerVisualSet.Direction> directionExtractor)	Sets the drawing TriangleMarkerVisualSet.Direction for each data element i.e.
TriangleMarkerVisualSet<T>	setFillColor(Function<T,Color> fillColorExtractor)	Sets the background color for each data element.
TriangleMarkerVisualSet<T>	setHeight(Function<T,Double> heightExtractor)	Sets the height in pixels for each data element.
TriangleMarkerVisualSet<T>	setMouseTransparent(boolean mouseTransparent)	Sets the value of the property mouseTransparent.
TriangleMarkerVisualSet<T>	setRowHeightFraction(Function<T,Double> rowHeightFractionExtractor)	Sets the fraction height of the region in which triangle is drawn.
TriangleMarkerVisualSet<T>	setSide(Function<T,TriangleMarkerVisualSet.Side> sideExtractor)	Sets the drawing TriangleMarkerVisualSet.Side for each data element i.e.
TriangleMarkerVisualSet<T>	setTooltipText(Function<T,String> tooltipTextExtractor)	Adds tooltip text to display when the mouse is hovered over a visual element representing given data element.
TriangleMarkerVisualSet<T>	setUpdatePolicy(VisualSet.UpdatePolicy updatePolicy)	Sets the new VisualSet.UpdatePolicy i.e.
TriangleMarkerVisualSet<T>	setWidth(Function<T,Double> widthExtractor)	Sets the width in pixels for each data element.

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

Field Details

ganttChartRow

protected GanttChartRow ganttChartRow

rowHeightFractionExtractor

protected Function<T,Double> rowHeightFractionExtractor

sideExtractor

protected Function<T,TriangleMarkerVisualSet.Side> sideExtractor

directionExtractor

protected Function<T,TriangleMarkerVisualSet.Direction> directionExtractor

widthExtractor

protected Function<T,Double> widthExtractor

heightExtractor

protected Function<T,Double> heightExtractor

borderColorExtractor

protected Function<T,Color> borderColorExtractor

borderWidthExtractor

protected Function<T,Double> borderWidthExtractor

fillColorExtractor

protected Function<T,Color> fillColorExtractor

Constructor Details

TriangleMarkerVisualSet

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

Constructs a TriangleMarkerVisualSet with given name, data elements and arguments extractors, i.e. a functions that specifies the rule for extracting an argument 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

TriangleMarkerVisualSet

public TriangleMarkerVisualSet(String name,
 GanttChartRow ganttChartRow,
 Supplier<List<T>> elementsProvider,
 Function<T,Double> argumentExtractor)

Constructs a TriangleMarkerVisualSet with given name, GanttChartRow, data elements and arguments extractors, i.e. a functions that specifies the rule for extracting an argument 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

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

Method Details

setSide

public TriangleMarkerVisualSet<T> setSide(Function<T,TriangleMarkerVisualSet.Side> sideExtractor)

Sets the drawing TriangleMarkerVisualSet.Side for each data element i.e. the side of the intended rectangle, relative to which the triangle is drawn.

Parameters:

sideExtractor - the TriangleMarkerVisualSet.Side extractor, i.e. method returning TriangleMarkerVisualSet.Side depending on the data element

Returns:

the drawing TriangleMarkerVisualSet.Side for each data element

setDirection

public TriangleMarkerVisualSet<T> setDirection(Function<T,TriangleMarkerVisualSet.Direction> directionExtractor)

Sets the drawing TriangleMarkerVisualSet.Direction for each data element i.e. the direction of the vertex of the triangle.

Parameters:

directionExtractor - the TriangleMarkerVisualSet.Direction extractor, i.e. method returning TriangleMarkerVisualSet.Direction depending on the data element

Returns:

the drawing TriangleMarkerVisualSet.Direction for each data element

setWidth

public TriangleMarkerVisualSet<T> setWidth(Function<T,Double> widthExtractor)

Sets the width in pixels for each data element.

Parameters:

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

Returns:

reference to this object

setHeight

public TriangleMarkerVisualSet<T> setHeight(Function<T,Double> heightExtractor)

Sets the height in pixels for each data element.

Parameters:

heightExtractor - the height in pixels extractor, i.e. method returning height depending on the data element

Returns:

reference to this object

setBorderColor

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

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

Parameters:

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

Returns:

reference to this object

setBorderWidth

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

Sets the border width in pixels for each data element.

Parameters:

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

Returns:

reference to this object

setFillColor

public TriangleMarkerVisualSet<T> setFillColor(Function<T,Color> fillColorExtractor)

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

Parameters:

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

Returns:

reference to this object

setRowHeightFraction

public TriangleMarkerVisualSet<T> setRowHeightFraction(Function<T,Double> rowHeightFractionExtractor)

Sets the fraction height of the region in which triangle is drawn. The fraction may be different for different data elements. 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:

rowHeightFractionExtractor - the row height fraction extractor, i.e. method returning row height fraction depending on the data element

Returns:

the fraction height of the region in which triangle is drawn

setUpdatePolicy

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

getRowHeightFraction

public double getRowHeightFraction(T element)

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

Parameters:

element - data element for which the fraction height is being checked

Returns:

the fraction height of the region in which polyline is drawn

getSide

public TriangleMarkerVisualSet.Side getSide(T element)

Returns the drawing TriangleMarkerVisualSet.Side for given data element.

Parameters:

element - data element for which the drawing TriangleMarkerVisualSet.Side is being checked

Returns:

the drawing TriangleMarkerVisualSet.Side for given data element

getDirection

public TriangleMarkerVisualSet.Direction getDirection(T element)

Returns the drawing TriangleMarkerVisualSet.Direction for given data element.

Parameters:

element - data element for which the drawing TriangleMarkerVisualSet.Direction is being checked

Returns:

the drawing TriangleMarkerVisualSet.Direction for given data element

getWidth

public double getWidth(T element)

Returns the width in pixels for given data element.

Parameters:

element - data element for which the width in pixels is being checked

Returns:

the width in pixels for given data element

getHeight

public double getHeight(T element)

Returns the height in pixels for given data element.

Parameters:

element - data element for which the height in pixels is being checked

Returns:

the height in pixels for given data element

getBorderColor

public Color getBorderColor(T element)

Returns the border color for given data element.

Parameters:

element - data element for which the border color is being checked

Returns:

the border color for given data element

getBorderWidth

public double getBorderWidth(T element)

Returns the border width in pixels for given data element.

Parameters:

element - data element for which the border width in pixels is being checked

Returns:

the border width in pixels for given data element

getFillColor

public Color getFillColor(T element)

Returns the fill color for given data element.

Parameters:

element - data element for which the fill color is being checked

Returns:

the fill color for given data element

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

setTooltipText

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

addContextMenuHandler

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

getVisualElements

public List<TriangleMarkerVisualSet<T>.TriangleMarkerVisualElement> 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

createVisualElement

public TriangleMarkerVisualSet<T>.TriangleMarkerVisualElement 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