com.flexganttfx.view.timeline

Class Dateline

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

All Implemented Interfaces:

Styleable, EventTarget, Skinnable

public class Dateline
extends FlexGanttFXControl

The dateline is a control that displays the actual dates (Mo, Tu, We, ...) in cells in one or more rows. The dateline is timezone aware (see setZoneId(ZoneId)), keeps track of currently selected time intervals (getSelectedIntervals()) and fires events of type DatelineScrollingEvent whenever the visible time range changes (see setOnVisibleRangeChanged(EventHandler)). Furthermore the dateline control constantly updates the hoverTimeIntervalProperty() whenever the mouse moves over it.

Since:

1.0

Property Summary

Type	Property and Description
ObjectProperty<DayOfWeek>	firstDayOfWeek
ReadOnlyObjectProperty<TimeInterval>	hoverTimeInterval
ObjectProperty<DatelineModel<? extends TemporalUnit>>	model
ObjectProperty<EventHandler<DatelineScrollingEvent>>	onVisibleRangeChanged
ReadOnlyObjectProperty<TemporalUnit>	primaryTemporalUnit
ObjectProperty<SelectionMode>	selectionMode
ObjectProperty<ZoneId>	zoneId
BooleanProperty	zoneIdVisible

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

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

Modifier	Constructor and Description
protected	Dateline(Timeline timeline) Constructs a new dateline.

Method Summary

Modifier and Type	Method and Description
protected Skin<?>	createDefaultSkin()
ObjectProperty<DayOfWeek>	firstDayOfWeekProperty()
ObservableList<Calendar<?>>	getCalendars()
Callback<TemporalUnit,DatelineCell>	getCellFactory(Class<? extends TemporalUnit> temporalUnitType)
DayOfWeek	getFirstDayOfWeek() Gets the value of the property firstDayOfWeek.
TimeInterval	getHoverTimeInterval() Gets the value of the property hoverTimeInterval.
DatelineModel<? extends TemporalUnit>	getModel() Gets the value of the property model.
EventHandler<DatelineScrollingEvent>	getOnVisibleRangeChanged() Gets the value of the property onVisibleRangeChanged.
TemporalUnit	getPrimaryTemporalUnit() Gets the value of the property primaryTemporalUnit.
List<org.controlsfx.control.PropertySheet.Item>	getPropertySheetItems()
ObservableList<Resolution<?>>	getScaleResolutions()
ObservableList<TimeInterval>	getSelectedIntervals()
SelectionMode	getSelectionMode() Gets the value of the property selectionMode.
Timeline	getTimeline()
ZoneId	getZoneId() Gets the value of the property zoneId.
ReadOnlyObjectProperty<TimeInterval>	hoverTimeIntervalProperty()
boolean	isZoneIdVisible() Gets the value of the property zoneIdVisible.
ObjectProperty<DatelineModel<? extends TemporalUnit>>	modelProperty()
ObjectProperty<EventHandler<DatelineScrollingEvent>>	onVisibleRangeChangedProperty()
ReadOnlyObjectProperty<TemporalUnit>	primaryTemporalUnitProperty()
ObjectProperty<SelectionMode>	selectionModeProperty()
<T extends TemporalUnit> void	setCellFactory(Class<T> temporalUnitType, Callback<T,DatelineCell<T>> factory)
void	setFirstDayOfWeek(DayOfWeek day) Sets the value of the property firstDayOfWeek.
void	setModel(DatelineModel<? extends TemporalUnit> datelineModel) Sets the value of the property model.
void	setOnVisibleRangeChanged(EventHandler<DatelineScrollingEvent> value) Sets the value of the property onVisibleRangeChanged.
void	setSelectionMode(SelectionMode mode) Sets the value of the property selectionMode.
void	setZoneId(ZoneId zoneId) Sets the value of the property zoneId.
void	setZoneIdVisible(boolean visible) Sets the value of the property zoneIdVisible.
ObjectProperty<ZoneId>	zoneIdProperty()
BooleanProperty	zoneIdVisibleProperty()

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

onVisibleRangeChanged

public final ObjectProperty<EventHandler<DatelineScrollingEvent>> onVisibleRangeChangedProperty

See Also:

getOnVisibleRangeChanged(), setOnVisibleRangeChanged(EventHandler)

model

public final ObjectProperty<DatelineModel<? extends TemporalUnit>> modelProperty

See Also:

getModel(), setModel(DatelineModel)

firstDayOfWeek

public final ObjectProperty<DayOfWeek> firstDayOfWeekProperty

See Also:

getFirstDayOfWeek(), setFirstDayOfWeek(DayOfWeek)

zoneId

public final ObjectProperty<ZoneId> zoneIdProperty

See Also:

getZoneId(), setZoneId(ZoneId)

zoneIdVisible

public final BooleanProperty zoneIdVisibleProperty

See Also:

isZoneIdVisible(), setZoneIdVisible(boolean)

primaryTemporalUnit

public final ReadOnlyObjectProperty<TemporalUnit> primaryTemporalUnitProperty

See Also:

getPrimaryTemporalUnit()

hoverTimeInterval

public final ReadOnlyObjectProperty<TimeInterval> hoverTimeIntervalProperty

See Also:

getHoverTimeInterval()

selectionMode

public final ObjectProperty<SelectionMode> selectionModeProperty

See Also:

getSelectionMode(), setSelectionMode(SelectionMode)

Constructor Detail

Dateline

protected Dateline(Timeline timeline)

Constructs a new dateline.

Parameters:

timeline - the parent timeline

Since:

1.0

Method Detail

createDefaultSkin

protected Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class Control

setCellFactory

public final <T extends TemporalUnit> void setCellFactory(Class<T> temporalUnitType,
                                                          Callback<T,DatelineCell<T>> factory)

getCellFactory

public final Callback<TemporalUnit,DatelineCell> getCellFactory(Class<? extends TemporalUnit> temporalUnitType)

onVisibleRangeChangedProperty

public final ObjectProperty<EventHandler<DatelineScrollingEvent>> onVisibleRangeChangedProperty()

See Also:

getOnVisibleRangeChanged(), setOnVisibleRangeChanged(EventHandler)

setOnVisibleRangeChanged

public final void setOnVisibleRangeChanged(EventHandler<DatelineScrollingEvent> value)

Sets the value of the property onVisibleRangeChanged.

getOnVisibleRangeChanged

public final EventHandler<DatelineScrollingEvent> getOnVisibleRangeChanged()

Gets the value of the property onVisibleRangeChanged.

getTimeline

public final Timeline getTimeline()

modelProperty

public final ObjectProperty<DatelineModel<? extends TemporalUnit>> modelProperty()

See Also:

getModel(), setModel(DatelineModel)

getModel

public final DatelineModel<? extends TemporalUnit> getModel()

Gets the value of the property model.

setModel

public final void setModel(DatelineModel<? extends TemporalUnit> datelineModel)

Sets the value of the property model.

firstDayOfWeekProperty

public final ObjectProperty<DayOfWeek> firstDayOfWeekProperty()

See Also:

getFirstDayOfWeek(), setFirstDayOfWeek(DayOfWeek)

getFirstDayOfWeek

public final DayOfWeek getFirstDayOfWeek()

Gets the value of the property firstDayOfWeek.

setFirstDayOfWeek

public final void setFirstDayOfWeek(DayOfWeek day)

Sets the value of the property firstDayOfWeek.

zoneIdProperty

public final ObjectProperty<ZoneId> zoneIdProperty()

See Also:

getZoneId(), setZoneId(ZoneId)

getZoneId

public final ZoneId getZoneId()

Gets the value of the property zoneId.

setZoneId

public final void setZoneId(ZoneId zoneId)

Sets the value of the property zoneId.

zoneIdVisibleProperty

public final BooleanProperty zoneIdVisibleProperty()

See Also:

isZoneIdVisible(), setZoneIdVisible(boolean)

isZoneIdVisible

public final boolean isZoneIdVisible()

Gets the value of the property zoneIdVisible.

setZoneIdVisible

public final void setZoneIdVisible(boolean visible)

Sets the value of the property zoneIdVisible.

primaryTemporalUnitProperty

public final ReadOnlyObjectProperty<TemporalUnit> primaryTemporalUnitProperty()

See Also:

getPrimaryTemporalUnit()

getPrimaryTemporalUnit

public final TemporalUnit getPrimaryTemporalUnit()

Gets the value of the property primaryTemporalUnit.

hoverTimeIntervalProperty

public final ReadOnlyObjectProperty<TimeInterval> hoverTimeIntervalProperty()

See Also:

getHoverTimeInterval()

getHoverTimeInterval

public final TimeInterval getHoverTimeInterval()

Gets the value of the property hoverTimeInterval.

getSelectedIntervals

public final ObservableList<TimeInterval> getSelectedIntervals()

selectionModeProperty

public final ObjectProperty<SelectionMode> selectionModeProperty()

See Also:

getSelectionMode(), setSelectionMode(SelectionMode)

setSelectionMode

public final void setSelectionMode(SelectionMode mode)

Sets the value of the property selectionMode.

getSelectionMode

public final SelectionMode getSelectionMode()

Gets the value of the property selectionMode.

getCalendars

public final ObservableList<Calendar<?>> getCalendars()

getScaleResolutions

public final ObservableList<Resolution<?>> getScaleResolutions()

getPropertySheetItems

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