Class Timeline

    • Constructor Detail

      • Timeline

        public Timeline()
        Constructs a new timeline control that is using the ChronoUnitTimelineModel.
        Since:
        1.0
    • Method Detail

      • getDateline

        public final Dateline 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

        public final Eventline 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

        public final BooleanProperty 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
      • isScrollDragEnabled

        public final boolean isScrollDragEnabled()
        Returns the value of scrollDragEnabledProperty().
        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 of scrollDragEnabledProperty().
        Parameters:
        enabled - if true the user can trigger horizontal scrolling by dragging the timeline
        Since:
        1.0
      • visibleStartTimeProperty

        public final ReadOnlyObjectProperty<Instant> visibleStartTimeProperty()
        A read-only object property storing an Instant 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
      • getVisibleStartTime

        public final Instant getVisibleStartTime()
        Returns the value of visibleStartTimeProperty().
        Returns:
        the value of #visibleStartTimeProperty
        Since:
        1.0
      • visibleEndTimeProperty

        public final ReadOnlyObjectProperty<Instant> visibleEndTimeProperty()
        A read-only object property storing an Instant 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
      • getVisibleEndTime

        public final Instant getVisibleEndTime()
        Returns the value of visibleEndTimeProperty().
        Returns:
        the value of #visibleEndTimeProperty
        Since:
        1.0
      • getVisibleDuration

        public final Duration getVisibleDuration()
        Calculates and returns the duration of the visible time interval inside the timeline. The duration is the time difference between the visibleStartTimeProperty() and the visibleEndTimeProperty().
        Returns:
        the visible duration
        Since:
        1.0
      • moveDurationProperty

        public final ObjectProperty<Duration> 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:
        showNow(boolean), showTime(Instant), showTime(Instant, boolean)
      • setMoveDuration

        public final void setMoveDuration​(Duration duration)
        Sets the value of moveDurationProperty().
        Parameters:
        duration - the time used for animating a move inside the timeline
        Since:
        1.0
      • getMoveDuration

        public final Duration getMoveDuration()
        Returns the value of moveDurationProperty().
        Returns:
        the time used for animating a move inside the timeline
        Since:
        1.0
      • moveAnimatedProperty

        public final BooleanProperty 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
      • isMoveAnimated

        public final boolean isMoveAnimated()
        Returns the value of moveAnimatedProperty().
        Returns:
        true if moving in time will be animated
      • setMoveAnimated

        public final void setMoveAnimated​(boolean animated)
        Sets the value of moveAnimatedProperty().
        Parameters:
        animated - if true the change from one time to another will be animated
      • 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:
        showNow(), showTime(Instant), showTime(Instant, boolean)
      • showTime

        public final void showTime​(Instant time)
        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:
        showNow(), showNow(boolean), showTime(Instant, boolean)
      • showTime

        public final void showTime​(Instant time,
                                   boolean center)
        Makes the timeline scroll to the time point passed to the method.
        Parameters:
        time - the time to show
        center - if true the time will be centered within the timeline
        Since:
        1.0
        See Also:
        showNow(), showNow(boolean), showTime(Instant)
      • showTemporalUnit

        public final void showTemporalUnit​(TemporalUnit temporalUnit,
                                           double width)
        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 show
        width - the number of pixels to use for each unit (e.g. for one day)
        Since:
        1.0
      • setModel

        public final void setModel​(TimelineModel<?> model)
        Sets the value of modelProperty().
        Parameters:
        model - the timeline model
        Since:
        1.0
      • zoomDurationProperty

        public final ObjectProperty<Duration> 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:
        zoomIn(), zoomOut(), showRange(Instant, java.time.Duration)
      • setZoomDuration

        public final void setZoomDuration​(Duration duration)
        Sets the value of zoomDurationProperty().
        Parameters:
        duration - the duration of the zoom animation
        Since:
        1.0
      • getZoomDuration

        public final Duration getZoomDuration()
        Returns the value of zoomDurationProperty().
        Returns:
        the duration of the zoom animation
        Since:
        1.0
      • zoomAnimatedProperty

        public final BooleanProperty 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
      • isZoomAnimated

        public final boolean isZoomAnimated()
        Returns the value of zoomAnimatedProperty().
        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 of zoomAnimatedProperty().
        Parameters:
        animated - if true the zoom in / out operations will be visualized in an animated way
        Since:
        1.0
      • zoomModeProperty

        public final ObjectProperty<Timeline.ZoomMode> 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
      • getZoomMode

        public final Timeline.ZoomMode getZoomMode()
        Returns the value of zoomModeProperty().
        Returns:
        the currently used zoom mode (center zoom, keep start time, keep end time)
        Since:
        1.0
      • setZoomMode

        public final void setZoomMode​(Timeline.ZoomMode mode)
        Sets the value of zoomModeProperty().
        Parameters:
        mode - the new zoom mode (center zoom, keep start time, keep end time)
        Since:
        1.0
      • zoomFactorProperty

        public final DoubleProperty 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
      • getZoomFactor

        public final double getZoomFactor()
        Returns the value of the zoomFactorProperty().
        Returns:
        the zoom factor
        Since:
        1.0
      • setZoomFactor

        public final void setZoomFactor​(double zoomFactor)
        Sets the value of the zoomFactorProperty().
        Parameters:
        zoomFactor - the new zoom factor
        Since:
        1.0
      • zoom

        public final void zoom​(double factor,
                               boolean zoomIn,
                               Instant frozenTime)
        Requests that the timeline performs a zoom operation.
        Parameters:
        factor - the zoom factor (default is .5)
        zoomIn - if true the zoom will show less time
        frozenTime - the point in time that will stay where it was before (use case: pinch zoom)
        Since:
        1.0
        See Also:
        zoomIn(), zoomOut(), zoomFactorProperty(), zoomModeProperty()
      • showRange

        public final void showRange​(Instant startTime,
                                    Duration duration)
        Requests that the given time interval will be completely visible within the timeline.
        Parameters:
        startTime - the start time of the requested interval
        duration - the duration of the requested interval
        Since:
        1.0
        See Also:
        showRange(TimeInterval), showRange(Instant, Instant)
      • showRange

        public final boolean showRange​(Instant startTime,
                                       Instant endTime)
        Requests that the given time interval will be completely visible within the timeline.
        Parameters:
        startTime - the start time of the requested interval
        endTime - 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:
        showRange(Instant, java.time.Duration), showRange(TimeInterval)
      • 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:
        scrollRight(), scrollLeft(), scrollLeftFast()
      • 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:
        scrollLeft(), scrollRightFast(), scrollRight()
      • getPropertySheetItems

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