Module com.flexganttfx.view

Package com.flexganttfx.view.container

Class DualGanttChartContainerBase<T extends GanttChartBase<?>>

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.container.ContainerBase<T>

com.flexganttfx.view.container.DualGanttChartContainerBase<T>

Type Parameters:

T - the type of the Gantt chart

All Implemented Interfaces:

Styleable, EventTarget, Skinnable

Direct Known Subclasses:

DualGanttChartContainer, DualGanttChartLiteContainer

public abstract class DualGanttChartContainerBase<T extends GanttChartBase<?>>
extends ContainerBase<T>

A specialization of ContainerBase capable of displaying exactly two instances of GanttChartBase and keeping their layouts and their scrolling and zooming behavior in sync. The container distinguishes between a primary and a secondary Gantt chart, where the secondary Gantt chart is located in the detail node section of a MasterDetailPane. It can be hidden or shown on demand. Each one of the two Gantt charts can have its own header and footer.

Since:

1.6

Property Summary

Properties

Type	Property	Description
ObjectProperty<Node>	primaryFooter	A property used to store the reference to a node that will be displayed in the footer position of the primary Gantt chart.
ObjectProperty<T>	primaryGanttChart	A property used to store the reference to the Gantt chart control that is serving as the primary Gantt chart.
ObjectProperty<Node>	primaryHeader	A property used to store the reference to a control that will be serving as a header for the primary Gantt chart.
ObjectProperty<Node>	secondaryFooter	A property used to store the reference to a node that will be used in the footer position of the secondary Gantt chart.
ObjectProperty<T>	secondaryGanttChart	A property used to store the reference to the secondary Gantt chart.
ObjectProperty<Node>	secondaryHeader	A property used to store the reference to a control that will be serving as a header for the secondary Gantt chart.
BooleanProperty	showSecondary	A property used to toggle the visibility of the secondary Gantt chart.

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

Modifier	Constructor	Description
protected	DualGanttChartContainerBase(boolean autoBinding, T primaryGanttChart, T secondaryGanttChart)	Constructs a new container with the given Gantt chart controls.
protected	DualGanttChartContainerBase(T primaryGanttChart, T secondaryGanttChart)	Constructs a new container with the given Gantt chart controls.

Method Summary

Modifier and Type	Method	Description
protected Skin<?>	createDefaultSkin()
org.controlsfx.control.MasterDetailPane	getMasterDetailPane()	Returns the MasterDetailPane instance used by the skin of this control to arrange the primary and secondary Gantt charts.
Node	getPrimaryFooter()	Returns the value of primaryFooterProperty().
T	getPrimaryGanttChart()	Returns the value of primaryGanttChartProperty().
Node	getPrimaryHeader()	Returns the value of primaryHeaderProperty().
Node	getSecondaryFooter()	Returns the value of secondaryFooterProperty().
T	getSecondaryGanttChart()	Returns the value of secondaryGanttChartProperty().
Node	getSecondaryHeader()	Returns the value of secondaryHeaderProperty().
String	getUserAgentStylesheet()
boolean	isShowSecondary()	Returns the value of showSecondaryProperty().
ObjectProperty<Node>	primaryFooterProperty()	A property used to store the reference to a node that will be displayed in the footer position of the primary Gantt chart.
ObjectProperty<T>	primaryGanttChartProperty()	A property used to store the reference to the Gantt chart control that is serving as the primary Gantt chart.
ObjectProperty<Node>	primaryHeaderProperty()	A property used to store the reference to a control that will be serving as a header for the primary Gantt chart.
ObjectProperty<Node>	secondaryFooterProperty()	A property used to store the reference to a node that will be used in the footer position of the secondary Gantt chart.
ObjectProperty<T>	secondaryGanttChartProperty()	A property used to store the reference to the secondary Gantt chart.
ObjectProperty<Node>	secondaryHeaderProperty()	A property used to store the reference to a control that will be serving as a header for the secondary Gantt chart.
void	setPrimaryFooter(Node footer)	Sets the value of primaryFooterProperty().
void	setPrimaryGanttChart(T ganttChart)	Sets the value of primaryGanttChartProperty().
void	setPrimaryHeader(Node header)	Sets the value of the primaryHeaderProperty().
void	setSecondaryFooter(Node footer)	Sets the value of secondaryFooterProperty().
void	setSecondaryGanttChart(T ganttChart)	Sets the value of secondaryGanttChartProperty().
void	setSecondaryHeader(Node header)	Sets the value of secondaryHeaderProperty().
void	setShowSecondary(boolean show)	Sets the value of showSecondaryProperty().
BooleanProperty	showSecondaryProperty()	A property used to toggle the visibility of the secondary Gantt chart.

Methods inherited from class com.flexganttfx.view.container.ContainerBase

getGanttCharts, isAutoBinding

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

primaryGanttChart

public final ObjectProperty<T extends GanttChartBase<?>> primaryGanttChartProperty

A property used to store the reference to the Gantt chart control that is serving as the primary Gantt chart.

Since:

1.6

See Also:

getPrimaryGanttChart(), setPrimaryGanttChart(T)

primaryHeader

public final ObjectProperty<Node> primaryHeaderProperty

A property used to store the reference to a control that will be serving as a header for the primary Gantt chart. In most cases the primary header will be a toolbar.

Since:

1.6

See Also:

getPrimaryHeader(), setPrimaryHeader(Node)

primaryFooter

public final ObjectProperty<Node> primaryFooterProperty

A property used to store the reference to a node that will be displayed in the footer position of the primary Gantt chart.

Since:

1.6

See Also:

getPrimaryFooter(), setPrimaryFooter(Node)

secondaryHeader

public final ObjectProperty<Node> secondaryHeaderProperty

A property used to store the reference to a control that will be serving as a header for the secondary Gantt chart. In most cases the secondary header will not be used.

Returns:

the secondary header control property

Since:

1.6

secondaryFooter

public final ObjectProperty<Node> secondaryFooterProperty

A property used to store the reference to a node that will be used in the footer position of the secondary Gantt chart.

Since:

1.6

See Also:

getSecondaryFooter(), setSecondaryFooter(Node)

secondaryGanttChart

public final ObjectProperty<T extends GanttChartBase<?>> secondaryGanttChartProperty

A property used to store the reference to the secondary Gantt chart.

See Also:

getSecondaryGanttChart(), setSecondaryGanttChart(T)

showSecondary

public final BooleanProperty showSecondaryProperty

A property used to toggle the visibility of the secondary Gantt chart.

Since:

1.6

See Also:

isShowSecondary(), setShowSecondary(boolean)

Constructor Details

DualGanttChartContainerBase

protected DualGanttChartContainerBase(boolean autoBinding,
T primaryGanttChart,
T secondaryGanttChart)

Constructs a new container with the given Gantt chart controls.

Parameters:

autoBinding - if true many properties of the secondary control will be bound to their equivalent of the primary Gantt chart

primaryGanttChart - the primary Gantt chart shown in the top position

secondaryGanttChart - the secondary Gantt chart shown in the bottom position

Since:

1.6

DualGanttChartContainerBase

protected DualGanttChartContainerBase(T primaryGanttChart,
T secondaryGanttChart)

Constructs a new container with the given Gantt chart controls. The properties of the secondary Gantt chart will be bound to their equivalent of the primary Gantt chart.

Parameters:

primaryGanttChart - the primary Gantt chart shown in the top position

secondaryGanttChart - the secondary Gantt chart shown in the bottom position

Since:

1.6

Method Details

createDefaultSkin

protected Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class Control

getUserAgentStylesheet

public String getUserAgentStylesheet()

Overrides:

getUserAgentStylesheet in class Region

getMasterDetailPane

public final org.controlsfx.control.MasterDetailPane getMasterDetailPane()

Returns the MasterDetailPane instance used by the skin of this control to arrange the primary and secondary Gantt charts. The primary Gantt chart will be the master and the secondary Gantt chart will be the detail node.

Returns:

the master detail pane

Since:

1.3

See Also:

MasterDetailPane.setMasterNode(Node), MasterDetailPane.setDetailNode(Node)

primaryGanttChartProperty

public final ObjectProperty<T> primaryGanttChartProperty()

A property used to store the reference to the Gantt chart control that is serving as the primary Gantt chart.

Since:

1.6

See Also:

getPrimaryGanttChart(), setPrimaryGanttChart(T)

setPrimaryGanttChart

public final void setPrimaryGanttChart(T ganttChart)

Sets the value of primaryGanttChartProperty().

Parameters:

ganttChart - the gantt chart control

Since:

1.6

getPrimaryGanttChart

public final T getPrimaryGanttChart()

Returns the value of primaryGanttChartProperty().

Returns:

the primary Gantt chart control

Since:

1.6

primaryHeaderProperty

public final ObjectProperty<Node> primaryHeaderProperty()

A property used to store the reference to a control that will be serving as a header for the primary Gantt chart. In most cases the primary header will be a toolbar.

Since:

1.6

See Also:

getPrimaryHeader(), setPrimaryHeader(Node)

setPrimaryHeader

public final void setPrimaryHeader(Node header)

Sets the value of the primaryHeaderProperty().

Parameters:

header - the node that will be used as a header

Since:

1.6

getPrimaryHeader

public final Node getPrimaryHeader()

Returns the value of primaryHeaderProperty().

Returns:

the primary header node

Since:

1.6

primaryFooterProperty

public final ObjectProperty<Node> primaryFooterProperty()

A property used to store the reference to a node that will be displayed in the footer position of the primary Gantt chart.

Since:

1.6

See Also:

getPrimaryFooter(), setPrimaryFooter(Node)

setPrimaryFooter

public final void setPrimaryFooter(Node footer)

Sets the value of primaryFooterProperty().

Parameters:

footer - the node that will be displayed in the footer position of the primary Gantt chart

Since:

1.6

getPrimaryFooter

public final Node getPrimaryFooter()

Returns the value of primaryFooterProperty().

Returns:

the node displayed in the footer position of the primary Gantt chart

Since:

1.6

secondaryHeaderProperty

public final ObjectProperty<Node> secondaryHeaderProperty()

A property used to store the reference to a control that will be serving as a header for the secondary Gantt chart. In most cases the secondary header will not be used.

Returns:

the secondary header control property

Since:

1.6

setSecondaryHeader

public final void setSecondaryHeader(Node header)

Sets the value of secondaryHeaderProperty().

Parameters:

header - the control used as a header for the secondary Gantt chart

Since:

1.6

getSecondaryHeader

public final Node getSecondaryHeader()

Returns the value of secondaryHeaderProperty().

Returns:

the secondary header node

Since:

1.6

secondaryFooterProperty

public final ObjectProperty<Node> secondaryFooterProperty()

A property used to store the reference to a node that will be used in the footer position of the secondary Gantt chart.

Since:

1.6

See Also:

getSecondaryFooter(), setSecondaryFooter(Node)

setSecondaryFooter

public final void setSecondaryFooter(Node footer)

Sets the value of secondaryFooterProperty().

Parameters:

footer - the node that will be shown in the footer position of the secondary Gantt chart

Since:

1.6

getSecondaryFooter

public final Node getSecondaryFooter()

Returns the value of secondaryFooterProperty().

Returns:

the secondary footer node

Since:

1.6

secondaryGanttChartProperty

public final ObjectProperty<T> secondaryGanttChartProperty()

A property used to store the reference to the secondary Gantt chart.

See Also:

getSecondaryGanttChart(), setSecondaryGanttChart(T)

setSecondaryGanttChart

public final void setSecondaryGanttChart(T ganttChart)

Sets the value of secondaryGanttChartProperty().

Parameters:

ganttChart - the gantt chart control

Since:

1.6

getSecondaryGanttChart

public final T getSecondaryGanttChart()

Returns the value of secondaryGanttChartProperty().

Returns:

the secondary Gantt chart control

Since:

1.6

showSecondaryProperty

public final BooleanProperty showSecondaryProperty()

A property used to toggle the visibility of the secondary Gantt chart.

Since:

1.6

See Also:

isShowSecondary(), setShowSecondary(boolean)

isShowSecondary

public final boolean isShowSecondary()

Returns the value of showSecondaryProperty().

Returns:

true if the secondary Gantt chart shall be visible

Since:

1.6

setShowSecondary

public final void setShowSecondary(boolean show)

Sets the value of showSecondaryProperty().

Parameters:

show - if true the secondary Gantt chart will be visible

Since:

1.6