Module com.flexganttfx.view

Package com.flexganttfx.view.timeline

Class Eventline

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.Eventline

All Implemented Interfaces:

Styleable, EventTarget, Skinnable

public class Eventline
extends FlexGanttFXControl

The eventline is a control that displays time cursors and other information that might be relevant for all rows in the Gantt chart. It also supports a "frozen row", which is basically a single row that does not scroll out of sight. To do this the eventline contains a SingleRowGraphics child node. Activities added to the frozen row (see frozenRowProperty()) will show up inside the graphics node. A frozen row is very useful when applications want to show global events.

Since:

1.0

Property Summary

Properties

Type	Property	Description
ReadOnlyDoubleProperty	cursorLocation
ReadOnlyObjectProperty<Instant>	cursorTime
ObjectProperty<DateTimeFormatter>	dateTimeFormatter
ObjectProperty<Row<?,?,?>>	frozenRow
ObjectProperty<TimeInterval>	markedTimeInterval
StringProperty	rowHeaderTitle	Stores the title text used for the row header "column" on the right-hand side.
BooleanProperty	showDSTMarker
BooleanProperty	showMarkedTimeInterval
BooleanProperty	showTimeCursor

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

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

Constructors

Constructor	Description
Eventline(Timeline timeline)	Constructs a new eventline.

Method Summary

Modifier and Type	Method	Description
protected Skin<?>	createDefaultSkin()
ReadOnlyDoubleProperty	cursorLocationProperty()
ReadOnlyObjectProperty<Instant>	cursorTimeProperty()
ObjectProperty<DateTimeFormatter>	dateTimeFormatterProperty()
ObjectProperty<Row<?,?,?>>	frozenRowProperty()
double	getCursorLocation()	Gets the value of the property cursorLocation.
Instant	getCursorTime()	Gets the value of the property cursorTime.
DateTimeFormatter	getDateTimeFormatter()	Gets the value of the property dateTimeFormatter.
Row<?,?,?>	getFrozenRow()	Gets the value of the property frozenRow.
SingleRowGraphics<Row<?,?,?>>	getGraphics()
TimeInterval	getMarkedTimeInterval()	Gets the value of the property markedTimeInterval.
String	getRowHeaderTitle()	Gets the value of the property rowHeaderTitle.
Timeline	getTimeline()
String	getUserAgentStylesheet()
boolean	isShowDSTMarker()	Gets the value of the property showDSTMarker.
boolean	isShowMarkedTimeInterval()	Gets the value of the property showMarkedTimeInterval.
boolean	isShowTimeCursor()	Gets the value of the property showTimeCursor.
ObjectProperty<TimeInterval>	markedTimeIntervalProperty()
StringProperty	rowHeaderTitleProperty()	Stores the title text used for the row header "column" on the right-hand side.
void	setDateTimeFormatter(DateTimeFormatter formatter)	Sets the value of the property dateTimeFormatter.
void	setFrozenRow(Row<?,?,?> frozenRow)	Sets the value of the property frozenRow.
void	setMarkedTimeInterval(TimeInterval timeInterval)	Sets the value of the property markedTimeInterval.
void	setRowHeaderTitle(String rowHeaderTitle)	Sets the value of the property rowHeaderTitle.
void	setShowDSTMarker(boolean show)	Sets the value of the property showDSTMarker.
void	setShowMarkedTimeInterval(boolean show)	Sets the value of the property showMarkedTimeInterval.
void	setShowTimeCursor(boolean show)	Sets the value of the property showTimeCursor.
BooleanProperty	showDSTMarkerProperty()
BooleanProperty	showMarkedTimeIntervalProperty()
BooleanProperty	showTimeCursorProperty()

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

rowHeaderTitle

public final StringProperty rowHeaderTitleProperty

Stores the title text used for the row header "column" on the right-hand side. The header can also be completely replaced by retrieving the graphics from the eventline and registering a new row header factory on it.

Since:

11.11.0

See Also:

getRowHeaderTitle(), setRowHeaderTitle(String)

frozenRow

public final ObjectProperty<Row<?,?,?>> frozenRowProperty

See Also:

getFrozenRow(), setFrozenRow(Row)

cursorLocation

public final ReadOnlyDoubleProperty cursorLocationProperty

See Also:

getCursorLocation()

cursorTime

public final ReadOnlyObjectProperty<Instant> cursorTimeProperty

See Also:

getCursorTime()

showTimeCursor

public final BooleanProperty showTimeCursorProperty

See Also:

isShowTimeCursor(), setShowTimeCursor(boolean)

showDSTMarker

public final BooleanProperty showDSTMarkerProperty

See Also:

isShowDSTMarker(), setShowDSTMarker(boolean)

dateTimeFormatter

public final ObjectProperty<DateTimeFormatter> dateTimeFormatterProperty

See Also:

getDateTimeFormatter(), setDateTimeFormatter(DateTimeFormatter)

showMarkedTimeInterval

public final BooleanProperty showMarkedTimeIntervalProperty

See Also:

isShowMarkedTimeInterval(), setShowMarkedTimeInterval(boolean)

markedTimeInterval

public final ObjectProperty<TimeInterval> markedTimeIntervalProperty

See Also:

getMarkedTimeInterval(), setMarkedTimeInterval(TimeInterval)

Constructor Details

Eventline

public Eventline(Timeline timeline)

Constructs a new eventline.

Parameters:

timeline - the parent timeline container

Since:

1.0

Method Details

createDefaultSkin

protected Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class Control

getUserAgentStylesheet

public String getUserAgentStylesheet()

Overrides:

getUserAgentStylesheet in class Region

getGraphics

public final SingleRowGraphics<Row<?,?,?>> getGraphics()

rowHeaderTitleProperty

public final StringProperty rowHeaderTitleProperty()

Stores the title text used for the row header "column" on the right-hand side. The header can also be completely replaced by retrieving the graphics from the eventline and registering a new row header factory on it.

Since:

11.11.0

See Also:

getRowHeaderTitle(), setRowHeaderTitle(String)

getRowHeaderTitle

public final String getRowHeaderTitle()

Gets the value of the property rowHeaderTitle.

Property description:

Stores the title text used for the row header "column" on the right-hand side. The header can also be completely replaced by retrieving the graphics from the eventline and registering a new row header factory on it.

Since:

11.11.0

setRowHeaderTitle

public final void setRowHeaderTitle(String rowHeaderTitle)

Sets the value of the property rowHeaderTitle.

Property description:

Stores the title text used for the row header "column" on the right-hand side. The header can also be completely replaced by retrieving the graphics from the eventline and registering a new row header factory on it.

Since:

11.11.0

getTimeline

public final Timeline getTimeline()

frozenRowProperty

public final ObjectProperty<Row<?,?,?>> frozenRowProperty()

See Also:

getFrozenRow(), setFrozenRow(Row)

getFrozenRow

public final Row<?,?,?> getFrozenRow()

Gets the value of the property frozenRow.

Property description:

setFrozenRow

public final void setFrozenRow(Row<?,?,?> frozenRow)

Sets the value of the property frozenRow.

Property description:

cursorLocationProperty

public final ReadOnlyDoubleProperty cursorLocationProperty()

See Also:

getCursorLocation()

getCursorLocation

public final double getCursorLocation()

Gets the value of the property cursorLocation.

Property description:

cursorTimeProperty

public final ReadOnlyObjectProperty<Instant> cursorTimeProperty()

See Also:

getCursorTime()

getCursorTime

public final Instant getCursorTime()

Gets the value of the property cursorTime.

Property description:

showTimeCursorProperty

public final BooleanProperty showTimeCursorProperty()

See Also:

isShowTimeCursor(), setShowTimeCursor(boolean)

isShowTimeCursor

public final boolean isShowTimeCursor()

Gets the value of the property showTimeCursor.

Property description:

setShowTimeCursor

public final void setShowTimeCursor(boolean show)

Sets the value of the property showTimeCursor.

Property description:

showDSTMarkerProperty

public final BooleanProperty showDSTMarkerProperty()

See Also:

isShowDSTMarker(), setShowDSTMarker(boolean)

isShowDSTMarker

public final boolean isShowDSTMarker()

Gets the value of the property showDSTMarker.

Property description:

setShowDSTMarker

public final void setShowDSTMarker(boolean show)

Sets the value of the property showDSTMarker.

Property description:

dateTimeFormatterProperty

public final ObjectProperty<DateTimeFormatter> dateTimeFormatterProperty()

See Also:

getDateTimeFormatter(), setDateTimeFormatter(DateTimeFormatter)

getDateTimeFormatter

public final DateTimeFormatter getDateTimeFormatter()

Gets the value of the property dateTimeFormatter.

Property description:

setDateTimeFormatter

public final void setDateTimeFormatter(DateTimeFormatter formatter)

Sets the value of the property dateTimeFormatter.

Property description:

showMarkedTimeIntervalProperty

public final BooleanProperty showMarkedTimeIntervalProperty()

See Also:

isShowMarkedTimeInterval(), setShowMarkedTimeInterval(boolean)

isShowMarkedTimeInterval

public final boolean isShowMarkedTimeInterval()

Gets the value of the property showMarkedTimeInterval.

Property description:

setShowMarkedTimeInterval

public final void setShowMarkedTimeInterval(boolean show)

Sets the value of the property showMarkedTimeInterval.

Property description:

markedTimeIntervalProperty

public final ObjectProperty<TimeInterval> markedTimeIntervalProperty()

See Also:

getMarkedTimeInterval(), setMarkedTimeInterval(TimeInterval)

getMarkedTimeInterval

public final TimeInterval getMarkedTimeInterval()

Gets the value of the property markedTimeInterval.

Property description:

setMarkedTimeInterval

public final void setMarkedTimeInterval(TimeInterval timeInterval)

Sets the value of the property markedTimeInterval.

Property description: