Package com.amalgamasimulation.charts

Class TimeGanttChart

java.lang.Object

com.amalgamasimulation.charts.Chart<IGanttChartVisualSet,GanttVisualSetContainer>

com.amalgamasimulation.charts.AbstractGanttChart

com.amalgamasimulation.charts.TimeGanttChart

All Implemented Interfaces:

IVerticalGuidelineOwner<IGanttChartVisualSet,GanttVisualSetContainer>

public final class TimeGanttChart
extends AbstractGanttChart

A chart is a GUI component based on JavaFX's XYChart class that can be used to conveniently draw numeric and statistical data. All charts are designed to be compatible with Eclipse RCP applications and SWT framework. A Time Gantt Chart is used to show history of some state changes or schedules with Time-related X-axis.

Author:

Aleksey Kirillov

Field Summary

Fields

Modifier and Type	Field	Description
protected GanttChartTimeXAxis	xAxis
protected GanttChartCategoryYAxis	yAxis

Fields inherited from class com.amalgamasimulation.charts.AbstractGanttChart

internalGanttChart

Constructor Summary

Constructors

Constructor	Description
TimeGanttChart(IChartEnvironment chartEnvironment)	Constructs a Gantt Chart with a set of default parameters: no title, daily time units, begin displayed range is equals to 7 days, bar height fraction is equal to 1.
TimeGanttChart(IChartEnvironment chartEnvironment, String title)	Constructs a Gantt Chart with given title and a set of default parameters: daily time units, begin displayed range is equals to 7 days, bar height fraction is equal to 1.
TimeGanttChart(IChartEnvironment chartEnvironment, String title, ChronoUnit timeUnit)	Constructs a Gantt Chart with given title and time units.
TimeGanttChart(IChartEnvironment chartEnvironment, String title, ChronoUnit timeUnit, ChronoUnit beginDisplayedRangeChronoUnit, double beginDisplayedRange, double barHeightFraction)	Constructs a Gantt Chart with manually setting of all initialization parameters.
TimeGanttChart(IChartEnvironment chartEnvironment, ChronoUnit timeUnit)	Constructs a Gantt Chart with given chrono unit and a set of default parameters: no title, begin displayed range is equals to 7 days, bar height fraction is equal to 1.
TimeGanttChart(IChartEnvironment chartEnvironment, ChronoUnit timeUnit, ChronoUnit beginDisplayedRangeChronoUnit, double beginDisplayedRange)	Constructs a Gantt Chart with given horizontal axis time units and begin displayed range.

Method Summary

Modifier and Type	Method	Description
GanttChartTimeXAxis	getXAxis()	Returns the X-axis of this chart.
GanttChartCategoryYAxis	getYAxis()	Returns the Y-axis of this chart.

Methods inherited from class com.amalgamasimulation.charts.AbstractGanttChart

addContextMenuItem, addMouseClickHandler, addVerticalGuidelineChangeHandler, clearContextMenuItems, clearMouseClickHandlers, clearVerticalGuidelineChangeHandlers, getChartInternal, getVerticalGuidelineColor, getVerticalGuidelineLabelFormat, getVerticalGuidelinePosition, getVerticalGuidelineWidth, hideVerticalGuideline, isVerticalGuidelineDisplayed, isVerticalGuidelineLabelVisible, isVerticalGuidelineSnapToGridLines, isVerticalGuidelineValuesVisible, isVerticalGuidelineVisible, removeContextMenuItem, removeMouseClickHandler, removeVerticalGuidelineChangeHandler, setShowGanttChartRowMenuItemVisible, setVerticalGuidelineColor, setVerticalGuidelineColor, setVerticalGuidelineLabelFormat, setVerticalGuidelineLabelVisible, setVerticalGuidelineSnapToGridLines, setVerticalGuidelineValuesVisible, setVerticalGuidelineVisible, setVerticalGuidelineWidth, showVerticalGuidelineDisplayed

Methods inherited from class com.amalgamasimulation.charts.Chart

addKeyPressedHandler, addKeyReleasedHandler, addMouseDragExitedHandler, addMouseDraggedHandler, addMouseDragOverHandler, addMouseDragReleasedHandler, addMouseEnteredHandlers, addMouseExitedHandler, addMousePressedHandler, addMouseReleasedHandler, addMouseScrollHandler, addRedrawFinishedHandler, addTextLabel, addTextLabel, clearKeyPressedHandlers, clearKeyReleasedHandlers, clearMouseDragExitedHandlers, clearMouseDraggedHandlers, clearMouseDragOverHandlers, clearMouseDragReleasedHandlers, clearMouseEnteredHandlers, clearMouseExitedHandlers, clearMousePressedHandlers, clearMouseReleasedHandlers, clearMouseScrollHandlers, clearRedrawFinishedHandlers, copyToClipboard, dispose, getBackgroundColor, getBottomMargin, getContentBackgroundColor, getLeftMargin, getTitle, getTitleColor, getTitleFont, getTitleFontSize, getTopMargin, getVisualSetContainer, initializeChartGroup, isDisposed, isRedrawInProgress, isTitleVisible, isVisible, isVisualSetVisible, redraw, removeKeyPressedHandler, removeKeyReleasedHandler, removeMouseDragExitedHandler, removeMouseDraggedHandler, removeMouseDragOverHandler, removeMouseDragReleasedHandler, removeMouseEnteredHandler, removeMouseExitedHandler, removeMousePressedHandler, removeMouseReleasedHandler, removeMouseScrollHandler, removeRedrawFinishedHandler, removeTextLabel, resizeChart, setBackgroundColor, setBackgroundColor, setBottomMargin, setContentBackgroundColor, setContentBackgroundColor, setContextMenuVisible, setCopyToClipboardContextMenuItemVisible, setLeftMargin, setTitle, setTitleColor, setTitleColor, setTitleFont, setTitleFontSize, setTitleVisible, setTopMargin, setVisibility, setVisualSetContainer, setVisualSetVisible, updateSize

Methods inherited from class java.lang.Object

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

Field Details

xAxis

protected GanttChartTimeXAxis xAxis

yAxis

protected GanttChartCategoryYAxis yAxis

Constructor Details

TimeGanttChart

public TimeGanttChart(IChartEnvironment chartEnvironment)

Constructs a Gantt Chart with a set of default parameters: no title, daily time units, begin displayed range is equals to 7 days, bar height fraction is equal to 1.

Parameters:

chartEnvironment - parent subtype of IChartEnvironment, that is a layer between the parent composite and this chart

TimeGanttChart

public TimeGanttChart(IChartEnvironment chartEnvironment,
 String title)

Constructs a Gantt Chart with given title and a set of default parameters: daily time units, begin displayed range is equals to 7 days, bar height fraction is equal to 1.

Parameters:

chartEnvironment - parent subtype of IChartEnvironment, that is a layer between the parent composite and this chart

title - chart title i.e. label written above the chart

TimeGanttChart

public TimeGanttChart(IChartEnvironment chartEnvironment,
 ChronoUnit timeUnit)

Constructs a Gantt Chart with given chrono unit and a set of default parameters: no title, begin displayed range is equals to 7 days, bar height fraction is equal to 1.

Parameters:

chartEnvironment - parent subtype of IChartEnvironment, that is a layer between the parent composite and this chart

timeUnit - chart horizontal axis time units

TimeGanttChart

public TimeGanttChart(IChartEnvironment chartEnvironment,
 String title,
 ChronoUnit timeUnit)

Constructs a Gantt Chart with given title and time units. Begin displayed range is equals to default value of 7 days, bar height fraction is equal to 1.

Parameters:

chartEnvironment - parent subtype of IChartEnvironment, that is a layer between the parent composite and this chart

title - chart title i.e. label written above the chart

timeUnit - chart horizontal axis time units

TimeGanttChart

public TimeGanttChart(IChartEnvironment chartEnvironment,
 ChronoUnit timeUnit,
 ChronoUnit beginDisplayedRangeChronoUnit,
 double beginDisplayedRange)

Constructs a Gantt Chart with given horizontal axis time units and begin displayed range. Begin displayed range is equals to default value of 7 days, bar height fraction is equal to 1, title is not set.

Parameters:

chartEnvironment - parent subtype of IChartEnvironment, that is a layer between the parent composite and this chart

timeUnit - chart horizontal axis time units

beginDisplayedRangeChronoUnit - chart begin displayed range time units

beginDisplayedRange - chart begin displayed range

TimeGanttChart

public TimeGanttChart(IChartEnvironment chartEnvironment,
 String title,
 ChronoUnit timeUnit,
 ChronoUnit beginDisplayedRangeChronoUnit,
 double beginDisplayedRange,
 double barHeightFraction)

Constructs a Gantt Chart with manually setting of all initialization parameters.

Parameters:

chartEnvironment - parent subtype of IChartEnvironment, that is a layer between the parent composite and this chart

title - chart title i.e. label written above the chart

timeUnit - chart horizontal axis time units

beginDisplayedRangeChronoUnit - chart begin displayed range time units

beginDisplayedRange - chart begin displayed range

barHeightFraction - sets the relative height of gantt-visuals within a single GanttChartRow

Method Details

getXAxis

public GanttChartTimeXAxis getXAxis()

Description copied from class: Chart

Returns the X-axis of this chart.

Specified by:

getXAxis in class Chart<IGanttChartVisualSet,GanttVisualSetContainer>

Returns:

the X-axis of this chart

getYAxis

public GanttChartCategoryYAxis getYAxis()

Description copied from class: Chart

Returns the Y-axis of this chart.

Specified by:

getYAxis in class Chart<IGanttChartVisualSet,GanttVisualSetContainer>

Returns:

the Y-axis of this chart