Package com.amalgamasimulation.charts.axes

Class GanttChartCategoryYAxis

java.lang.Object

com.amalgamasimulation.charts.axes.AbstractAxis<GanttChartRow>

com.amalgamasimulation.charts.axes.GanttChartCategoryYAxis

All Implemented Interfaces:

IAxisTitlePositionPropertyOwner, IAxisTitlePropertyOwner<GanttChartRow>, IScrollBarPropertyOwner

public class GanttChartCategoryYAxis
extends AbstractAxis<GanttChartRow>
implements IScrollBarPropertyOwner, IAxisTitlePropertyOwner<GanttChartRow>, IAxisTitlePositionPropertyOwner

Class that represents an Y-axis drawn on a TimeGanttChart area. It holds properties for axis ticks and labels along the axis. This axis does allow ranging and navigation operations.

Author:

Aleksey Kirillov

Field Summary

Fields

Modifier and Type	Field	Description
protected com.amalgamasimulation.charts.internals.charts.GanttChartInternal	chartInternal
protected com.amalgamasimulation.charts.internals.axes.CategoryYAxisInternal<GanttChartRow>	yAxisInternal

Constructor Summary

Constructors

Constructor	Description
GanttChartCategoryYAxis(com.amalgamasimulation.charts.internals.charts.GanttChartInternal chartInternal, com.amalgamasimulation.charts.internals.axes.CategoryYAxisInternal<GanttChartRow> yAxisInternal)	Constructs a GanttChartInternal category Y-axis with given CategoryYAxisInternal

Method Summary

Modifier and Type	Method	Description
GanttChartCategoryYAxis	addClickHandler(Consumer<GanttChartRow> handler)	Adds the action to be executed every time any element on the vertical axis is clicked.
GanttChartCategoryYAxis	clearClickHandlers()	Removes all vertical axis click handlers.
protected com.amalgamasimulation.charts.internals.axes.CategoryYAxisInternal<GanttChartRow>	getAxisInternal()
protected com.amalgamasimulation.charts.internals.charts.GanttChartInternal	getChartInternal()
int	getFirstDisplayedGanttChartRowIndex()	Returns the index of the first currently displayed GanttChartRow.
int	getGanttChartRowsCount()	Returns the count of the currently displayed GanttChartRow's.
LeftMarginRule	getLeftMarginRule()	Returns the current LeftMarginRule.
String	getTitle()	Returns the title of this axis, or null if title has not been specified.
javafx.scene.paint.Color	getTitleColor()	Returns the color of this axis title.
javafx.scene.text.Font	getTitleFont()	Returns the font of this axis title.
int	getTitleFontSize()	Returns the font size of this axis title.
AxisTitlePosition	getTitlePosition()	Returns the AxisTitlePosition that specifies the the chart's title position.
boolean	isScrollBarDisplayed()	Checks whether the scrollbar is currently displayed.
boolean	isScrollBarVisible()	Checks whether the scrollbar should be drawn if scrolling the displayed rang of Y-axis is possible.
boolean	isTitleVisible()	Checks whether this axis title should be drawn.
boolean	isValueDisplayed(GanttChartRow ganttChartRow)	Checks if specified GanttChartRow is currently displayed.
GanttChartCategoryYAxis	navigateTo(int elementIndex)	Navigates Y-axis displayed range to GanttChartRow with specified index.
GanttChartCategoryYAxis	navigateToGanttChartRow(GanttChartRow ganttChartRow)	Navigates Y-axis displayed range to specified GanttChartRow.
GanttChartCategoryYAxis	navigateToGanttChartRow(String ganttChartRowName)	Navigates Y-axis displayed range to GanttChartRow with specified name.
GanttChartCategoryYAxis	navigateToGanttChartRow(String ganttChartRowName, boolean caseSensitive)	Navigates Y-axis displayed range to GanttChartRow with specified name.
GanttChartCategoryYAxis	removeClickHandler(Consumer<GanttChartRow> handler)	Removes vertical axis click handler.
GanttChartCategoryYAxis	setLeftMarginRule(LeftMarginRule yAxisWidthRule)	Sets the new LeftMarginRule.
GanttChartCategoryYAxis	setScrollBarVisible(boolean visible)	Specifies whether the scrollbar should be drawn if scrolling the displayed rang of axis is possible.
GanttChartCategoryYAxis	setTitle(String title)	Sets the new title to this axis.
GanttChartCategoryYAxis	setTitleColor(Color color)	Sets the new color to this axis title.
GanttChartCategoryYAxis	setTitleColor(javafx.scene.paint.Color color)	Sets the new color to this axis title.
GanttChartCategoryYAxis	setTitleFont(javafx.scene.text.Font font)	Sets the new font to this axis title.
GanttChartCategoryYAxis	setTitleFontSize(int fontSize)	Sets the new font size to this axis title.
GanttChartCategoryYAxis	setTitlePosition(AxisTitlePosition yAxisTitlePosition)	Sets the AxisTitlePosition that specifies the chart's title position.
GanttChartCategoryYAxis	setTitleVisible(boolean visible)	Specifies whether this axis title should be drawn.
GanttChartCategoryYAxis	setTooltipText(Function<GanttChartRow,String> yAxisTooltipTextExtractor)	Adds tooltip text to display when the mouse is hovered over a vertical axis element.
GanttChartCategoryYAxis	setTooltipTextFont(Function<GanttChartRow,javafx.scene.text.Font> yAxisTooltipFontExtractor)	Sets the new font to the tooltip text.
GanttChartCategoryYAxis	setTooltipTextFontSize(Function<GanttChartRow,Integer> yAxisTooltipFontSizeExtractor)	Sets the new font size to the tooltip text.

Methods inherited from class com.amalgamasimulation.charts.axes.AbstractAxis

getLabelsColor, getLabelsFont, getLabelsFontSize, setGridLinesColor, setGridLinesColor, setGridLinesVisible, setGridLinesWidth, setLabelsColor, setLabelsColor, setLabelsFont, setLabelsFontSize

Methods inherited from class java.lang.Object

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

Field Details

chartInternal

protected com.amalgamasimulation.charts.internals.charts.GanttChartInternal chartInternal

yAxisInternal

protected com.amalgamasimulation.charts.internals.axes.CategoryYAxisInternal<GanttChartRow> yAxisInternal

Constructor Details

GanttChartCategoryYAxis

public GanttChartCategoryYAxis(com.amalgamasimulation.charts.internals.charts.GanttChartInternal chartInternal,
 com.amalgamasimulation.charts.internals.axes.CategoryYAxisInternal<GanttChartRow> yAxisInternal)

Constructs a GanttChartInternal category Y-axis with given CategoryYAxisInternal

Parameters:

chartInternal - GanttChartInternal which is the owner of this object

yAxisInternal - CategoryYAxisInternal which is the internal axis logic aggregator

Method Details

getChartInternal

protected com.amalgamasimulation.charts.internals.charts.GanttChartInternal getChartInternal()

Specified by:

getChartInternal in class AbstractAxis<GanttChartRow>

getAxisInternal

protected com.amalgamasimulation.charts.internals.axes.CategoryYAxisInternal<GanttChartRow> getAxisInternal()

Specified by:

getAxisInternal in class AbstractAxis<GanttChartRow>

getTitlePosition

public AxisTitlePosition getTitlePosition()

Description copied from interface: IAxisTitlePositionPropertyOwner

Returns the AxisTitlePosition that specifies the the chart's title position.

Specified by:

getTitlePosition in interface IAxisTitlePositionPropertyOwner

Returns:

this current AxisTitlePosition

setTitlePosition

public GanttChartCategoryYAxis setTitlePosition(AxisTitlePosition yAxisTitlePosition)

Description copied from interface: IAxisTitlePositionPropertyOwner

Sets the AxisTitlePosition that specifies the chart's title position. Redraws this axis and it's parent chart.

Specified by:

setTitlePosition in interface IAxisTitlePositionPropertyOwner

Parameters:

yAxisTitlePosition - new AxisTitlePosition that specifies the chart's title position

Returns:

reference to this object

setScrollBarVisible

public GanttChartCategoryYAxis setScrollBarVisible(boolean visible)

Description copied from interface: IScrollBarPropertyOwner

Specifies whether the scrollbar should be drawn if scrolling the displayed rang of axis is possible. True by default. If set to false, the scrollbar will never be drawn but the functionality of scrolling this axis will still remain. Redraws this axis and it's parent chart if visibility is changed.

Specified by:

setScrollBarVisible in interface IScrollBarPropertyOwner

Parameters:

visible - flag setting if the scrollbar should be drawn if scrolling the displayed rang of axis is possible

Returns:

reference to this object

See Also:

• Chart.redraw()

isScrollBarVisible

public boolean isScrollBarVisible()

Description copied from interface: IScrollBarPropertyOwner

Checks whether the scrollbar should be drawn if scrolling the displayed rang of Y-axis is possible.

Specified by:

isScrollBarVisible in interface IScrollBarPropertyOwner

Returns:

true if the scrollbar should be drawn if scrolling the displayed rang of Y-axis is possible, false otherwise

isScrollBarDisplayed

public boolean isScrollBarDisplayed()

Description copied from interface: IScrollBarPropertyOwner

Checks whether the scrollbar is currently displayed.

Specified by:

isScrollBarDisplayed in interface IScrollBarPropertyOwner

Returns:

true if the scrollbar is currently displayed, false otherwise

isValueDisplayed

public boolean isValueDisplayed(GanttChartRow ganttChartRow)

Checks if specified GanttChartRow is currently displayed.

Parameters:

ganttChartRow - GanttChartRow to check

Returns:

true if specified GanttChartRow is currently displayed

navigateToGanttChartRow

public GanttChartCategoryYAxis navigateToGanttChartRow(GanttChartRow ganttChartRow)

Navigates Y-axis displayed range to specified GanttChartRow. Scrolls this axis accordingly and redraws the chart. Does nothing if the specified GanttChartRow is already in the displayed range.

Parameters:

ganttChartRow - GanttChartRow to navigate

Returns:

reference to this object

See Also:

• Chart.redraw()

navigateToGanttChartRow

public GanttChartCategoryYAxis navigateToGanttChartRow(String ganttChartRowName)

Navigates Y-axis displayed range to GanttChartRow with specified name. Scrolls this axis accordingly and redraws the chart. Does nothing if the specified GanttChartRow is already in the displayed range.

Parameters:

ganttChartRowName - a GanttChartRow with this name will be the navigation target

Returns:

reference to this object

See Also:

• Chart.redraw()

navigateToGanttChartRow

public GanttChartCategoryYAxis navigateToGanttChartRow(String ganttChartRowName,
 boolean caseSensitive)

Navigates Y-axis displayed range to GanttChartRow with specified name. Scrolls this axis accordingly and redraws the chart. Does nothing if the specified GanttChartRow is already in the displayed range.

Parameters:

ganttChartRowName - a GanttChartRow with this name will be the navigation target

caseSensitive - if true then the navigation to the GanttChartRow will be case-sensitive

Returns:

reference to this object

See Also:

• Chart.redraw()

navigateTo

public GanttChartCategoryYAxis navigateTo(int elementIndex)

Navigates Y-axis displayed range to GanttChartRow with specified index. Scrolls this axis accordingly and redraws the chart. Does nothing if the specified GanttChartRow is already in the displayed range.

Parameters:

elementIndex - a GanttChartRow with this index will be the navigation target

Returns:

reference to this object

See Also:

• Chart.redraw()

getFirstDisplayedGanttChartRowIndex

public int getFirstDisplayedGanttChartRowIndex()

Returns the index of the first currently displayed GanttChartRow.

Returns:

the index of the first currently displayed GanttChartRow

getGanttChartRowsCount

public int getGanttChartRowsCount()

Returns the count of the currently displayed GanttChartRow's.

Returns:

the count of the currently displayed GanttChartRow's

setTooltipText

public GanttChartCategoryYAxis setTooltipText(Function<GanttChartRow,String> yAxisTooltipTextExtractor)

Adds tooltip text to display when the mouse is hovered over a vertical axis element.

Parameters:

yAxisTooltipTextExtractor - new tooltip text extractor

Returns:

reference to this object

setTooltipTextFont

public GanttChartCategoryYAxis setTooltipTextFont(Function<GanttChartRow,javafx.scene.text.Font> yAxisTooltipFontExtractor)

Sets the new font to the tooltip text.

Parameters:

yAxisTooltipFontExtractor - new tooltip font extractor

Returns:

reference to this object

setTooltipTextFontSize

public GanttChartCategoryYAxis setTooltipTextFontSize(Function<GanttChartRow,Integer> yAxisTooltipFontSizeExtractor)

Sets the new font size to the tooltip text.

Parameters:

yAxisTooltipFontSizeExtractor - new tooltip font size extractor

Returns:

reference to this object

setLeftMarginRule

public GanttChartCategoryYAxis setLeftMarginRule(LeftMarginRule yAxisWidthRule)

Sets the new LeftMarginRule. The possible possible values are: FIXED, DYNAMIC_BY_SHOWED_CONTENT. DYNAMIC_BY_SHOWED_CONTENT rule automatically calculates the margin based on the length of the vertical axis element names. FIXED rule calculated margin based on leftMargin value. Redraws this chart.

Parameters:

yAxisWidthRule - new left margin calculation rule

Returns:

reference to this object

See Also:

• Chart.redraw()

getLeftMarginRule

public LeftMarginRule getLeftMarginRule()

Returns the current LeftMarginRule.

Returns:

the current LeftMarginRule

addClickHandler

public GanttChartCategoryYAxis addClickHandler(Consumer<GanttChartRow> handler)

Adds the action to be executed every time any element on the vertical axis is clicked.

Parameters:

handler - new vertical axis click handler

Returns:

reference to this object

removeClickHandler

public GanttChartCategoryYAxis removeClickHandler(Consumer<GanttChartRow> handler)

Removes vertical axis click handler.

Parameters:

handler - removed vertical axis click handler

Returns:

reference to this object

clearClickHandlers

public GanttChartCategoryYAxis clearClickHandlers()

Removes all vertical axis click handlers.

Returns:

reference to this object

setTitle

public GanttChartCategoryYAxis setTitle(String title)

Description copied from interface: IAxisTitlePropertyOwner

Sets the new title to this axis. Redraws this axis and it's parent chart if title is changed.

Specified by:

setTitle in interface IAxisTitlePropertyOwner<GanttChartRow>

Parameters:

title - new axis title

Returns:

reference to this object

See Also:

• Chart.redraw()

setTitleVisible

public GanttChartCategoryYAxis setTitleVisible(boolean visible)

Description copied from interface: IAxisTitlePropertyOwner

Specifies whether this axis title should be drawn. Redraws this axis and it's parent chart if visibility is changed.

Specified by:

setTitleVisible in interface IAxisTitlePropertyOwner<GanttChartRow>

Parameters:

visible - new axis title visibility

Returns:

reference to this object

See Also:

• Chart.redraw()

setTitleFont

public GanttChartCategoryYAxis setTitleFont(javafx.scene.text.Font font)

Description copied from interface: IAxisTitlePropertyOwner

Sets the new font to this axis title. Redraws this axis and it's parent chart if font is changed.

Specified by:

setTitleFont in interface IAxisTitlePropertyOwner<GanttChartRow>

Parameters:

font - new axis title font

Returns:

reference to this object

See Also:

• Chart.redraw()

setTitleFontSize

public GanttChartCategoryYAxis setTitleFontSize(int fontSize)

Description copied from interface: IAxisTitlePropertyOwner

Sets the new font size to this axis title. Redraws this axis and it's parent chart if font size is changed.

Specified by:

setTitleFontSize in interface IAxisTitlePropertyOwner<GanttChartRow>

Parameters:

fontSize - new axis title font size

Returns:

reference to this object

See Also:

• Chart.redraw()

setTitleColor

public GanttChartCategoryYAxis setTitleColor(Color color)

Description copied from interface: IAxisTitlePropertyOwner

Sets the new color to this axis title. Redraws this axis and it's parent chart if color is changed.

Specified by:

setTitleColor in interface IAxisTitlePropertyOwner<GanttChartRow>

Parameters:

color - new axis title color

Returns:

reference to this object

See Also:

• Chart.redraw()

setTitleColor

public GanttChartCategoryYAxis setTitleColor(javafx.scene.paint.Color color)

Description copied from interface: IAxisTitlePropertyOwner

Sets the new color to this axis title. Redraws this axis and it's parent chart if color is changed.

Specified by:

setTitleColor in interface IAxisTitlePropertyOwner<GanttChartRow>

Parameters:

color - new axis title color

Returns:

reference to this object

See Also:

• Chart.redraw()

getTitleColor

public javafx.scene.paint.Color getTitleColor()

Description copied from interface: IAxisTitlePropertyOwner

Returns the color of this axis title.

Specified by:

getTitleColor in interface IAxisTitlePropertyOwner<GanttChartRow>

Returns:

the color of this axis title

getTitle

public String getTitle()

Description copied from interface: IAxisTitlePropertyOwner

Returns the title of this axis, or null if title has not been specified.

Specified by:

getTitle in interface IAxisTitlePropertyOwner<GanttChartRow>

Returns:

the title of this axis, or null if title has not been specified

isTitleVisible

public boolean isTitleVisible()

Description copied from interface: IAxisTitlePropertyOwner

Checks whether this axis title should be drawn.

Specified by:

isTitleVisible in interface IAxisTitlePropertyOwner<GanttChartRow>

Returns:

true if this axis title should be drawn, false otherwise

getTitleFont

public javafx.scene.text.Font getTitleFont()

Description copied from interface: IAxisTitlePropertyOwner

Returns the font of this axis title.

Specified by:

getTitleFont in interface IAxisTitlePropertyOwner<GanttChartRow>

Returns:

axis title font

getTitleFontSize

public int getTitleFontSize()

Description copied from interface: IAxisTitlePropertyOwner

Returns the font size of this axis title.

Specified by:

getTitleFontSize in interface IAxisTitlePropertyOwner<GanttChartRow>

Returns:

the font size of this axis title