Module com.flexganttfx.model

Package com.flexganttfx.model.layout

Class ChartLayout

java.lang.Object

com.flexganttfx.model.Layout

com.flexganttfx.model.layout.ChartLayout

public class ChartLayout
extends Layout

Using the chart layout class results in activities being laid out as chart bars. A series of such bars can for example be used to form a capacity profile. Activities of type ChartActivity will be placed on a zeroline between getMinValue() and getMaxValue(). The height of the activity will be based on the value returned by ChartActivity.getChartValue(). Activities of type HighLowChartActivity will appear as floating bars. The layout also supports the definition of minor and major chart lines drawn in the row background.

Since:

1.0

See Also:

ChartActivity, HighLowChartActivity, Row.setLayout(Layout), Row.getLineLayout(int), LinesManager.getLineLayout(int)

Constructor Summary

Constructors

Constructor	Description
ChartLayout()	Constructs a new chart layout with a range of 0 to 100.

Method Summary

Modifier and Type	Method	Description
ObservableList<Double>	getMajorTicks()	Returns the major ticks to be displayed in the row background and by the row scale.
double	getMaxValue()	Returns the value of the maxValueProperty().
ObservableList<Double>	getMinorTicks()	Returns the minor ticks to be displayed in the row background and by the row scale.
double	getMinValue()	Returns the value of minValueProperty().
boolean	isSupportingHorizontalCursorLine()	Determines if the UI should be able to show a horizontal cursor line.
DoubleProperty	maxValueProperty()	Returns the property used to store the maximum value that will be used for the scale and the layout of the row.
DoubleProperty	minValueProperty()	Returns the property used to store the minimum value that will be used for the scale and the layout of the row.
void	setMaxValue(double value)	Sets the value of the maxValueProperty().
void	setMinValue(double value)	Sets the value of minValueProperty().
String	toString()

Methods inherited from class com.flexganttfx.model.Layout

getPadding, paddingProperty, setPadding

Methods inherited from class java.lang.Object

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

Constructor Detail

ChartLayout

public ChartLayout()

Constructs a new chart layout with a range of 0 to 100.

Since:

1.0

Method Detail

maxValueProperty

public final DoubleProperty maxValueProperty()

Returns the property used to store the maximum value that will be used for the scale and the layout of the row.

Returns:

the maximum value displayed by the row / line.

Since:

1.0

getMaxValue

public final double getMaxValue()

Returns the value of the maxValueProperty().

Returns:

the maximum value

Since:

1.0

setMaxValue

public final void setMaxValue(double value)

Sets the value of the maxValueProperty().

Parameters:

value - the new maximum value

Since:

1.0

minValueProperty

public final DoubleProperty minValueProperty()

Returns the property used to store the minimum value that will be used for the scale and the layout of the row.

Returns:

the minimum value displayed by the row / line.

Since:

1.0

getMinValue

public final double getMinValue()

Returns the value of minValueProperty().

Returns:

the minimum value

Since:

1.0

setMinValue

public final void setMinValue(double value)

Sets the value of minValueProperty().

Parameters:

value - the new minimum value

Since:

1.0

getMajorTicks

public final ObservableList<Double> getMajorTicks()

Returns the major ticks to be displayed in the row background and by the row scale.

Returns:

a list of major tick values

Since:

1.0

getMinorTicks

public final ObservableList<Double> getMinorTicks()

Returns the minor ticks to be displayed in the row background and by the row scale.

Returns:

a list of minor tick values

Since:

1.0

isSupportingHorizontalCursorLine

public boolean isSupportingHorizontalCursorLine()

Description copied from class: Layout

Determines if the UI should be able to show a horizontal cursor line. Currently only the ChartLayout and the AgendaLayout support this.

Specified by:

isSupportingHorizontalCursorLine in class Layout

Returns:

true if a horizontal cursor line makes sense

toString

public String toString()

Overrides:

toString in class Object