Module com.flexganttfx.view

Package com.flexganttfx.view.graphics.layer

Class ScaleLayer<R extends Row<?,?,?>>

java.lang.Object

com.flexganttfx.view.graphics.layer.SystemLayer<R>

com.flexganttfx.view.graphics.layer.ScaleLayer<R>

Type Parameters:

R - the type of the rows

public class ScaleLayer<R extends Row<?,?,?>>
extends SystemLayer<R>

Draws a scale for an entire row or for each line within the row. Scales vary depending on the layout used for the row / line. The scale for the chart layout displays the minimum and maximum values while the scale for the agenda layout displays a time scale (8am, 9am, 10am, .....). The labels and dashes in the scale layer have to align perfectly with the lines drawn by the agenda lines layer and the chart lines layer.

Since:

1.0

See Also:

GraphicsBase.getForegroundSystemLayers(), GraphicsBase.getBackgroundSystemLayers(), GraphicsBase.getForegroundSystemLayer(Class), GraphicsBase.getBackgroundSystemLayer(Class)

Constructor Summary

Constructors

Constructor	Description
ScaleLayer(GraphicsBase<R> graphics)

Method Summary

Modifier and Type	Method	Description
ObjectProperty<Paint>	agendaLabelsFillProperty()
BooleanProperty	agendaLabelsVisibleProperty()
DoubleProperty	agendaLinesLineWidthProperty()
DoubleProperty	agendaLinesSizeProperty()
ObjectProperty<Paint>	agendaLinesStrokeProperty()
BooleanProperty	agendaLinesVisibleProperty()
ObjectProperty<Paint>	backgroundFillProperty()
BooleanProperty	bluredBackgroundProperty()
ObjectProperty<DateTimeFormatter>	dateTimeFormatterProperty()
ObjectProperty<Paint>	dividerLineStrokeProperty()
void	drawLayer(RowCanvas<R> canvas, Instant startTime, Instant endTime)
ObjectProperty<Font>	fontProperty()
Paint	getAgendaLabelsFill()
double	getAgendaLinesLineWidth()
double	getAgendaLinesSize()
Paint	getAgendaLinesStroke()
Paint	getBackgroundFill()
DateTimeFormatter	getDateTimeFormatter()
Paint	getDividerLineStroke()
Font	getFont()
Paint	getMajorChartLabelsFill()
double	getMajorChartLinesLineWidth()
double	getMajorChartLinesSize()
Paint	getMajorChartLinesStroke()
Paint	getMinorChartLabelsFill()
double	getMinorChartLinesLineWidth()
double	getMinorChartLinesSize()
Paint	getMinorChartLinesStroke()
NumberFormat	getNumberFormat()	Returns the value of numberFormatProperty().
double	getPrefWidth()
double	getScaleWidth()
boolean	isAgendaLabelsVisible()
boolean	isAgendaLinesVisible()
boolean	isBluredBackground()
boolean	isMajorChartLabelsVisible()
boolean	isMajorChartLinesVisible()
boolean	isMinorChartLabelsVisible()
boolean	isMinorChartLinesVisible()
ObjectProperty<Paint>	majorChartLabelsFillProperty()
BooleanProperty	majorChartLabelsVisibleProperty()
DoubleProperty	majorChartLinesLineWidthProperty()
DoubleProperty	majorChartLinesSizeProperty()
ObjectProperty<Paint>	majorChartLinesStrokeProperty()
BooleanProperty	majorChartLinesVisibleProperty()
ObjectProperty<Paint>	minorChartLabelsFillProperty()
BooleanProperty	minorChartLabelsVisibleProperty()
DoubleProperty	minorChartLinesLineWidthProperty()
DoubleProperty	minorChartLinesSizeProperty()
ObjectProperty<Paint>	minorChartLinesStrokeProperty()
BooleanProperty	minorChartLinesVisibleProperty()
ObjectProperty<NumberFormat>	numberFormatProperty()	A property used to store a number format that will be used to format the labels shown when a chart layout is being used.
DoubleProperty	prefWidthProperty()
ReadOnlyDoubleProperty	scaleWidthProperty()
void	setAgendaLabelsFill(Paint fill)
void	setAgendaLabelsVisible(boolean visible)
void	setAgendaLinesLineWidth(double lineWidth)
void	setAgendaLinesSize(double size)
void	setAgendaLinesStroke(Paint stroke)
void	setAgendaLinesVisible(boolean visible)
void	setBackgroundFill(Paint fill)
void	setBluredBackground(boolean blurred)
void	setDateTimeFormatter(DateTimeFormatter formatter)
void	setDividerLineStroke(Paint stroke)
void	setFont(Font font)
void	setMajorChartLabelsFill(Paint fill)
void	setMajorChartLabelsVisible(boolean visible)
void	setMajorChartLinesLineWidth(double lineWidth)
void	setMajorChartLinesSize(double size)
void	setMajorChartLinesStroke(Paint stroke)
void	setMajorChartLinesVisible(boolean visible)
void	setMinorChartLabelsFill(Paint fill)
void	setMinorChartLabelsVisible(boolean visible)
void	setMinorChartLinesLineWidth(double lineWidth)
void	setMinorChartLinesSize(double size)
void	setMinorChartLinesStroke(Paint stroke)
void	setMinorChartLinesVisible(boolean visible)
void	setNumberFormat(NumberFormat format)	Returns the value of getNumberFormat().
void	setPrefWidth(double width)

Methods inherited from class com.flexganttfx.view.graphics.layer.SystemLayer

fadeInOutObservable, getGraphics, getName, getOpacity, isSnapToPixel, isVisible, opacityProperty, redraw, redrawObservable, setSnapToPixel, setVisible, snapPosition, snapSize, snapSpace, snapToPixelProperty, visibleProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

ScaleLayer

public ScaleLayer(GraphicsBase<R> graphics)

Method Detail

drawLayer

public void drawLayer(RowCanvas<R> canvas,
                      Instant startTime,
                      Instant endTime)

Specified by:

drawLayer in class SystemLayer<R extends Row<?,?,?>>

fontProperty

public final ObjectProperty<Font> fontProperty()

setFont

public final void setFont(Font font)

getFont

public final Font getFont()

dividerLineStrokeProperty

public final ObjectProperty<Paint> dividerLineStrokeProperty()

getDividerLineStroke

public final Paint getDividerLineStroke()

setDividerLineStroke

public final void setDividerLineStroke(Paint stroke)

bluredBackgroundProperty

public final BooleanProperty bluredBackgroundProperty()

isBluredBackground

public final boolean isBluredBackground()

setBluredBackground

public final void setBluredBackground(boolean blurred)

backgroundFillProperty

public final ObjectProperty<Paint> backgroundFillProperty()

getBackgroundFill

public final Paint getBackgroundFill()

setBackgroundFill

public final void setBackgroundFill(Paint fill)

prefWidthProperty

public final DoubleProperty prefWidthProperty()

getPrefWidth

public final double getPrefWidth()

setPrefWidth

public final void setPrefWidth(double width)

scaleWidthProperty

public final ReadOnlyDoubleProperty scaleWidthProperty()

getScaleWidth

public final double getScaleWidth()

majorChartLabelsVisibleProperty

public final BooleanProperty majorChartLabelsVisibleProperty()

setMajorChartLabelsVisible

public final void setMajorChartLabelsVisible(boolean visible)

isMajorChartLabelsVisible

public final boolean isMajorChartLabelsVisible()

minorChartLabelsVisibleProperty

public final BooleanProperty minorChartLabelsVisibleProperty()

setMinorChartLabelsVisible

public final void setMinorChartLabelsVisible(boolean visible)

isMinorChartLabelsVisible

public final boolean isMinorChartLabelsVisible()

majorChartLinesVisibleProperty

public final BooleanProperty majorChartLinesVisibleProperty()

setMajorChartLinesVisible

public final void setMajorChartLinesVisible(boolean visible)

isMajorChartLinesVisible

public final boolean isMajorChartLinesVisible()

majorChartLinesStrokeProperty

public final ObjectProperty<Paint> majorChartLinesStrokeProperty()

getMajorChartLinesStroke

public final Paint getMajorChartLinesStroke()

setMajorChartLinesStroke

public final void setMajorChartLinesStroke(Paint stroke)

majorChartLabelsFillProperty

public final ObjectProperty<Paint> majorChartLabelsFillProperty()

getMajorChartLabelsFill

public final Paint getMajorChartLabelsFill()

setMajorChartLabelsFill

public final void setMajorChartLabelsFill(Paint fill)

minorChartLabelsFillProperty

public final ObjectProperty<Paint> minorChartLabelsFillProperty()

getMinorChartLabelsFill

public final Paint getMinorChartLabelsFill()

setMinorChartLabelsFill

public final void setMinorChartLabelsFill(Paint fill)

majorChartLinesLineWidthProperty

public final DoubleProperty majorChartLinesLineWidthProperty()

getMajorChartLinesLineWidth

public final double getMajorChartLinesLineWidth()

setMajorChartLinesLineWidth

public final void setMajorChartLinesLineWidth(double lineWidth)

majorChartLinesSizeProperty

public final DoubleProperty majorChartLinesSizeProperty()

getMajorChartLinesSize

public final double getMajorChartLinesSize()

setMajorChartLinesSize

public final void setMajorChartLinesSize(double size)

minorChartLinesVisibleProperty

public final BooleanProperty minorChartLinesVisibleProperty()

setMinorChartLinesVisible

public final void setMinorChartLinesVisible(boolean visible)

isMinorChartLinesVisible

public final boolean isMinorChartLinesVisible()

minorChartLinesStrokeProperty

public final ObjectProperty<Paint> minorChartLinesStrokeProperty()

getMinorChartLinesStroke

public final Paint getMinorChartLinesStroke()

setMinorChartLinesStroke

public final void setMinorChartLinesStroke(Paint stroke)

minorChartLinesLineWidthProperty

public final DoubleProperty minorChartLinesLineWidthProperty()

getMinorChartLinesLineWidth

public final double getMinorChartLinesLineWidth()

setMinorChartLinesLineWidth

public final void setMinorChartLinesLineWidth(double lineWidth)

minorChartLinesSizeProperty

public final DoubleProperty minorChartLinesSizeProperty()

getMinorChartLinesSize

public final double getMinorChartLinesSize()

setMinorChartLinesSize

public final void setMinorChartLinesSize(double size)

agendaLabelsVisibleProperty

public final BooleanProperty agendaLabelsVisibleProperty()

setAgendaLabelsVisible

public final void setAgendaLabelsVisible(boolean visible)

isAgendaLabelsVisible

public final boolean isAgendaLabelsVisible()

agendaLinesLineWidthProperty

public final DoubleProperty agendaLinesLineWidthProperty()

getAgendaLinesLineWidth

public final double getAgendaLinesLineWidth()

setAgendaLinesLineWidth

public final void setAgendaLinesLineWidth(double lineWidth)

agendaLinesSizeProperty

public final DoubleProperty agendaLinesSizeProperty()

getAgendaLinesSize

public final double getAgendaLinesSize()

setAgendaLinesSize

public final void setAgendaLinesSize(double size)

agendaLinesStrokeProperty

public final ObjectProperty<Paint> agendaLinesStrokeProperty()

getAgendaLinesStroke

public final Paint getAgendaLinesStroke()

setAgendaLinesStroke

public final void setAgendaLinesStroke(Paint stroke)

agendaLabelsFillProperty

public final ObjectProperty<Paint> agendaLabelsFillProperty()

getAgendaLabelsFill

public final Paint getAgendaLabelsFill()

setAgendaLabelsFill

public final void setAgendaLabelsFill(Paint fill)

agendaLinesVisibleProperty

public final BooleanProperty agendaLinesVisibleProperty()

setAgendaLinesVisible

public final void setAgendaLinesVisible(boolean visible)

isAgendaLinesVisible

public final boolean isAgendaLinesVisible()

dateTimeFormatterProperty

public final ObjectProperty<DateTimeFormatter> dateTimeFormatterProperty()

setDateTimeFormatter

public final void setDateTimeFormatter(DateTimeFormatter formatter)

getDateTimeFormatter

public final DateTimeFormatter getDateTimeFormatter()

numberFormatProperty

public final ObjectProperty<NumberFormat> numberFormatProperty()

A property used to store a number format that will be used to format the labels shown when a chart layout is being used.

Returns:

the number format

Since:

1.4

setNumberFormat

public final void setNumberFormat(NumberFormat format)

Returns the value of getNumberFormat().

Parameters:

format - the number format to use for chart values

Since:

1.4

getNumberFormat

public final NumberFormat getNumberFormat()

Returns the value of numberFormatProperty().

Returns:

the number format for chart values

Since:

1.4