Module com.flexganttfx.model

Package com.flexganttfx.model

Class Layout

java.lang.Object

com.flexganttfx.model.Layout

Direct Known Subclasses:

AgendaLayout, ChartLayout, GanttLayout

public abstract class Layout
extends Object

Each row and each inner line of a row are associated with a layout. The layout influences several aspects during rendering and editing of activities. Additionally several of the system layers used to draw the row background also utilize the layout information.

The following layout types are supported:

• GanttLayout: activities are laid out horizontally below the timeline.
  
• AgendaLayout: activities are laid out vertically next to a time scale displaying the time of day. Hour lines are drawn in the background.
  
• ChartLayout: activities are laid out as bars below the timeline. Chart lines are drawn in the background.
  

Since:

1.0

See Also:

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

Property Summary

Properties

Type	Property	Description
DoubleProperty	padding	Returns the property used to specify a padding that will be added to the top and the bottom of a row or an inner line.

Constructor Summary

Constructors

Constructor	Description
Layout()

Method Summary

Modifier and Type	Method	Description
double	getPadding()	Returns the value of paddingProperty().
abstract boolean	isSupportingHorizontalCursorLine()	Determines if the UI should be able to show a horizontal cursor line.
DoubleProperty	paddingProperty()	Returns the property used to specify a padding that will be added to the top and the bottom of a row or an inner line.
void	setPadding(double padding)	Sets the value of the paddingProperty().

Methods inherited from class java.lang.Object

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

Property Details

padding

public final DoubleProperty paddingProperty

Returns the property used to specify a padding that will be added to the top and the bottom of a row or an inner line.

Since:

1.0

See Also:

getPadding(), setPadding(double)

Constructor Details

Layout

public Layout()

Method Details

paddingProperty

public final DoubleProperty paddingProperty()

Returns the property used to specify a padding that will be added to the top and the bottom of a row or an inner line.

Since:

1.0

See Also:

getPadding(), setPadding(double)

getPadding

public final double getPadding()

Returns the value of paddingProperty().

Returns:

the padding value

Since:

1.0

setPadding

public final void setPadding(double padding)

Sets the value of the paddingProperty().

Parameters:

padding - the new padding value

Since:

1.0

isSupportingHorizontalCursorLine

public abstract boolean isSupportingHorizontalCursorLine()

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

Returns:

true if a horizontal cursor line makes sense

Since:

1.4