com.flexganttfx.view.timeline

Class Timeline

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

com.flexganttfx.view.FlexGanttFXControl

com.flexganttfx.view.timeline.Timeline

All Implemented Interfaces:

Styleable, EventTarget, Skinnable

public class Timeline
extends FlexGanttFXControl

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. The timeline also keeps track of the time interval currently selected by the user (see getSelectedTimeInterval()) and the current time (see setTimeTracker(TimeTracker)).

Since:

1.0

See Also:

GanttChart.getTimeline(), setMoveAnimated(boolean), setZoomAnimated(boolean)

Property Summary

Type	Property and Description
ObjectProperty<TimelineModel<?>>	model
BooleanProperty	moveAnimated
ObjectProperty<Duration>	moveDuration
ReadOnlyObjectProperty<TimeInterval>	selectedTimeInterval
ObjectProperty<TimeTracker>	timeTracker
ReadOnlyObjectProperty<Instant>	visibleEndTime
ReadOnlyObjectProperty<Instant>	visibleStartTime
BooleanProperty	zoomAnimated
ObjectProperty<Duration>	zoomDuration
DoubleProperty	zoomFactor
BooleanProperty	zoomLassoEnabled
ObjectProperty<Timeline.ZoomMode>	zoomMode

Properties inherited from class javafx.scene.control.Control

contextMenu, skinClassName, 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

impl_traversalEngine, needsLayout

Properties inherited from class javafx.scene.Node

blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, hover, id, impl_showMnemonics, impl_treeVisible, 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, visible

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Timeline.ZoomMode An enum used to control the way that zooming operations will happen.

Field Summary

Fields

Modifier and Type	Field and Description
BooleanProperty	moveAnimated
BooleanProperty	zoomAnimated

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

Constructors

Constructor and Description
Timeline() Constructs a new timeline control that is using the ChronoUnitTimelineModel.

Method Summary

Modifier and Type	Method and Description
protected Skin<?>	createDefaultSkin()
Dateline	getDateline()
Eventline	getEventline()
TimelineModel<?>	getModel() Gets the value of the property model.
Duration	getMoveDuration() Gets the value of the property moveDuration.
List<org.controlsfx.control.PropertySheet.Item>	getPropertySheetItems()
TimeInterval	getSelectedTimeInterval() Gets the value of the property selectedTimeInterval.
TimeTracker	getTimeTracker() Gets the value of the property timeTracker.
Duration	getVisibleDuration()
Instant	getVisibleEndTime() Gets the value of the property visibleEndTime.
Instant	getVisibleStartTime() Gets the value of the property visibleStartTime.
Duration	getZoomDuration() Gets the value of the property zoomDuration.
double	getZoomFactor() Gets the value of the property zoomFactor.
Timeline.ZoomMode	getZoomMode() Gets the value of the property zoomMode.
boolean	isMoveAnimated() Gets the value of the property moveAnimated.
boolean	isZoomAnimated() Gets the value of the property zoomAnimated.
boolean	isZoomLassoEnabled() Gets the value of the property zoomLassoEnabled.
ObjectProperty<TimelineModel<?>>	modelProperty()
BooleanProperty	moveAnimatedProperty()
ObjectProperty<Duration>	moveDurationProperty()
void	scrollLeft()
void	scrollLeftFast()
void	scrollRight()
void	scrollRightFast()
ReadOnlyObjectProperty<TimeInterval>	selectedTimeIntervalProperty()
void	setModel(TimelineModel<?> timelineModel) Sets the value of the property model.
void	setMoveAnimated(boolean animated) Sets the value of the property moveAnimated.
void	setMoveDuration(Duration duration) Sets the value of the property moveDuration.
void	setTimeTracker(TimeTracker tracker) Sets the value of the property timeTracker.
void	setZoomAnimated(boolean animated) Sets the value of the property zoomAnimated.
void	setZoomDuration(Duration duration) Sets the value of the property zoomDuration.
void	setZoomFactor(double zoomFactor) Sets the value of the property zoomFactor.
void	setZoomLassoEnabled(boolean enabled) Sets the value of the property zoomLassoEnabled.
void	setZoomMode(Timeline.ZoomMode mode) Sets the value of the property zoomMode.
void	showNow()
void	showNow(boolean center)
void	showRange(Instant startTime, Duration duration)
void	showRange(Instant startTime, Instant endTime)
void	showRange(TimeInterval interval)
void	showTemporalUnit(TemporalUnit temporalUnit, double width)
void	showTime(Instant time)
void	showTime(Instant time, boolean center)
void	startTimeTracking()
void	stopTimeTracking()
ObjectProperty<TimeTracker>	timeTrackerProperty()
ReadOnlyObjectProperty<Instant>	visibleEndTimeProperty()
ReadOnlyObjectProperty<Instant>	visibleStartTimeProperty()
void	zoom(double factor, boolean zoomIn, Instant frozenTime)
BooleanProperty	zoomAnimatedProperty()
ObjectProperty<Duration>	zoomDurationProperty()
DoubleProperty	zoomFactorProperty()
void	zoomIn()
BooleanProperty	zoomLassoEnabledProperty()
ObjectProperty<Timeline.ZoomMode>	zoomModeProperty()
void	zoomOut()

Methods inherited from class com.flexganttfx.view.FlexGanttFXControl

getUserAgentStylesheet

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, getCssMetaData, getSkin, getTooltip, impl_cssGetFocusTraversableInitialValue, impl_processCSS, isResizable, layoutChildren, setContextMenu, setSkin, setTooltip, skinClassNameProperty, 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, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, 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, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getChildren, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setImpl_traversalEngine, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, 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, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, 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, screenToLocal, screenToLocal, screenToLocal, 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, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

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

Property Detail

visibleStartTime

public final ReadOnlyObjectProperty<Instant> visibleStartTimeProperty

See Also:

getVisibleStartTime()

visibleEndTime

public final ReadOnlyObjectProperty<Instant> visibleEndTimeProperty

See Also:

getVisibleEndTime()

moveDuration

public final ObjectProperty<Duration> moveDurationProperty

See Also:

getMoveDuration(), setMoveDuration(Duration)

moveAnimated

public final BooleanProperty moveAnimatedProperty

See Also:

isMoveAnimated(), setMoveAnimated(boolean)

model

public final ObjectProperty<TimelineModel<?>> modelProperty

See Also:

getModel(), setModel(TimelineModel)

selectedTimeInterval

public final ReadOnlyObjectProperty<TimeInterval> selectedTimeIntervalProperty

See Also:

getSelectedTimeInterval()

zoomDuration

public final ObjectProperty<Duration> zoomDurationProperty

See Also:

getZoomDuration(), setZoomDuration(Duration)

zoomAnimated

public final BooleanProperty zoomAnimatedProperty

See Also:

isZoomAnimated(), setZoomAnimated(boolean)

zoomLassoEnabled

public final BooleanProperty zoomLassoEnabledProperty

See Also:

isZoomLassoEnabled(), setZoomLassoEnabled(boolean)

zoomMode

public final ObjectProperty<Timeline.ZoomMode> zoomModeProperty

See Also:

getZoomMode(), setZoomMode(ZoomMode)

zoomFactor

public final DoubleProperty zoomFactorProperty

See Also:

getZoomFactor(), setZoomFactor(double)

timeTracker

public final ObjectProperty<TimeTracker> timeTrackerProperty

See Also:

getTimeTracker(), setTimeTracker(TimeTracker)

Field Detail

moveAnimated

public final BooleanProperty moveAnimated

zoomAnimated

public final BooleanProperty zoomAnimated

Constructor Detail

Timeline

public Timeline()

Constructs a new timeline control that is using the ChronoUnitTimelineModel.

Since:

1.0

Method Detail

createDefaultSkin

protected Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class Control

getDateline

public final Dateline getDateline()

getEventline

public final Eventline getEventline()

visibleStartTimeProperty

public final ReadOnlyObjectProperty<Instant> visibleStartTimeProperty()

See Also:

getVisibleStartTime()

getVisibleStartTime

public final Instant getVisibleStartTime()

Gets the value of the property visibleStartTime.

visibleEndTimeProperty

public final ReadOnlyObjectProperty<Instant> visibleEndTimeProperty()

See Also:

getVisibleEndTime()

getVisibleEndTime

public final Instant getVisibleEndTime()

Gets the value of the property visibleEndTime.

getVisibleDuration

public final Duration getVisibleDuration()

moveDurationProperty

public final ObjectProperty<Duration> moveDurationProperty()

See Also:

getMoveDuration(), setMoveDuration(Duration)

setMoveDuration

public final void setMoveDuration(Duration duration)

Sets the value of the property moveDuration.

getMoveDuration

public final Duration getMoveDuration()

Gets the value of the property moveDuration.

moveAnimatedProperty

public final BooleanProperty moveAnimatedProperty()

See Also:

isMoveAnimated(), setMoveAnimated(boolean)

isMoveAnimated

public final boolean isMoveAnimated()

Gets the value of the property moveAnimated.

setMoveAnimated

public final void setMoveAnimated(boolean animated)

Sets the value of the property moveAnimated.

showNow

public final void showNow()

showNow

public final void showNow(boolean center)

showTime

public final void showTime(Instant time)

showTime

public final void showTime(Instant time,
                           boolean center)

showTemporalUnit

public final void showTemporalUnit(TemporalUnit temporalUnit,
                                   double width)

getModel

public final TimelineModel<?> getModel()

Gets the value of the property model.

setModel

public final void setModel(TimelineModel<?> timelineModel)

Sets the value of the property model.

modelProperty

public final ObjectProperty<TimelineModel<?>> modelProperty()

See Also:

getModel(), setModel(TimelineModel)

selectedTimeIntervalProperty

public final ReadOnlyObjectProperty<TimeInterval> selectedTimeIntervalProperty()

See Also:

getSelectedTimeInterval()

getSelectedTimeInterval

public final TimeInterval getSelectedTimeInterval()

Gets the value of the property selectedTimeInterval.

zoomDurationProperty

public final ObjectProperty<Duration> zoomDurationProperty()

See Also:

getZoomDuration(), setZoomDuration(Duration)

setZoomDuration

public final void setZoomDuration(Duration duration)

Sets the value of the property zoomDuration.

getZoomDuration

public final Duration getZoomDuration()

Gets the value of the property zoomDuration.

zoomAnimatedProperty

public final BooleanProperty zoomAnimatedProperty()

See Also:

isZoomAnimated(), setZoomAnimated(boolean)

isZoomAnimated

public final boolean isZoomAnimated()

Gets the value of the property zoomAnimated.

zoomLassoEnabledProperty

public final BooleanProperty zoomLassoEnabledProperty()

See Also:

isZoomLassoEnabled(), setZoomLassoEnabled(boolean)

isZoomLassoEnabled

public final boolean isZoomLassoEnabled()

Gets the value of the property zoomLassoEnabled.

setZoomLassoEnabled

public final void setZoomLassoEnabled(boolean enabled)

Sets the value of the property zoomLassoEnabled.

zoomModeProperty

public final ObjectProperty<Timeline.ZoomMode> zoomModeProperty()

See Also:

getZoomMode(), setZoomMode(ZoomMode)

getZoomMode

public final Timeline.ZoomMode getZoomMode()

Gets the value of the property zoomMode.

setZoomMode

public final void setZoomMode(Timeline.ZoomMode mode)

Sets the value of the property zoomMode.

zoomFactorProperty

public final DoubleProperty zoomFactorProperty()

See Also:

getZoomFactor(), setZoomFactor(double)

getZoomFactor

public final double getZoomFactor()

Gets the value of the property zoomFactor.

setZoomFactor

public final void setZoomFactor(double zoomFactor)

Sets the value of the property zoomFactor.

setZoomAnimated

public final void setZoomAnimated(boolean animated)

Sets the value of the property zoomAnimated.

zoomIn

public final void zoomIn()

zoomOut

public final void zoomOut()

zoom

public final void zoom(double factor,
                       boolean zoomIn,
                       Instant frozenTime)

showRange

public final void showRange(Instant startTime,
                            Duration duration)

showRange

public final void showRange(TimeInterval interval)

showRange

public final void showRange(Instant startTime,
                            Instant endTime)

timeTrackerProperty

public final ObjectProperty<TimeTracker> timeTrackerProperty()

See Also:

getTimeTracker(), setTimeTracker(TimeTracker)

setTimeTracker

public final void setTimeTracker(TimeTracker tracker)

Sets the value of the property timeTracker.

getTimeTracker

public final TimeTracker getTimeTracker()

Gets the value of the property timeTracker.

startTimeTracking

public final void startTimeTracking()

stopTimeTracking

public final void stopTimeTracking()

scrollRight

public final void scrollRight()

scrollRightFast

public final void scrollRightFast()

scrollLeft

public final void scrollLeft()

scrollLeftFast

public final void scrollLeftFast()

getPropertySheetItems

public final List<org.controlsfx.control.PropertySheet.Item> getPropertySheetItems()