Klasse TimelineModel<T extends TemporalUnit>

java.lang.Object

com.flexganttfx.model.timeline.TimelineModel<T>

Typparameter:

T - the temporal unit supported by the model (e.g. ChronoUnit).

Bekannte direkte Unterklassen:

ChronoUnitTimelineModel, SimpleUnitTimelineModel

public abstract class TimelineModel<T extends TemporalUnit>
extends Object

The timeline model stores the most important properties related to navigating within time (move forward and backward in time, zoom in and out).

• Now - the "current" time (e.g. system time).
• Start time - the first time point that will be visible to the user.
• Millis per pixel - how much time is represented by a single pixel (important for zooming).
• Horizon - the earliest and latest point in time to which the user can scroll.
• Lowest temporal unit - the lowest unit that the user will be able to see (e.g. MINUTES).
• Highest temporal unit - the highest unit that the user will be able to see (e.g. MONTHS).

This class is also responsible for calculating the location for a given time and vice versa.

Eigenschaftsübersicht

Eigenschaften

Typ	Eigenschaft	Beschreibung
final ObjectProperty<Instant>	horizonEndTime	Returns the object property used for storing the end time of the horizon.
final ObjectProperty<Instant>	horizonStartTime	Returns the object property used for storing the start time of the horizon.
final DoubleProperty	maximumMillisPerPixel	A property used to store the maximum number of milliseconds that will be represented by a single pixel on the screen.
final DoubleProperty	millisPerPixel	Returns the property used to store the millis per pixel value.
final DoubleProperty	minimumMillisPerPixel	A property used to store the minimum number of milliseconds that will be represented by a single pixel on the screen.
final ReadOnlyDoubleProperty	nowLocation	Stores the location of the "now" time.
final ObjectProperty<Instant>	now	Returns the property used to store "now", the current time, e.g. the current system time.
final DoubleProperty	offset
final ReadOnlyObjectProperty<T>	smallestTemporalUnit	Stores the smallest temporal unit supported by the control.
final ObjectProperty<Instant>	startTime	Returns the property used to store the first visible time point.

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
protected	TimelineModel()	Constructs a new timeline model.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
final double	calculateLocationForTime(Instant time)	Returns the pixel location of the given time.
final Instant	calculateTimeForLocation(double location)	Returns the time for the given location.
final Instant	getHorizonEndTime()	Returns the value of horizonEndTimeProperty().
final Instant	getHorizonStartTime()	Returns the value of horizonStartTimeProperty().
final double	getMaximumMillisPerPixel()	Returns the value of maximumMillisPerPixelProperty().
final double	getMillisPerPixel()	Returns the value of millisPerPixelProperty().
final double	getMinimumMillisPerPixel()	Returns the value of minimumMillisPerPixelProperty().
final Instant	getNow()	Returns the value of nowProperty().
final double	getNowLocation()	Returns the value of nowLocationProperty().
final double	getOffset()	Ruft den Wert der offset-Eigenschaft ab.
final T	getSmallestTemporalUnit()	Returns the value of smallestTemporalUnitProperty().
final Instant	getStartTime()	Returns the value of startTimeProperty().
final ObjectProperty<Instant>	horizonEndTimeProperty()	Returns the object property used for storing the end time of the horizon.
final ObjectProperty<Instant>	horizonStartTimeProperty()	Returns the object property used for storing the start time of the horizon.
final DoubleProperty	maximumMillisPerPixelProperty()	A property used to store the maximum number of milliseconds that will be represented by a single pixel on the screen.
final DoubleProperty	millisPerPixelProperty()	Returns the property used to store the millis per pixel value.
final DoubleProperty	minimumMillisPerPixelProperty()	A property used to store the minimum number of milliseconds that will be represented by a single pixel on the screen.
final ReadOnlyDoubleProperty	nowLocationProperty()	Stores the location of the "now" time.
final ObjectProperty<Instant>	nowProperty()	Returns the property used to store "now", the current time, e.g. the current system time.
final DoubleProperty	offsetProperty()
final void	setHorizonEndTime(Instant time)	Sets the value of horizonEndTimeProperty().
final void	setHorizonStartTime(Instant time)	Sets the value of horizonStartTimeProperty().
final void	setMaximumMillisPerPixel(double max)	Sets the value of maximumMillisPerPixelProperty().
final void	setMillisPerPixel(double millis)	Sets the value of the millisPerPixelProperty().
final void	setMinimumMillisPerPixel(double min)	Sets the value of minimumMillisPerPixelProperty().
final void	setNow(Instant now)	Sets the value of nowProperty().
final void	setOffset(double offset)	Legt den Wert der offset-Eigenschaft fest.
final void	setStartTime(Instant time)	Sets the value of startTimeProperty().
final void	setZoomRange(T smallestUnit, int smallestUnitCount, double smallestUnitWidth, T largestUnit, int largestUnitCount, double largestUnitWidth)	Sets the range in which the user can zoom in and out of the timeline.
final ReadOnlyObjectProperty<T>	smallestTemporalUnitProperty()	Stores the smallest temporal unit supported by the control.
final ObjectProperty<Instant>	startTimeProperty()	Returns the property used to store the first visible time point.

Von Klasse geerbte Methoden java.lang.Object

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

Eigenschaftsdetails

offset

public final DoubleProperty offsetProperty

Siehe auch:

• getOffset()
• setOffset(double)
• offsetProperty()

horizonStartTime

public final ObjectProperty<Instant> horizonStartTimeProperty

Returns the object property used for storing the start time of the horizon.

Siehe auch:

• getHorizonStartTime()
• setHorizonStartTime(Instant)
• horizonStartTimeProperty()

horizonEndTime

public final ObjectProperty<Instant> horizonEndTimeProperty

Returns the object property used for storing the end time of the horizon.

Siehe auch:

• getHorizonEndTime()
• setHorizonEndTime(Instant)
• horizonEndTimeProperty()

millisPerPixel

public final DoubleProperty millisPerPixelProperty

Returns the property used to store the millis per pixel value. This value determines how much time is represented by a single pixel in the user interface. Changing the value of this property will cause the control to show more or less time within the visible timeline area, meaning zooming can be controlled by this property.

Siehe auch:

• getMillisPerPixel()
• setMillisPerPixel(double)
• millisPerPixelProperty()

minimumMillisPerPixel

public final DoubleProperty minimumMillisPerPixelProperty

A property used to store the minimum number of milliseconds that will be represented by a single pixel on the screen. Zoom-In operations will be limited by this value.

Seit:

1.4

Siehe auch:

• getMinimumMillisPerPixel()
• setMinimumMillisPerPixel(double)
• minimumMillisPerPixelProperty()

maximumMillisPerPixel

public final DoubleProperty maximumMillisPerPixelProperty

A property used to store the maximum number of milliseconds that will be represented by a single pixel on the screen. Zoom-Out operations will be limited by this value.

Seit:

1.4

Siehe auch:

• getMaximumMillisPerPixel()
• setMaximumMillisPerPixel(double)
• maximumMillisPerPixelProperty()

startTime

public final ObjectProperty<Instant> startTimeProperty

Returns the property used to store the first visible time point.

Siehe auch:

• getStartTime()
• setStartTime(Instant)
• startTimeProperty()

now

public final ObjectProperty<Instant> nowProperty

Returns the property used to store "now", the current time, e.g. the current system time.

Siehe auch:

• getNow()
• setNow(Instant)
• nowProperty()

nowLocation

public final ReadOnlyDoubleProperty nowLocationProperty

Stores the location of the "now" time. The location can be computed based on the millis per pixel and the start time value.

Siehe auch:

• getNowLocation()
• nowLocationProperty()

smallestTemporalUnit

public final ReadOnlyObjectProperty<T extends TemporalUnit> smallestTemporalUnitProperty

Stores the smallest temporal unit supported by the control.

Siehe auch:

• getSmallestTemporalUnit()
• smallestTemporalUnitProperty()

Konstruktordetails

TimelineModel

protected TimelineModel()

Constructs a new timeline model.

Methodendetails

getOffset

public final double getOffset()

Ruft den Wert der offset-Eigenschaft ab.

Eigenschaftsbeschreibung:

Gibt zurück:

Wert der Eigenschaft offset

Siehe auch:

• setOffset(double)
• offsetProperty()

offsetProperty

public final DoubleProperty offsetProperty()

Gibt zurück:

die Eigenschaft offset

Siehe auch:

• getOffset()
• setOffset(double)

setOffset

public final void setOffset(double offset)

Legt den Wert der offset-Eigenschaft fest.

Eigenschaftsbeschreibung:

Parameter:

offset - Wert für die Eigenschaft offset

Siehe auch:

• getOffset()
• offsetProperty()

horizonStartTimeProperty

public final ObjectProperty<Instant> horizonStartTimeProperty()

Returns the object property used for storing the start time of the horizon.

Gibt zurück:

the horizon start time

Siehe auch:

• getHorizonStartTime()
• setHorizonStartTime(Instant)

getHorizonStartTime

public final Instant getHorizonStartTime()

Returns the value of horizonStartTimeProperty().

Gibt zurück:

the horizon start time

setHorizonStartTime

public final void setHorizonStartTime(Instant time)

Sets the value of horizonStartTimeProperty().

Parameter:

time - the horizon start time

horizonEndTimeProperty

public final ObjectProperty<Instant> horizonEndTimeProperty()

Returns the object property used for storing the end time of the horizon.

Gibt zurück:

the horizon end time

Siehe auch:

• getHorizonEndTime()
• setHorizonEndTime(Instant)

getHorizonEndTime

public final Instant getHorizonEndTime()

Returns the value of horizonEndTimeProperty().

Gibt zurück:

the horizon end time

setHorizonEndTime

public final void setHorizonEndTime(Instant time)

Sets the value of horizonEndTimeProperty().

Parameter:

time - the horizon end time

millisPerPixelProperty

public final DoubleProperty millisPerPixelProperty()

Returns the property used to store the millis per pixel value. This value determines how much time is represented by a single pixel in the user interface. Changing the value of this property will cause the control to show more or less time within the visible timeline area, meaning zooming can be controlled by this property.

Gibt zurück:

the millis per pixel property

Siehe auch:

• getMillisPerPixel()
• setMillisPerPixel(double)

setMillisPerPixel

public final void setMillisPerPixel(double millis)

Sets the value of the millisPerPixelProperty().

Parameter:

millis - the millis represented by a pixel

getMillisPerPixel

public final double getMillisPerPixel()

Returns the value of millisPerPixelProperty().

Gibt zurück:

the millis represented by a pixel

minimumMillisPerPixelProperty

public final DoubleProperty minimumMillisPerPixelProperty()

A property used to store the minimum number of milliseconds that will be represented by a single pixel on the screen. Zoom-In operations will be limited by this value.

Gibt zurück:

the minimum MPP value

Seit:

1.4

Siehe auch:

• getMinimumMillisPerPixel()
• setMinimumMillisPerPixel(double)

setMinimumMillisPerPixel

public final void setMinimumMillisPerPixel(double min)

Sets the value of minimumMillisPerPixelProperty().

Parameter:

min - the minimum MPP value

Seit:

1.4

Siehe auch:

• setZoomRange(TemporalUnit, int, double, TemporalUnit, int, double)

getMinimumMillisPerPixel

public final double getMinimumMillisPerPixel()

Returns the value of minimumMillisPerPixelProperty().

Gibt zurück:

the minimum MPP value

Seit:

1.4

Siehe auch:

• setZoomRange(TemporalUnit, int, double, TemporalUnit, int, double)

maximumMillisPerPixelProperty

public final DoubleProperty maximumMillisPerPixelProperty()

A property used to store the maximum number of milliseconds that will be represented by a single pixel on the screen. Zoom-Out operations will be limited by this value.

Gibt zurück:

the maximum MPP value

Seit:

1.4

Siehe auch:

• getMaximumMillisPerPixel()
• setMaximumMillisPerPixel(double)

setMaximumMillisPerPixel

public final void setMaximumMillisPerPixel(double max)

Sets the value of maximumMillisPerPixelProperty().

Parameter:

max - the maximum MPP value

Seit:

1.4

Siehe auch:

• setZoomRange(TemporalUnit, int, double, TemporalUnit, int, double)

getMaximumMillisPerPixel

public final double getMaximumMillisPerPixel()

Returns the value of maximumMillisPerPixelProperty().

Gibt zurück:

the maximum MPP value

Seit:

1.4

Siehe auch:

• setZoomRange(TemporalUnit, int, double, TemporalUnit, int, double)

setZoomRange

public final void setZoomRange(T smallestUnit,
 int smallestUnitCount,
 double smallestUnitWidth,
 T largestUnit,
 int largestUnitCount,
 double largestUnitWidth)

Sets the range in which the user can zoom in and out of the timeline.

Parameter:

smallestUnit - the smallest unit to which the user can zoom (e.g. "MINUTES")

smallestUnitCount - the number of smallest units (e.g. "5" MINUTES)

smallestUnitWidth - the width of the unit in pixels, must be larger than 10 (e.g. "30")

largestUnit - the largest unit to which the user can zoom (e.g. "YEARS")

largestUnitCount - the number of largest units (e.g. "1" YEAR)

largestUnitWidth - the width of the unit in pixels, must be larger than 10 (e.g. "30")

Seit:

1.4

Siehe auch:

• setMinimumMillisPerPixel(double)
• setMaximumMillisPerPixel(double)

startTimeProperty

public final ObjectProperty<Instant> startTimeProperty()

Returns the property used to store the first visible time point.

Gibt zurück:

the start time property

Siehe auch:

• getStartTime()
• setStartTime(Instant)

setStartTime

public final void setStartTime(Instant time)

Sets the value of startTimeProperty().

Parameter:

time - the start time

getStartTime

public final Instant getStartTime()

Returns the value of startTimeProperty().

Gibt zurück:

the start time

nowProperty

public final ObjectProperty<Instant> nowProperty()

Returns the property used to store "now", the current time, e.g. the current system time.

Gibt zurück:

the "now" time

Siehe auch:

• getNow()
• setNow(Instant)

setNow

public final void setNow(Instant now)

Sets the value of nowProperty().

Parameter:

now - the "now" time

getNow

public final Instant getNow()

Returns the value of nowProperty().

Gibt zurück:

the "now" time

nowLocationProperty

public final ReadOnlyDoubleProperty nowLocationProperty()

Stores the location of the "now" time. The location can be computed based on the millis per pixel and the start time value.

Gibt zurück:

the pixel location of "now"

Siehe auch:

• getNowLocation()

getNowLocation

public final double getNowLocation()

Returns the value of nowLocationProperty().

Gibt zurück:

the pixel location of "now"

smallestTemporalUnitProperty

public final ReadOnlyObjectProperty<T> smallestTemporalUnitProperty()

Stores the smallest temporal unit supported by the control.

Gibt zurück:

the smallest temporal unit supported (e.g. "MINUTES").

Siehe auch:

• getSmallestTemporalUnit()

getSmallestTemporalUnit

public final T getSmallestTemporalUnit()

Returns the value of smallestTemporalUnitProperty().

Gibt zurück:

the smallest temporal unit

calculateLocationForTime

public final double calculateLocationForTime(Instant time)

Returns the pixel location of the given time.

Parameter:

time - the time for which to return the pixel location

Gibt zurück:

the location of the given time

calculateTimeForLocation

public final Instant calculateTimeForLocation(double location)

Returns the time for the given location.

Parameter:

location - the location in pixels

Gibt zurück:

the location time