Package com.amalgamasimulation.charts.visualsets

Class VisualSet.VisualElement

java.lang.Object

com.amalgamasimulation.charts.visualsets.VisualSet.VisualElement

All Implemented Interfaces:

IAbstractChartVisualElement<T>

Direct Known Subclasses:

AbstractGridLineVisualSet.AbstractGridLineVisualElement, AbstractLineVisualSet.AbstractLineVisualElement, BarLabeledVisualSet.BarLabeledVisualElement, BoxAndWhiskerVisualSet.BoxAndWhiskerVisualElement, ConnectionVisualSet.ConnectionVisualElement, LabeledVisualSet.LabeledVisualElement, LineBarVisualSet.LineBarVisualElement, PointsVisualSet.PointsVisualElement, TriangleMarkerVisualSet.TriangleMarkerVisualElement

Enclosing class:

VisualSet<T>

public abstract class VisualSet.VisualElement
extends Object
implements IAbstractChartVisualElement<T>

Internal class that represents visual element for a data element. This class is public for technical purposes, it is unlikely that API users will need to interact with it.

Author:

Aleksey Kirillov

Field Summary

Fields

Modifier and Type	Field	Description
protected T	contents
protected VisualSet<T>.VisualElement	nextVisualElement
protected VisualSet<T>.VisualElement	previousVisualElement

Constructor Summary

Constructors

Constructor	Description
VisualElement(T contents)	Constructs visual element for the given data element.

Method Summary

Modifier and Type	Method	Description
void	acceptContextMenuHandlers(Object menu, javafx.scene.input.MouseEvent mouseEvent)	Used to handle the open context menu event.
double	getArgument()	Delegates a call to VisualSet.getArgument(Object) for the data element corresponding to this visual element.
T	getContents()	Returns the current data element.
protected long	getInternalID()
VisualSet<T>.VisualElement	getNextVisualElement()	Returns the next VisualSet.VisualElement.
VisualSet<T>.VisualElement	getPreviousVisualElement()	Returns the previous VisualSet.VisualElement.
String	getTooltipText()	Delegates a call to VisualSet.getTooltipText(Object) for the data element corresponding to this visual element.
void	onMouseEntered(javafx.scene.input.MouseEvent mouseEvent)	Used to handle the MouseEvent that the mouse cursor enters an area inside the boundaries of this visual.
void	onMouseExited(javafx.scene.input.MouseEvent mouseEvent)	Used to handle the MouseEvent that the mouse cursor exites an area inside the boundaries of this visual.
void	onMousePressed(javafx.scene.input.MouseEvent mouseEvent)	Used to handle the MouseEvent that the mouse cursor pressed in the area inside the boundaries of this visual.
void	setNextVisualElement(VisualSet<T>.VisualElement nextVisualElement)	Sets the next VisualSet<T>.VisualElement.
void	setPreviousVisualElement(VisualSet<T>.VisualElement previousVisualElement)	Sets the previous VisualSet<T>.VisualElement.

Methods inherited from class java.lang.Object

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

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

getVisualSet

Field Details

contents

protected T contents

previousVisualElement

protected VisualSet<T>.VisualElement previousVisualElement

nextVisualElement

protected VisualSet<T>.VisualElement nextVisualElement

Constructor Details

VisualElement

public VisualElement(T contents)

Constructs visual element for the given data element.

Parameters:

contents - line data element

Method Details

getInternalID

protected long getInternalID()

setPreviousVisualElement

public void setPreviousVisualElement(VisualSet<T>.VisualElement previousVisualElement)

Sets the previous VisualSet<T>.VisualElement. Used to calculate the parameters needed to draw continuous visuals between different data elements.

Should not be called by the user.

Parameters:

previousVisualElement - new previous VisualSet<T>.VisualElement

setNextVisualElement

public void setNextVisualElement(VisualSet<T>.VisualElement nextVisualElement)

Sets the next VisualSet<T>.VisualElement. Used to calculate the parameters needed to draw continuous visuals between different data elements.

Should not be called by the user.

Parameters:

nextVisualElement - new next VisualSet<T>.VisualElement

getPreviousVisualElement

public VisualSet<T>.VisualElement getPreviousVisualElement()

Description copied from interface: IAbstractChartVisualElement

Returns the previous VisualSet.VisualElement.

Specified by:

getPreviousVisualElement in interface IAbstractChartVisualElement<T>

Returns:

the previous VisualSet.VisualElement

getNextVisualElement

public VisualSet<T>.VisualElement getNextVisualElement()

Description copied from interface: IAbstractChartVisualElement

Returns the next VisualSet.VisualElement.

Specified by:

getNextVisualElement in interface IAbstractChartVisualElement<T>

Returns:

the next VisualSet.VisualElement

getContents

public T getContents()

Description copied from interface: IAbstractChartVisualElement

Returns the current data element.

Specified by:

getContents in interface IAbstractChartVisualElement<T>

Returns:

the current data element

getArgument

public double getArgument()

Description copied from interface: IAbstractChartVisualElement

Delegates a call to VisualSet.getArgument(Object) for the data element corresponding to this visual element.

Specified by:

getArgument in interface IAbstractChartVisualElement<T>

Returns:

the result of a call VisualSet.getArgument(Object)

getTooltipText

public String getTooltipText()

Description copied from interface: IAbstractChartVisualElement

Delegates a call to VisualSet.getTooltipText(Object) for the data element corresponding to this visual element.

Specified by:

getTooltipText in interface IAbstractChartVisualElement<T>

Returns:

the result of a call VisualSet.getTooltipText(Object)

onMouseEntered

public void onMouseEntered(javafx.scene.input.MouseEvent mouseEvent)

Description copied from interface: IAbstractChartVisualElement

Used to handle the MouseEvent that the mouse cursor enters an area inside the boundaries of this visual.

Specified by:

onMouseEntered in interface IAbstractChartVisualElement<T>

Parameters:

mouseEvent - mouse enter event handle

onMouseExited

public void onMouseExited(javafx.scene.input.MouseEvent mouseEvent)

Description copied from interface: IAbstractChartVisualElement

Used to handle the MouseEvent that the mouse cursor exites an area inside the boundaries of this visual.

Specified by:

onMouseExited in interface IAbstractChartVisualElement<T>

Parameters:

mouseEvent - mouse exit event handle

onMousePressed

public void onMousePressed(javafx.scene.input.MouseEvent mouseEvent)

Description copied from interface: IAbstractChartVisualElement

Used to handle the MouseEvent that the mouse cursor pressed in the area inside the boundaries of this visual.

Specified by:

onMousePressed in interface IAbstractChartVisualElement<T>

Parameters:

mouseEvent - mouse press event handle

acceptContextMenuHandlers

public void acceptContextMenuHandlers(Object menu,
 javafx.scene.input.MouseEvent mouseEvent)

Description copied from interface: IAbstractChartVisualElement

Used to handle the open context menu event.

Specified by:

acceptContextMenuHandlers in interface IAbstractChartVisualElement<T>

Parameters:

menu - opened context menu

mouseEvent - mouse event handle