AgendaLayout (FlexGanttFX API)

java.lang.Object
- com.flexganttfx.model.Layout
- - com.flexganttfx.model.layout.AgendaLayout

```
public class AgendaLayout
extends Layout
```
The agenda layout class is used to lay out activities in a style similar to a regular calendar where a vertical scale will display hours. Activities are used to represent appointments for a given day.
Note: Activities shown in agenda layout might be rendered several times. This is, for example, the case when an activity spans several days.

Since:

1.0

See Also:

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

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`ObjectProperty<AgendaLayout.ConflictStrategy>`	`conflictStrategy` The property used to store the strategy that will be applied when the time intervals of activities in agenda layout intersect.
`ObjectProperty<LocalTime>`	`endTime` Returns the property used for storing the end time of the agenda.
`ObjectProperty<Duration>`	`minDuration` A property used to store the minimum duration of activities in the agenda layout.
`DoubleProperty`	`minLineSpacing`
`DoubleProperty`	`overlapOffset` A property used to store an offset value that is used to indent activities when they overlap each other.
`ObjectProperty<LocalTime>`	`startTime` Returns the property used for storing the start time of the agenda.

Properties inherited from class com.flexganttfx.model.Layout
padding

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AgendaLayout.ConflictStrategy
An enumerator for the different ways conflicting agenda entries can be laid out.

Nested Classes
Modifier and Type	Class and Description
`static class`	`AgendaLayout.ConflictStrategy` An enumerator for the different ways conflicting agenda entries can be laid out.

Constructor Summary

Constructors
Constructor and Description

AgendaLayout()
Constructs a new agenda layout instance.

Constructors
Constructor and Description
`AgendaLayout()` Constructs a new agenda layout instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ObjectProperty<AgendaLayout.ConflictStrategy>`	`conflictStrategyProperty()` The property used to store the strategy that will be applied when the time intervals of activities in agenda layout intersect.
`ObjectProperty<LocalTime>`	`endTimeProperty()` Returns the property used for storing the end time of the agenda.
`AgendaLayout.ConflictStrategy`	`getConflictStrategy()` Returns the value of the `conflictStrategyProperty()`.
`LocalTime`	`getEndTime()` Returns the value of the `endTimeProperty()`.
`Duration`	`getMinDuration()` Returns the value of the `minDurationProperty()`.
`double`	`getMinLineSpacing()` Gets the value of the property minLineSpacing.
`double`	`getOverlapOffset()` Returns the value of `overlapOffsetProperty()`.
`LocalTime`	`getStartTime()` Returns the value of the `startTimeProperty()`.
`ObjectProperty<Duration>`	`minDurationProperty()` A property used to store the minimum duration of activities in the agenda layout.
`DoubleProperty`	`minLineSpacingProperty()`
`DoubleProperty`	`overlapOffsetProperty()` A property used to store an offset value that is used to indent activities when they overlap each other.
`void`	`setConflictStrategy(AgendaLayout.ConflictStrategy strategy)` Sets the value of the `conflictStrategyProperty()`.
`void`	`setEndTime(LocalTime time)` Sets the value of `endTimeProperty()`.
`void`	`setMinDuration(Duration duration)` Sets the value of the `minDurationProperty()`.
`void`	`setMinLineSpacing(double min)` Sets the value of the property minLineSpacing.
`void`	`setOverlapOffset(double offset)` Sets the value of `overlapOffsetProperty()`.
`void`	`setStartTime(LocalTime time)` Sets the value of the `startTimeProperty()`.
`ObjectProperty<LocalTime>`	`startTimeProperty()` Returns the property used for storing the start time of the agenda.
`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

- Property Detail
  - minLineSpacing
```
public final DoubleProperty minLineSpacingProperty
```
    See Also:
    
    getMinLineSpacing(), setMinLineSpacing(double)
  - startTime
```
public final ObjectProperty<LocalTime> startTimeProperty
```
    Returns the property used for storing the start time of the agenda. The start time is used for the vertical time scale. The default value of this property is LocalTime.MIN, which is equivalent to midnight.
    
    Since:
    
    1.0
    
    See Also:
    
    getStartTime(), setStartTime(LocalTime)
  - endTime
```
public final ObjectProperty<LocalTime> endTimeProperty
```
    Returns the property used for storing the end time of the agenda. The end time is used for the vertical time scale. The default value of this property is LocalTime.MAX, which is equivalent to the time just before midnight.
    
    Since:
    
    1.0
    
    See Also:
    
    getEndTime(), setEndTime(LocalTime)
  - minDuration
```
public final ObjectProperty<Duration> minDurationProperty
```
    A property used to store the minimum duration of activities in the agenda layout.
    
    Since:
    
    1.0
    
    See Also:
    
    getMinDuration(), setMinDuration(Duration)
  - conflictStrategy
```
public final ObjectProperty<AgendaLayout.ConflictStrategy> conflictStrategyProperty
```
    The property used to store the strategy that will be applied when the time intervals of activities in agenda layout intersect. The strategy determines if the overlapping activities will be drawn on top of each other or in parallel (swim lanes).
    
    Since:
    
    1.0
    
    See Also:
    
    getConflictStrategy(), setConflictStrategy(ConflictStrategy)
  - overlapOffset
```
public final DoubleProperty overlapOffsetProperty
```
    A property used to store an offset value that is used to indent activities when they overlap each other.
    
    Since:
    
    1.0
    
    See Also:
    
    getOverlapOffset(), setOverlapOffset(double)
- Constructor Detail
  - AgendaLayout
```
public AgendaLayout()
```
    Constructs a new agenda layout instance.
    
    Since:
    
    1.0
- Method Detail
  - minLineSpacingProperty
```
public final DoubleProperty minLineSpacingProperty()
```
    See Also:
    
    getMinLineSpacing(), setMinLineSpacing(double)
  - setMinLineSpacing
```
public final void setMinLineSpacing(double min)
```
    Sets the value of the property minLineSpacing.
  - getMinLineSpacing
```
public final double getMinLineSpacing()
```
    Gets the value of the property minLineSpacing.
  - startTimeProperty
```
public final ObjectProperty<LocalTime> startTimeProperty()
```
    Returns the property used for storing the start time of the agenda. The start time is used for the vertical time scale. The default value of this property is LocalTime.MIN, which is equivalent to midnight.
    
    Since:
    
    1.0
    
    See Also:
    
    getStartTime(), setStartTime(LocalTime)
  - getStartTime
```
public final LocalTime getStartTime()
```
    Returns the value of the startTimeProperty().
    
    Returns:
    
    the agenda start time
    
    Since:
    
    1.0
  - setStartTime
```
public final void setStartTime(LocalTime time)
```
    Sets the value of the startTimeProperty().
    
    Parameters:
    
    time - the new agenda start time
    
    Since:
    
    1.0
  - endTimeProperty
```
public final ObjectProperty<LocalTime> endTimeProperty()
```
    Returns the property used for storing the end time of the agenda. The end time is used for the vertical time scale. The default value of this property is LocalTime.MAX, which is equivalent to the time just before midnight.
    
    Since:
    
    1.0
    
    See Also:
    
    getEndTime(), setEndTime(LocalTime)
  - getEndTime
```
public final LocalTime getEndTime()
```
    Returns the value of the endTimeProperty().
    
    Returns:
    
    the agenda end time
    
    Since:
    
    1.0
  - setEndTime
```
public final void setEndTime(LocalTime time)
```
    Sets the value of endTimeProperty().
    
    Parameters:
    
    time - the new agenda end time
    
    Since:
    
    1.0
  - minDurationProperty
```
public final ObjectProperty<Duration> minDurationProperty()
```
    A property used to store the minimum duration of activities in the agenda layout.
    
    Since:
    
    1.0
    
    See Also:
    
    getMinDuration(), setMinDuration(Duration)
  - getMinDuration
```
public final Duration getMinDuration()
```
    Returns the value of the minDurationProperty().
    
    Returns:
    
    the minimum duration of agenda activities
    
    Since:
    
    1.0
  - setMinDuration
```
public final void setMinDuration(Duration duration)
```
    Sets the value of the minDurationProperty().
    
    Parameters:
    
    duration - the new minimum duration of agenda activities
    
    Since:
    
    1.0
  - conflictStrategyProperty
```
public final ObjectProperty<AgendaLayout.ConflictStrategy> conflictStrategyProperty()
```
    The property used to store the strategy that will be applied when the time intervals of activities in agenda layout intersect. The strategy determines if the overlapping activities will be drawn on top of each other or in parallel (swim lanes).
    
    Since:
    
    1.0
    
    See Also:
    
    getConflictStrategy(), setConflictStrategy(ConflictStrategy)
  - getConflictStrategy
```
public AgendaLayout.ConflictStrategy getConflictStrategy()
```
    Returns the value of the conflictStrategyProperty().
    
    Returns:
    
    the currently used conflict strategy
    
    Since:
    
    1.0
  - setConflictStrategy
```
public void setConflictStrategy(AgendaLayout.ConflictStrategy strategy)
```
    Sets the value of the conflictStrategyProperty().
    
    Parameters:
    
    strategy - the conflict strategy to use
    
    Since:
    
    1.0
  - overlapOffsetProperty
```
public final DoubleProperty overlapOffsetProperty()
```
    A property used to store an offset value that is used to indent activities when they overlap each other.
    
    Since:
    
    1.0
    
    See Also:
    
    getOverlapOffset(), setOverlapOffset(double)
  - setOverlapOffset
```
public final void setOverlapOffset(double offset)
```
    Sets the value of overlapOffsetProperty().
    
    Parameters:
    
    offset - the offset in pixels
    
    Since:
    
    1.0
  - getOverlapOffset
```
public final double getOverlapOffset()
```
    Returns the value of overlapOffsetProperty().
    
    Returns:
    
    the offset in pixels
    
    Since:
    
    1.0
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AgendaLayout

Property Summary

Properties inherited from class com.flexganttfx.model.Layout

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class com.flexganttfx.model.Layout

Methods inherited from class java.lang.Object

Property Detail

minLineSpacing

startTime

endTime

minDuration

conflictStrategy

overlapOffset

Constructor Detail

AgendaLayout

Method Detail

minLineSpacingProperty

setMinLineSpacing

getMinLineSpacing

startTimeProperty

getStartTime

setStartTime

endTimeProperty

getEndTime

setEndTime

minDurationProperty

getMinDuration

setMinDuration

conflictStrategyProperty

getConflictStrategy

setConflictStrategy

overlapOffsetProperty

setOverlapOffset

getOverlapOffset

toString