eu.fthevenet.util.javafx.controls

Class TearableTabPane

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

javafx.scene.control.TabPane

eu.fthevenet.util.javafx.controls.TearableTabPane

All Implemented Interfaces:

java.lang.AutoCloseable, javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable

public class TearableTabPane
extends javafx.scene.control.TabPane
implements java.lang.AutoCloseable

A TabPane container with a button to add a new tab that also supports tearing away tabs into a separate window.

It relies on the TearableTabPane.TabPaneManager class to keep track of all tabs spread over many windows and TabPane instances

TODO: Reordering of the tabs is currently not implemented.

Author:

Frederic Thevenet

Property Summary

Properties inherited from class javafx.scene.control.TabPane

rotateGraphicProperty, selectionModelProperty, sideProperty, tabClosingPolicyProperty, tabMaxHeightProperty, tabMaxWidthProperty, tabMinHeightProperty, tabMinWidthProperty

Properties inherited from class javafx.scene.control.Control

contextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty

Properties inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty

Properties inherited from class javafx.scene.Parent

impl_traversalEngineProperty, needsLayoutProperty

Properties inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, 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, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TearableTabPane.TabPaneManager A class that represents the state of the tabs across all TabPane windows

Nested classes/interfaces inherited from class javafx.scene.control.TabPane

javafx.scene.control.TabPane.TabClosingPolicy

Field Summary

Fields inherited from class javafx.scene.control.TabPane

STYLE_CLASS_FLOATING

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 and Description
TearableTabPane() Initializes a new instance of the TearableTabPane class.
TearableTabPane(TearableTabPane.TabPaneManager manager, boolean reorderable, boolean tearable, javafx.scene.control.Tab... tabs) Initializes a new instance of the TearableTabPane class.

Method Summary

Modifier and Type	Method and Description
void	clearAllTabs() Clears the list of tabs.
void	close()
javafx.scene.input.DataFormat	getDataFormat() Returns the generated DataFormat used to identify drag and drop operations across panes sharing the same TearableTabPane.TabPaneManager
javafx.collections.ObservableList<javafx.scene.control.Tab>	getGlobalTabs() Returns a list of all tabs, across of panes sharing the same TearableTabPane.TabPaneManager
java.util.function.Function<javafx.event.ActionEvent,java.util.Optional<javafx.scene.control.Tab>>	getNewTabFactory() Returns the factory for creating new tabs
javafx.scene.control.Tab	getSelectedTab() Returns the tab currently selected.
javafx.scene.control.TabPane	getSelectedTabPane() Returns the pane containing the tab currently selected.
boolean	isReorderable() Returns true if tabs can be reordered, false otherwise.
boolean	isTearable() Returns true if tabs can be teared away from the pane, false otherwise.
void	setNewTabFactory(java.util.function.Function<javafx.event.ActionEvent,java.util.Optional<javafx.scene.control.Tab>> newTabFactory) Sets the factory for creating new tabs
void	setOnAddNewTab(javafx.event.EventHandler<javafx.event.ActionEvent> onAddNewTab) Sets the action that should be fired on the addition of a tab to the pane.
void	setOnClosingWindow(javafx.event.EventHandler<javafx.stage.WindowEvent> action) Sets the action to be fired on closing a window hosting tabs.
void	setOnOpenNewWindow(javafx.event.EventHandler<javafx.stage.WindowEvent> action) Sets the action to be fired on opening a new window to host tabs.
void	setReorderable(boolean reorderable) Set to true if tabs can be reordered, false otherwise.
void	setTearable(boolean tearable) Set to true if tabs can be teared away from the pane, false otherwise.

Methods inherited from class javafx.scene.control.TabPane

createDefaultSkin, getClassCssMetaData, getControlCssMetaData, getSelectionModel, getSide, getTabClosingPolicy, getTabMaxHeight, getTabMaxWidth, getTabMinHeight, getTabMinWidth, getTabs, isRotateGraphic, lookup, lookupAll, rotateGraphicProperty, selectionModelProperty, setRotateGraphic, setSelectionModel, setSide, setTabClosingPolicy, setTabMaxHeight, setTabMaxWidth, setTabMinHeight, setTabMinWidth, sideProperty, tabClosingPolicyProperty, tabMaxHeightProperty, tabMaxWidthProperty, tabMinHeightProperty, tabMinWidthProperty

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getContextMenu, getCssMetaData, getSkin, getTooltip, impl_cssGetFocusTraversableInitialValue, impl_processCSS, isResizable, layoutChildren, queryAccessibleAttribute, 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, getUserAgentStylesheet, 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, needsLayoutProperty, requestLayout, requestParentLayout, setImpl_traversalEngine, 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, containsBounds, 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, 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, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, 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, 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

Constructor Detail

TearableTabPane

public TearableTabPane()

Initializes a new instance of the TearableTabPane class.

TearableTabPane

public TearableTabPane(TearableTabPane.TabPaneManager manager,
                       boolean reorderable,
                       boolean tearable,
                       javafx.scene.control.Tab... tabs)

Initializes a new instance of the TearableTabPane class.

Parameters:

manager - the TearableTabPane.TabPaneManager manager instance

reorderable - true if tabs can be reordered, false otherwise.

tearable - true if tabs are teared away from the pane, false otherwise.

tabs - tabs to attached to the TabPane.

Method Detail

getNewTabFactory

public java.util.function.Function<javafx.event.ActionEvent,java.util.Optional<javafx.scene.control.Tab>> getNewTabFactory()

Returns the factory for creating new tabs

Returns:

the factory for creating new tabs

setNewTabFactory

public void setNewTabFactory(java.util.function.Function<javafx.event.ActionEvent,java.util.Optional<javafx.scene.control.Tab>> newTabFactory)

Sets the factory for creating new tabs

Parameters:

newTabFactory - the factory for creating new tabs

setOnAddNewTab

public void setOnAddNewTab(javafx.event.EventHandler<javafx.event.ActionEvent> onAddNewTab)

Sets the action that should be fired on the addition of a tab to the pane.

Parameters:

onAddNewTab - the actions that should be fired on the addition of a tab to the pane.

isTearable

public boolean isTearable()

Returns true if tabs can be teared away from the pane, false otherwise.

Returns:

true true if tabs can be teared away from the pane, false otherwise.

setTearable

public void setTearable(boolean tearable)

Set to true if tabs can be teared away from the pane, false otherwise.

Parameters:

tearable - true if tabs can be teared away from the pane, false otherwise.

isReorderable

public boolean isReorderable()

Returns true if tabs can be reordered, false otherwise.

Returns:

true if tabs can be reordered, false otherwise.

setReorderable

public void setReorderable(boolean reorderable)

Set to true if tabs can be reordered, false otherwise.

Parameters:

reorderable - true if tabs can be reordered, false otherwise.

getSelectedTab

public javafx.scene.control.Tab getSelectedTab()

Returns the tab currently selected.

Returns:

the tab currently selected.

getSelectedTabPane

public javafx.scene.control.TabPane getSelectedTabPane()

Returns the pane containing the tab currently selected.

Returns:

the pane containing the tab currently selected.

getGlobalTabs

public javafx.collections.ObservableList<javafx.scene.control.Tab> getGlobalTabs()

Returns a list of all tabs, across of panes sharing the same TearableTabPane.TabPaneManager

Returns:

a list of all tabs, across of panes sharing the same TearableTabPane.TabPaneManager

clearAllTabs

public void clearAllTabs()

Clears the list of tabs.

setOnOpenNewWindow

public void setOnOpenNewWindow(javafx.event.EventHandler<javafx.stage.WindowEvent> action)

Sets the action to be fired on opening a new window to host tabs.

Parameters:

action - the action to be fired on opening a new window to host tabs.

setOnClosingWindow

public void setOnClosingWindow(javafx.event.EventHandler<javafx.stage.WindowEvent> action)

Sets the action to be fired on closing a window hosting tabs.

Parameters:

action - the action to be fired on closing a window hosting tabs.

getDataFormat

public javafx.scene.input.DataFormat getDataFormat()

Returns the generated DataFormat used to identify drag and drop operations across panes sharing the same TearableTabPane.TabPaneManager

Returns:

the generated DataFormat used to identify drag and drop operations across panes sharing the same TearableTabPane.TabPaneManager

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable