java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
com.flexganttfx.view.util.FlexGanttFXControl
com.flexganttfx.view.timeline.Timeline
- All Implemented Interfaces:
Styleable
,EventTarget
,Skinnable
The timeline control is a container for the 
Dateline
and the
Eventline
. It is displayed above the GraphicsBase
and
provides several methods for scrolling and zooming, both of which can be done
in an animated way (default) or not.

- Since:
- 1.0
- See Also:
-
Property Summary
PropertiesTypePropertyDescriptionfinal ObjectProperty<TimelineModel<?>>
Stores the timeline model to be used by the timeline.final BooleanProperty
A boolean property used to control whether moving from one time to another will happen animated or not.final ObjectProperty<Duration>
An object property used to store the duration used for the animation of a "move" inside the timeline.final DoubleProperty
Determines an optional offset added to time calculations and timeline layout that might be required if for example the graphics area below the timeline does not align properly with the timeline.final BooleanProperty
A property used to control whether the user is allowed to perform a horizontal scroll by dragging the timeline.final ReadOnlyObjectProperty<Instant>
A read-only object property storing anInstant
that represents the last visible time point (on the right edge) inside the timeline.final ReadOnlyObjectProperty<Instant>
A read-only object property storing anInstant
that represents the first visible time point (on the left edge) inside the timeline.Stores the currently visible time interval.final BooleanProperty
A property used to control the visibility of the time zone name.final BooleanProperty
A property used to determine if any zoom operation should be done in an animated fashion or not.final ObjectProperty<Duration>
An object property used to store the duration used for the animation of a "zoom" inside the timeline.final DoubleProperty
A property used to store the zoom factor that will be applied every time the user performs a zoom in or zoom out.final ObjectProperty<Timeline.ZoomMode>
Stores the way a zoom in or out will be executed.Properties inherited from class javafx.scene.control.Control
contextMenu, skin, tooltip
Properties inherited from class javafx.scene.layout.Region
background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width
Properties inherited from class javafx.scene.Parent
needsLayout
Properties inherited from class javafx.scene.Node
accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, focusVisible, focusWithin, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
An enum used to control the way that zooming operations will happen. -
Field Summary
Fields inherited from class javafx.scene.layout.Region
USE_COMPUTED_SIZE, USE_PREF_SIZE
Fields inherited from class javafx.scene.Node
BASELINE_OFFSET_SAME_AS_HEIGHT
-
Constructor Summary
ConstructorsConstructorDescriptionTimeline()
Constructs a new timeline control that is using theChronoUnitTimelineModel
. -
Method Summary
Modifier and TypeMethodDescriptionprotected Skin<?>
final Dateline
Returns the dateline contained within the timeline.final Eventline
Returns the eventline contained within the timeline.final TimelineModel<?>
getModel()
Returns the value ofmodelProperty()
.final Duration
Returns the value ofmoveDurationProperty()
.final double
Gets the value of theoffset
property.final Duration
Calculates and returns the duration of the visible time interval inside the timeline.final Instant
Returns the value ofvisibleEndTimeProperty()
.final Instant
Returns the value ofvisibleStartTimeProperty()
.final TimeInterval
Gets the value of thevisibleTimeInterval
property.final Duration
Returns the value ofzoomDurationProperty()
.final double
Returns the value of thezoomFactorProperty()
.final Timeline.ZoomMode
Returns the value ofzoomModeProperty()
.final boolean
Returns the value ofmoveAnimatedProperty()
.final boolean
Returns the value ofscrollDragEnabledProperty()
.final boolean
Returns the value of thezoneIdVisibleProperty()
.final boolean
Returns the value ofzoomAnimatedProperty()
.final ObjectProperty<TimelineModel<?>>
Stores the timeline model to be used by the timeline.final BooleanProperty
A boolean property used to control whether moving from one time to another will happen animated or not.final ObjectProperty<Duration>
An object property used to store the duration used for the animation of a "move" inside the timeline.final DoubleProperty
Determines an optional offset added to time calculations and timeline layout that might be required if for example the graphics area below the timeline does not align properly with the timeline.final BooleanProperty
A property used to control whether the user is allowed to perform a horizontal scroll by dragging the timeline.final void
Performs a left scroll inside the timeline, meaning that earlier times will become visible.final void
Performs a fast left scroll inside the timeline, meaning that earlier times will become visible.final void
Performs a right scroll inside the timeline, meaning that later times will become visible.final void
Performs a fast right scroll inside the timeline, meaning that later times will become visible.final void
setModel
(TimelineModel<?> model) Sets the value ofmodelProperty()
.final void
setMoveAnimated
(boolean animated) Sets the value ofmoveAnimatedProperty()
.final void
setMoveDuration
(Duration duration) Sets the value ofmoveDurationProperty()
.final void
setOffset
(double offset) Sets the value of theoffset
property.final void
setScrollDragEnabled
(boolean enabled) Sets the value ofscrollDragEnabledProperty()
.final void
setZoneIdVisible
(boolean visible) Sets the value of thezoneIdVisibleProperty()
.final void
setZoomAnimated
(boolean animated) Sets the value ofzoomAnimatedProperty()
.final void
setZoomDuration
(Duration duration) Sets the value ofzoomDurationProperty()
.final void
setZoomFactor
(double zoomFactor) Sets the value of thezoomFactorProperty()
.final void
setZoomMode
(Timeline.ZoomMode mode) Sets the value ofzoomModeProperty()
.final void
showNow()
Makes the timeline scroll to the time point that is currently considered "now".final void
showNow
(boolean center) Makes the timeline scroll to the time point that is currently considered "now".final void
showRange
(TimeInterval interval) Requests that the given time interval will be completely visible within the timeline.final void
Requests that the given time interval will be completely visible within the timeline.final boolean
Requests that the given time interval will be completely visible within the timeline.final void
showTemporalUnit
(TemporalUnit temporalUnit, double width) Submits a request to the timeline to show the given temporal unit (e.g.final void
Makes the timeline scroll to the time point passed to the method.final void
Makes the timeline scroll to the time point passed to the method.final void
Makes the timeline scroll to the beginning of the given date.final void
Makes the timeline scroll to the beginning of the given date.final void
showTime
(ZonedDateTime time) Makes the timeline scroll to the beginning of the given time.final void
showTime
(ZonedDateTime time, boolean center) Makes the timeline scroll to the beginning of the given time.final ReadOnlyObjectProperty<Instant>
A read-only object property storing anInstant
that represents the last visible time point (on the right edge) inside the timeline.final ReadOnlyObjectProperty<Instant>
A read-only object property storing anInstant
that represents the first visible time point (on the left edge) inside the timeline.Stores the currently visible time interval.final BooleanProperty
A property used to control the visibility of the time zone name.final void
Requests that the timeline performs a zoom operation.final BooleanProperty
A property used to determine if any zoom operation should be done in an animated fashion or not.final ObjectProperty<Duration>
An object property used to store the duration used for the animation of a "zoom" inside the timeline.final DoubleProperty
A property used to store the zoom factor that will be applied every time the user performs a zoom in or zoom out.final void
zoomIn()
Requests that the timeline performs a zoom in operation.final ObjectProperty<Timeline.ZoomMode>
Stores the way a zoom in or out will be executed.final void
zoomOut()
Requests that the timeline performs a zoom out operation.Methods inherited from class com.flexganttfx.view.util.FlexGanttFXControl
getUserAgentStylesheet
Methods inherited from class javafx.scene.control.Control
computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, queryAccessibleAttribute, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty
Methods inherited from class javafx.scene.layout.Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty
Methods inherited from class javafx.scene.Parent
getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBounds
Methods inherited from class javafx.scene.Node
accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isFocusVisible, isFocusWithin, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface javafx.css.Styleable
getStyleableNode
-
Property Details
-
zoneIdVisible
A property used to control the visibility of the time zone name. The timeline is capable of displaying the time zone that it represented inside theDateline
in its upper right corner.- Since:
- 1.0
- See Also:
-
offset
Determines an optional offset added to time calculations and timeline layout that might be required if for example the graphics area below the timeline does not align properly with the timeline.- Since:
- 11.11.0
- See Also:
-
scrollDragEnabled
A property used to control whether the user is allowed to perform a horizontal scroll by dragging the timeline. Normally a drag gesture triggers the selection of a time interval used for zooming into time.- Since:
- 1.0
- See Also:
-
visibleStartTime
A read-only object property storing anInstant
that represents the first visible time point (on the left edge) inside the timeline.- Since:
- 1.0
- See Also:
-
visibleEndTime
A read-only object property storing anInstant
that represents the last visible time point (on the right edge) inside the timeline.- Since:
- 1.0
- See Also:
-
visibleTimeInterval
Stores the currently visible time interval. This is an important property if an application wants to implement a lazy loading strategy.- Since:
- 11.12.0
- See Also:
-
moveDuration
An object property used to store the duration used for the animation of a "move" inside the timeline. Moving means that the timeline moves from one visible start time to another.- Since:
- 1.0
- See Also:
-
moveAnimated
A boolean property used to control whether moving from one time to another will happen animated or not.- Since:
- 1.0
- See Also:
-
model
Stores the timeline model to be used by the timeline.- Since:
- 1.0
- See Also:
-
zoomDuration
An object property used to store the duration used for the animation of a "zoom" inside the timeline. Zooming means that the timeline changes the currently visible time window (bigger, smaller). -
zoomAnimated
A property used to determine if any zoom operation should be done in an animated fashion or not. Animation happens by not directly switching to the new time interval but by gradually changing the interval until the new interval has been reached.- Since:
- 1.0
- See Also:
-
zoomMode
Stores the way a zoom in or out will be executed. Zooming can keep the current start time, the current end time, or the time shown in the center of the timeline inside the visible area. Based on this setting the currently shown activities on the left or the right might be pushed out of the visible area when zooming in or more of them might show up either on the left, the right, or both sides.- Since:
- 1.0
- See Also:
-
zoomFactor
A property used to store the zoom factor that will be applied every time the user performs a zoom in or zoom out. The default value of this property is .5, which means that the user will see 50% more or less time inside the visible area.- Since:
- 1.0
- See Also:
-
-
Constructor Details
-
Timeline
public Timeline()Constructs a new timeline control that is using theChronoUnitTimelineModel
.- Since:
- 1.0
-
-
Method Details
-
createDefaultSkin
- Overrides:
createDefaultSkin
in classControl
-
getUserAgentStylesheet
- Overrides:
getUserAgentStylesheet
in classRegion
-
zoneIdVisibleProperty
A property used to control the visibility of the time zone name. The timeline is capable of displaying the time zone that it represented inside theDateline
in its upper right corner.- Returns:
- true if the time zone ID shall be visible
- Since:
- 1.0
- See Also:
-
isZoneIdVisible
public final boolean isZoneIdVisible()Returns the value of thezoneIdVisibleProperty()
.- Returns:
- true if the time zone ID shall be shown to the user
- Since:
- 1.0
-
setZoneIdVisible
public final void setZoneIdVisible(boolean visible) Sets the value of thezoneIdVisibleProperty()
.- Parameters:
visible
- true if the time zone ID shall be shown to the user- Since:
- 1.0
-
offsetProperty
Determines an optional offset added to time calculations and timeline layout that might be required if for example the graphics area below the timeline does not align properly with the timeline.- Returns:
- the offset
- Since:
- 11.11.0
- See Also:
-
getOffset
public final double getOffset()Gets the value of theoffset
property.- Property description:
- Determines an optional offset added to time calculations and timeline layout that might be required if for example the graphics area below the timeline does not align properly with the timeline.
- Returns:
- the value of the
offset
property - Since:
- 11.11.0
- See Also:
-
setOffset
public final void setOffset(double offset) Sets the value of theoffset
property.- Property description:
- Determines an optional offset added to time calculations and timeline layout that might be required if for example the graphics area below the timeline does not align properly with the timeline.
- Parameters:
offset
- the value for theoffset
property- Since:
- 11.11.0
- See Also:
-
getDateline
Returns the dateline contained within the timeline. The timeline is a container that consists of a dateline and an eventline.- Returns:
- the dateline
- Since:
- 1.0
-
getEventline
Returns the eventline contained within the timeline. The timeline is a container that consists of a dateline and an eventline.- Returns:
- the dateline
- Since:
- 1.0
-
scrollDragEnabledProperty
A property used to control whether the user is allowed to perform a horizontal scroll by dragging the timeline. Normally a drag gesture triggers the selection of a time interval used for zooming into time.- Returns:
- true if the user can perform a horizontal scrolling by dragging the timeline
- Since:
- 1.0
- See Also:
-
isScrollDragEnabled
public final boolean isScrollDragEnabled()Returns the value ofscrollDragEnabledProperty()
.- Returns:
- true if the user can trigger horizontal scrolling by dragging the timeline
- Since:
- 1.0
-
setScrollDragEnabled
public final void setScrollDragEnabled(boolean enabled) Sets the value ofscrollDragEnabledProperty()
.- Parameters:
enabled
- if true the user can trigger horizontal scrolling by dragging the timeline- Since:
- 1.0
-
visibleStartTimeProperty
A read-only object property storing anInstant
that represents the first visible time point (on the left edge) inside the timeline.- Returns:
- the visible start time shown by the timeline on its' left edge
- Since:
- 1.0
- See Also:
-
getVisibleStartTime
Returns the value ofvisibleStartTimeProperty()
.- Returns:
- the value of #visibleStartTimeProperty
- Since:
- 1.0
-
visibleEndTimeProperty
A read-only object property storing anInstant
that represents the last visible time point (on the right edge) inside the timeline.- Returns:
- the visible end time shown by the timeline on its' right edge
- Since:
- 1.0
- See Also:
-
getVisibleEndTime
Returns the value ofvisibleEndTimeProperty()
.- Returns:
- the value of #visibleEndTimeProperty
- Since:
- 1.0
-
getVisibleDuration
Calculates and returns the duration of the visible time interval inside the timeline. The duration is the time difference between thevisibleStartTimeProperty()
and thevisibleEndTimeProperty()
.- Returns:
- the visible duration
- Since:
- 1.0
-
visibleTimeIntervalProperty
Stores the currently visible time interval. This is an important property if an application wants to implement a lazy loading strategy.- Returns:
- the currently visible time interval
- Since:
- 11.12.0
- See Also:
-
getVisibleTimeInterval
Gets the value of thevisibleTimeInterval
property.- Property description:
- Stores the currently visible time interval. This is an important property if an application wants to implement a lazy loading strategy.
- Returns:
- the value of the
visibleTimeInterval
property - Since:
- 11.12.0
- See Also:
-
moveDurationProperty
An object property used to store the duration used for the animation of a "move" inside the timeline. Moving means that the timeline moves from one visible start time to another.- Returns:
- the animation duration used for moving to another visible start time
- Since:
- 1.0
- See Also:
-
getMoveDuration
Returns the value ofmoveDurationProperty()
.- Returns:
- the time used for animating a move inside the timeline
- Since:
- 1.0
-
setMoveDuration
Sets the value ofmoveDurationProperty()
.- Parameters:
duration
- the time used for animating a move inside the timeline- Since:
- 1.0
-
moveAnimatedProperty
A boolean property used to control whether moving from one time to another will happen animated or not.- Returns:
- true if the move will be animated
- Since:
- 1.0
- See Also:
-
isMoveAnimated
public final boolean isMoveAnimated()Returns the value ofmoveAnimatedProperty()
.- Returns:
- true if moving in time will be animated
-
setMoveAnimated
public final void setMoveAnimated(boolean animated) Sets the value ofmoveAnimatedProperty()
.- Parameters:
animated
- if true the change from one time to another will be animated
-
showNow
public final void showNow()Makes the timeline scroll to the time point that is currently considered "now". This time point will be shown in the center of the timeline.- Since:
- 1.0
- See Also:
-
showNow
public final void showNow(boolean center) Makes the timeline scroll to the time point that is currently considered "now". This time point will be shown in the center of the timeline.- Parameters:
center
- determines if the time will be shown in the center or on the left-edge of the timeline- Since:
- 1.0
- See Also:
-
showTime
Makes the timeline scroll to the beginning of the given date. The date will appear on the left-hand side of the timeline.- Parameters:
date
- the date to scroll to- Since:
- 11.12.3
- See Also:
-
showTime
Makes the timeline scroll to the beginning of the given date. The date will appear on the left-hand side of the timeline or in the center depending on the value passed to the center argument.- Parameters:
date
- the date to scroll tocenter
- determines where to show the given date- Since:
- 11.12.3
- See Also:
-
showTime
Makes the timeline scroll to the beginning of the given time. The date will appear on the left-hand side of the timeline.- Parameters:
time
- the time to scroll to- Since:
- 11.12.3
- See Also:
-
showTime
Makes the timeline scroll to the beginning of the given time. The time will appear on the left-hand side of the timeline or in the center depending on the value passed to the center argument.- Parameters:
time
- the time to scroll tocenter
- determines where to show the given time- Since:
- 11.12.3
- See Also:
-
showTime
Makes the timeline scroll to the time point passed to the method. This time point will be shown on the left edge of the timeline.- Parameters:
time
- the time to show- Since:
- 1.0
- See Also:
-
showTime
Makes the timeline scroll to the time point passed to the method.- Parameters:
time
- the time to showcenter
- if true the time will be centered within the timeline- Since:
- 1.0
- See Also:
-
showTemporalUnit
Submits a request to the timeline to show the given temporal unit (e.g.ChronoUnit.DAYS
at the given width (e.g. 50px). This is a convenient way to make the Gantt chart show up with a good initial zoom.- Parameters:
temporalUnit
- the temporal unit to showwidth
- the number of pixels to use for each unit (e.g. for one day)- Since:
- 1.0
-
modelProperty
Stores the timeline model to be used by the timeline.- Returns:
- the timeline model
- Since:
- 1.0
- See Also:
-
getModel
Returns the value ofmodelProperty()
.- Returns:
- the timeline model
- Since:
- 1.0
-
setModel
Sets the value ofmodelProperty()
.- Parameters:
model
- the timeline model- Since:
- 1.0
-
zoomDurationProperty
An object property used to store the duration used for the animation of a "zoom" inside the timeline. Zooming means that the timeline changes the currently visible time window (bigger, smaller).- Returns:
- the animation duration used for moving to another visible start time
- See Also:
-
getZoomDuration
Returns the value ofzoomDurationProperty()
.- Returns:
- the duration of the zoom animation
- Since:
- 1.0
-
setZoomDuration
Sets the value ofzoomDurationProperty()
.- Parameters:
duration
- the duration of the zoom animation- Since:
- 1.0
-
zoomAnimatedProperty
A property used to determine if any zoom operation should be done in an animated fashion or not. Animation happens by not directly switching to the new time interval but by gradually changing the interval until the new interval has been reached.- Returns:
- true if the zoom will be animated
- Since:
- 1.0
- See Also:
-
isZoomAnimated
public final boolean isZoomAnimated()Returns the value ofzoomAnimatedProperty()
.- Returns:
- true if the zoom in / out operations will be visualized in an animated way
- Since:
- 1.0
-
setZoomAnimated
public final void setZoomAnimated(boolean animated) Sets the value ofzoomAnimatedProperty()
.- Parameters:
animated
- if true the zoom in / out operations will be visualized in an animated way- Since:
- 1.0
-
zoomModeProperty
Stores the way a zoom in or out will be executed. Zooming can keep the current start time, the current end time, or the time shown in the center of the timeline inside the visible area. Based on this setting the currently shown activities on the left or the right might be pushed out of the visible area when zooming in or more of them might show up either on the left, the right, or both sides.- Returns:
- the currently applied zoom mode (center zoom, keep start time, keep end time)
- Since:
- 1.0
- See Also:
-
getZoomMode
Returns the value ofzoomModeProperty()
.- Returns:
- the currently used zoom mode (center zoom, keep start time, keep end time)
- Since:
- 1.0
-
setZoomMode
Sets the value ofzoomModeProperty()
.- Parameters:
mode
- the new zoom mode (center zoom, keep start time, keep end time)- Since:
- 1.0
-
zoomFactorProperty
A property used to store the zoom factor that will be applied every time the user performs a zoom in or zoom out. The default value of this property is .5, which means that the user will see 50% more or less time inside the visible area.- Returns:
- the zoom factor
- Since:
- 1.0
- See Also:
-
getZoomFactor
public final double getZoomFactor()Returns the value of thezoomFactorProperty()
.- Returns:
- the zoom factor
- Since:
- 1.0
-
setZoomFactor
public final void setZoomFactor(double zoomFactor) Sets the value of thezoomFactorProperty()
.- Parameters:
zoomFactor
- the new zoom factor- Since:
- 1.0
-
zoomIn
public final void zoomIn()Requests that the timeline performs a zoom in operation.- Since:
- 1.0
- See Also:
-
zoomOut
public final void zoomOut()Requests that the timeline performs a zoom out operation.- Since:
- 1.0
- See Also:
-
zoom
Requests that the timeline performs a zoom operation.- Parameters:
factor
- the zoom factor (default is .5)zoomIn
- if true the zoom will show less timefrozenTime
- the point in time that will stay where it was before (use case: pinch zoom)- Since:
- 1.0
- See Also:
-
showRange
Requests that the given time interval will be completely visible within the timeline.- Parameters:
startTime
- the start time of the requested intervalduration
- the duration of the requested interval- Since:
- 1.0
- See Also:
-
showRange
Requests that the given time interval will be completely visible within the timeline.- Parameters:
interval
- the requested interval- Since:
- 1.0
- See Also:
-
showRange
Requests that the given time interval will be completely visible within the timeline.- Parameters:
startTime
- the start time of the requested intervalendTime
- the end time of the requested interval- Returns:
- true if the operation reached the minimum or maximum millis per second supported by the timeline
- Since:
- 1.0
- See Also:
-
scrollRight
public final void scrollRight()Performs a right scroll inside the timeline, meaning that later times will become visible.- Since:
- 1.0
- See Also:
-
scrollRightFast
public final void scrollRightFast()Performs a fast right scroll inside the timeline, meaning that later times will become visible.- Since:
- 1.0
- See Also:
-
scrollLeft
public final void scrollLeft()Performs a left scroll inside the timeline, meaning that earlier times will become visible.- Since:
- 1.0
- See Also:
-
scrollLeftFast
public final void scrollLeftFast()Performs a fast left scroll inside the timeline, meaning that earlier times will become visible.- Since:
- 1.0
- See Also:
-