Package com.amalgamasimulation.charts.visualsets

Class LabeledVisualSet<T>

java.lang.Object

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

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

Type Parameters:

T - visual set data elements type

All Implemented Interfaces:

IUpdatePolicyPropertyOwner, IAbstractChartVisualSet

Direct Known Subclasses:

AbstractRegionVisualSet, GanttVisualSet, HeatmapVisualSet

public abstract class LabeledVisualSet<T>
extends VisualSet<T>

Class that is the parent for all visual sets drawn on the chart by rectangles with labels on it.

Author:

Aleksey Kirillov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	LabeledVisualSet.LabeledVisualElement	Internal class that represents visual element for labeled 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 Map<LabelSide,Function<T,Color>>	labelColorExtractors
protected Map<LabelSide,Function<T,Double>>	labelFontSizeExtractors
protected Map<LabelSide,Function<T,String>>	labelTextExtractors
protected List<LabelSide>	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
LabeledVisualSet(String name, Supplier<List<T>> dataElementsProvider, Function<T,Double> argumentExtractor)	Constructs a LabeledVisualSet with given name, data elements and arguments extractor, i.e.

Method Summary

Modifier and Type	Method	Description
Color	getLabelColor(T element, LabelSide labelSide)	Returns the color of the label drawn for the specified data element and LabelSide.
Double	getLabelFontSize(T element, LabelSide labelSide)	Returns the font size of the label drawn for the specified data element and LabelSide.
List<LabelSide>	getLabelSides()	Returns list of all LabelSide for which at least one text label is specified.
String	getLabelText(T element, LabelSide labelSide)	Returns the text of the label drawn for the specified data element and LabelSide.
LabeledVisualSet<T>	setLabelText(LabelSide labelSide, Function<? extends T,String> labelTextExtractor, Function<? extends T,Double> labelFontSizeExtractor, Function<? extends T,Color> labelColorExtractor)	Sets the labels of the rectangles representing plot data elements.

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

addContextMenuHandler, addMouseEnterHandler, addMouseExitHandler, addMousePressedHandler, addVisibilityChangeHandler, addVisualElement, addVisualElement, addVisualSetChangeHandler, clearDependencies, createVisualElement, getArgument, getContents, getContextMenuHandlers, getDataElements, getInjectionIndex, getMaxArgument, getMinArgument, getMouseEnterHandlers, getMouseExitHandlers, getMousePressedHandlers, getName, getTooltipText, getUpdatePolicy, getVisibilityChangeHandlers, getVisibleVisualElementIndex, getVisibleVisualElementsCount, getVisualElements, isMouseTransparent, isNeedsUpdate, recalculateVisualElements, removeContextMenuHandler, removeMouseEnterHandler, removeMouseExitHandler, removeMousePressedHandler, removeVisibilityChangeHandler, removeVisualElement, removeVisualSetChangeHandler, setMouseTransparent, setTooltipText, setUpdatePolicy, sortVisualElements, toString, update, updateMinMaxArgumentsValues

Methods inherited from class java.lang.Object

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

Field Details

labelTextExtractors

protected Map<LabelSide,Function<T,String>> labelTextExtractors

labelFontSizeExtractors

protected Map<LabelSide,Function<T,Double>> labelFontSizeExtractors

labelColorExtractors

protected Map<LabelSide,Function<T,Color>> labelColorExtractors

labelTextSidesList

protected List<LabelSide> labelTextSidesList

Constructor Details

LabeledVisualSet

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

Constructs a LabeledVisualSet with given name, data elements and arguments extractor, i.e. a function 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

Method Details

setLabelText

public LabeledVisualSet<T> setLabelText(LabelSide labelSide,
 Function<? extends T,String> labelTextExtractor,
 Function<? extends T,Double> labelFontSizeExtractor,
 Function<? extends T,Color> labelColorExtractor)

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.

Parameters:

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

labelTextExtractor - the text of the label

labelFontSizeExtractor - the font size of the label

labelColorExtractor - the color of the label

Returns:

reference to this object

getLabelSides

public List<LabelSide> getLabelSides()

Returns list of all LabelSide for which at least one text label is specified.

Returns:

list of all LabelSide for which at least one text label is specified

getLabelText

public String getLabelText(T element,
 LabelSide labelSide)

Returns the text of the label drawn for the specified data element and LabelSide. Returns an empty string if no label text is specified for the corresponding combination of parameters.

Parameters:

element - data element for which the label text is being checked

labelSide - the LabelSide of rectangle where the corresponding label is drawn

Returns:

the font size of the label drawn for the specified parameters, or empty string if no label text is specified for the corresponding combination of parameters

getLabelFontSize

public Double getLabelFontSize(T element,
 LabelSide labelSide)

Returns the font size of the label drawn for the specified data element and LabelSide. Returns a zero if no label text is specified for the corresponding combination of parameters.

Parameters:

element - data element for which the label font size is being checked

labelSide - the LabelSide of rectangle where the corresponding label is drawn

Returns:

the font size of the label drawn for the specified parameters, or zero if no label text is specified for the corresponding combination of parameters

getLabelColor

public Color getLabelColor(T element,
 LabelSide labelSide)

Returns the color of the label drawn for the specified data element and LabelSide. Returns a default white color if no label text is specified for the corresponding combination of parameters.

Parameters:

element - data element for which the label text is being checked

labelSide - the LabelSide of rectangle where the corresponding label is drawn

Returns:

the color of the label drawn for the specified parameters, or default white color if no label text is specified for the corresponding combination of parameters