Module org.jhotdraw8.fxcontrols
Package org.jhotdraw8.fxcontrols.dock

Interface DockRoot

All Superinterfaces:
DockChild, DockNode, DockParent
All Known Implementing Classes:
AbstractDockRoot, SimpleDockRoot
public interface DockRoot extends DockParent
The root node of a docking hierarchy.

The root node manages drag and drop of Dockable nodes, and creates or destroys Track nodes that hold the Dockables.

  • Property Details

  • Field Details

    • DOCKABLE_DATA_FORMAT

      static final javafx.scene.input.DataFormat DOCKABLE_DATA_FORMAT
      Data format used for dragging a DockItem with the drag board. The value of this data format is the System.identityHashCode(Object) of the dragged leaf.

    • draggedDockable

      static final javafx.beans.property.ObjectProperty<Dockable> draggedDockable
      We store the dragged item here, because we move the reference of a DockItem with the drag board rather than a value of the DockItem.

  • Method Details

    • draggedDockableProperty

      static javafx.beans.property.ObjectProperty<Dockable> draggedDockableProperty()
      We store the dragged item here, because we move the reference of a DockItem with the drag board rather than a value of the DockItem.
      Returns:
      the draggedDockable property
      See Also:

    • getDraggedDockable

      static @Nullable Dockable getDraggedDockable()
      Gets the value of the draggedDockable property.
      Property description:
      We store the dragged item here, because we move the reference of a DockItem with the drag board rather than a value of the DockItem.
      Returns:
      the value of the draggedDockable property
      See Also:

    • setDraggedDockable

      static void setDraggedDockable(@Nullable Dockable value)
      Sets the value of the draggedDockable property.
      Property description:
      We store the dragged item here, because we move the reference of a DockItem with the drag board rather than a value of the DockItem.
      Parameters:
      value - the value for the draggedDockable property
      See Also:

    • dockablePredicateProperty

      javafx.beans.property.ObjectProperty<Predicate<Dockable>> dockablePredicateProperty()
      Only Dockables accepted by this filter can be docked.

      This can be used to restrict docking to dockables that belong to the same Activity.

      Returns:
      filter for accepting Dockables
      See Also:

    • getDockablePredicate

      default Predicate<Dockable> getDockablePredicate()
      Gets the value of the dockablePredicate property.
      Property description:
      Only Dockables accepted by this filter can be docked.

      This can be used to restrict docking to dockables that belong to the same Activity.

      Returns:
      the value of the dockablePredicate property
      See Also:

    • setDockablePredicate

      default void setDockablePredicate(Predicate<Dockable> value)
      Sets the value of the dockablePredicate property.
      Property description:
      Only Dockables accepted by this filter can be docked.

      This can be used to restrict docking to dockables that belong to the same Activity.

      Parameters:
      value - the value for the dockablePredicate property
      See Also:

    • getNode

      javafx.scene.Parent getNode()
      Specified by:
      getNode in interface DockNode