Klasse Timeline

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
Alle implementierten Schnittstellen:
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.

 

Timeline
Seit:
1.0
Siehe auch:

  • Eigenschaftsdetails

  • Konstruktordetails

    • Timeline

      public Timeline()
      Constructs a new timeline control that is using the ChronoUnitTimelineModel.
      Seit:
      1.0

  • Methodendetails

    • createDefaultSkin

      protected Skin<?> createDefaultSkin()
      Setzt außer Kraft:
      createDefaultSkin in Klasse Control

    • getUserAgentStylesheet

      public String getUserAgentStylesheet()
      Setzt außer Kraft:
      getUserAgentStylesheet in Klasse Region

    • zoneIdVisibleProperty

      public final BooleanProperty 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 the Dateline in its upper right corner.
      Gibt zurück:
      true if the time zone ID shall be visible
      Seit:
      1.0
      Siehe auch:

    • isZoneIdVisible

      public final boolean isZoneIdVisible()
      Returns the value of the zoneIdVisibleProperty().
      Gibt zurück:
      true if the time zone ID shall be shown to the user
      Seit:
      1.0

    • setZoneIdVisible

      public final void setZoneIdVisible(boolean visible)
      Sets the value of the zoneIdVisibleProperty().
      Parameter:
      visible - true if the time zone ID shall be shown to the user
      Seit:
      1.0

    • offsetProperty

      public final DoubleProperty 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.
      Gibt zurück:
      the offset
      Seit:
      11.11.0
      Siehe auch:

    • getOffset

      public final double getOffset()
      Ruft den Wert der offset-Eigenschaft ab.
      Eigenschaftsbeschreibung:
      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.
      Gibt zurück:
      Wert der Eigenschaft offset
      Seit:
      11.11.0
      Siehe auch:

    • setOffset

      public final void setOffset(double offset)
      Legt den Wert der offset-Eigenschaft fest.
      Eigenschaftsbeschreibung:
      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.
      Parameter:
      offset - Wert für die Eigenschaft offset
      Seit:
      11.11.0
      Siehe auch:

    • 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.
      Gibt zurück:
      the dateline
      Seit:
      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.
      Gibt zurück:
      the dateline
      Seit:
      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.
      Gibt zurück:
      true if the user can perform a horizontal scrolling by dragging the timeline
      Seit:
      1.0
      Siehe auch:

    • isScrollDragEnabled

      public final boolean isScrollDragEnabled()
      Returns the value of scrollDragEnabledProperty().
      Gibt zurück:
      true if the user can trigger horizontal scrolling by dragging the timeline
      Seit:
      1.0

    • setScrollDragEnabled

      public final void setScrollDragEnabled(boolean enabled)
      Sets the value of scrollDragEnabledProperty().
      Parameter:
      enabled - if true, the user can trigger horizontal scrolling by dragging the timeline
      Seit:
      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.
      Gibt zurück:
      the visible start time shown by the timeline on its' left edge
      Seit:
      1.0
      Siehe auch:

    • getVisibleStartTime

      public final Instant getVisibleStartTime()
      Returns the value of visibleStartTimeProperty().
      Gibt zurück:
      the value of #visibleStartTimeProperty
      Seit:
      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.
      Gibt zurück:
      the visible end time shown by the timeline on its' right edge
      Seit:
      1.0
      Siehe auch:

    • getVisibleEndTime

      public final Instant getVisibleEndTime()
      Returns the value of visibleEndTimeProperty().
      Gibt zurück:
      the value of #visibleEndTimeProperty
      Seit:
      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().
      Gibt zurück:
      the visible duration
      Seit:
      1.0

    • visibleTimeIntervalProperty

      public final ReadOnlyObjectProperty<TimeInterval> visibleTimeIntervalProperty()
      Stores the currently visible time interval. This is an important property if an application wants to implement a lazy loading strategy.
      Gibt zurück:
      the currently visible time interval
      Seit:
      11.12.0
      Siehe auch:

    • getVisibleTimeInterval

      public final TimeInterval getVisibleTimeInterval()
      Ruft den Wert der visibleTimeInterval-Eigenschaft ab.
      Eigenschaftsbeschreibung:
      Stores the currently visible time interval. This is an important property if an application wants to implement a lazy loading strategy.
      Gibt zurück:
      Wert der Eigenschaft visibleTimeInterval
      Seit:
      11.12.0
      Siehe auch:

    • 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.
      Gibt zurück:
      the animation duration used for moving to another visible start time
      Seit:
      1.0
      Siehe auch:

    • getMoveDuration

      public final Duration getMoveDuration()
      Returns the value of moveDurationProperty().
      Gibt zurück:
      the time used for animating a move inside the timeline
      Seit:
      1.0

    • setMoveDuration

      public final void setMoveDuration(Duration duration)
      Sets the value of moveDurationProperty().
      Parameter:
      duration - the time used for animating a move inside the timeline
      Seit:
      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.
      Gibt zurück:
      true if the move will be animated
      Seit:
      1.0
      Siehe auch:

    • isMoveAnimated

      public final boolean isMoveAnimated()
      Returns the value of moveAnimatedProperty().
      Gibt zurück:
      true if moving in time will be animated

    • setMoveAnimated

      public final void setMoveAnimated(boolean animated)
      Sets the value of moveAnimatedProperty().
      Parameter:
      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.
      Seit:
      1.0
      Siehe auch:

    • 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.
      Parameter:
      center - determines if the time will be shown in the center or on the left-edge of the timeline
      Seit:
      1.0
      Siehe auch:

    • showTime

      public final void showTime(LocalDate date)
      Makes the timeline scroll to the beginning of the given date. The date will appear on the left-hand side of the timeline.
      Parameter:
      date - the date to scroll to
      Seit:
      11.12.3
      Siehe auch:

    • showTime

      public final void showTime(LocalDate date, boolean center)
      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.
      Parameter:
      date - the date to scroll to
      center - determines where to show the given date
      Seit:
      11.12.3
      Siehe auch:

    • showTime

      public final void showTime(ZonedDateTime time)
      Makes the timeline scroll to the beginning of the given time. The date will appear on the left-hand side of the timeline.
      Parameter:
      time - the time to scroll to
      Seit:
      11.12.3
      Siehe auch:

    • showTime

      public final void showTime(ZonedDateTime time, boolean center)
      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.
      Parameter:
      time - the time to scroll to
      center - determines where to show the given time
      Seit:
      11.12.3
      Siehe auch:

    • 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.
      Parameter:
      time - the time to show
      Seit:
      1.0
      Siehe auch:

    • showTime

      public final void showTime(Instant time, boolean center)
      Makes the timeline scroll to the time point passed to the method.
      Parameter:
      time - the time to show
      center - if true, the time will be centered within the timeline
      Seit:
      1.0
      Siehe auch:

    • 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.
      Parameter:
      temporalUnit - the temporal unit to show
      width - the number of pixels to use for each unit (e.g. for one day)
      Seit:
      1.0

    • modelProperty

      public final ObjectProperty<TimelineModel<?>> modelProperty()
      Stores the timeline model to be used by the timeline.
      Gibt zurück:
      the timeline model
      Seit:
      1.0
      Siehe auch:

    • getModel

      public final TimelineModel<?> getModel()
      Returns the value of modelProperty().
      Gibt zurück:
      the timeline model
      Seit:
      1.0

    • setModel

      public final void setModel(TimelineModel<?> model)
      Sets the value of modelProperty().
      Parameter:
      model - the timeline model
      Seit:
      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).
      Gibt zurück:
      the animation duration used for moving to another visible start time
      Siehe auch:

    • getZoomDuration

      public final Duration getZoomDuration()
      Returns the value of zoomDurationProperty().
      Gibt zurück:
      the duration of the zoom animation
      Seit:
      1.0

    • setZoomDuration

      public final void setZoomDuration(Duration duration)
      Sets the value of zoomDurationProperty().
      Parameter:
      duration - the duration of the zoom animation
      Seit:
      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.
      Gibt zurück:
      true if the zoom will be animated
      Seit:
      1.0
      Siehe auch:

    • isZoomAnimated

      public final boolean isZoomAnimated()
      Returns the value of zoomAnimatedProperty().
      Gibt zurück:
      true if the zoom in / out operations will be visualized in an animated way
      Seit:
      1.0

    • setZoomAnimated

      public final void setZoomAnimated(boolean animated)
      Sets the value of zoomAnimatedProperty().
      Parameter:
      animated - if true, the zoom in / out operations will be visualized in an animated way
      Seit:
      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.
      Gibt zurück:
      the currently applied zoom mode (center zoom, keep start time, keep end time)
      Seit:
      1.0
      Siehe auch:

    • getZoomMode

      public final Timeline.ZoomMode getZoomMode()
      Returns the value of zoomModeProperty().
      Gibt zurück:
      the currently used zoom mode (center zoom, keep start time, keep end time)
      Seit:
      1.0

    • setZoomMode

      public final void setZoomMode(Timeline.ZoomMode mode)
      Sets the value of zoomModeProperty().
      Parameter:
      mode - the new zoom mode (center zoom, keep start time, keep end time)
      Seit:
      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.
      Gibt zurück:
      the zoom factor
      Seit:
      1.0
      Siehe auch:

    • getZoomFactor

      public final double getZoomFactor()
      Returns the value of the zoomFactorProperty().
      Gibt zurück:
      the zoom factor
      Seit:
      1.0

    • setZoomFactor

      public final void setZoomFactor(double zoomFactor)
      Sets the value of the zoomFactorProperty().
      Parameter:
      zoomFactor - the new zoom factor
      Seit:
      1.0

    • zoomIn

      public final void zoomIn()
      Requests that the timeline performs a zoom in operation.
      Seit:
      1.0
      Siehe auch:

    • zoomOut

      public final void zoomOut()
      Requests that the timeline performs a zoom out operation.
      Seit:
      1.0
      Siehe auch:

    • zoom

      public final void zoom(double factor, boolean zoomIn, Instant frozenTime)
      Requests that the timeline performs a zoom operation.
      Parameter:
      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)
      Seit:
      1.0
      Siehe auch:

    • showRange

      public final void showRange(Instant startTime, Duration duration)
      Requests that the given time interval will be completely visible within the timeline.
      Parameter:
      startTime - the start time of the requested interval
      duration - the duration of the requested interval
      Seit:
      1.0
      Siehe auch:

    • showRange

      public final void showRange(TimeInterval interval)
      Requests that the given time interval will be completely visible within the timeline.
      Parameter:
      interval - the requested interval
      Seit:
      1.0
      Siehe auch:

    • showRange

      public final boolean showRange(Instant startTime, Instant endTime)
      Requests that the given time interval will be completely visible within the timeline.
      Parameter:
      startTime - the start time of the requested interval
      endTime - the end time of the requested interval
      Gibt zurück:
      true if the operation reached the minimum or maximum millis per second supported by the timeline
      Seit:
      1.0
      Siehe auch:

    • scrollRight

      public final void scrollRight()
      Performs a right scroll inside the timeline, meaning that later times will become visible.
      Seit:
      1.0
      Siehe auch:

    • scrollRightFast

      public final void scrollRightFast()
      Performs a fast right scroll inside the timeline, meaning that later times will become visible.
      Seit:
      1.0
      Siehe auch:

    • scrollLeft

      public final void scrollLeft()
      Performs a left scroll inside the timeline, meaning that earlier times will become visible.
      Seit:
      1.0
      Siehe auch:

    • scrollLeftFast

      public final void scrollLeftFast()
      Performs a fast left scroll inside the timeline, meaning that earlier times will become visible.
      Seit:
      1.0
      Siehe auch: