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 Summary

Properties

Type	Property	Description
@NonNull javafx.beans.property.ObjectProperty<Predicate<Dockable>>	dockablePredicate	Only Dockables accepted by this filter can be docked.
static @NonNull 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.

Properties inherited from interface org.jhotdraw8.fxcontrols.dock.DockChild

showing

Properties inherited from interface org.jhotdraw8.fxcontrols.dock.DockNode

dockParent

Properties inherited from interface org.jhotdraw8.fxcontrols.dock.DockParent

editable

Field Summary

Fields

Modifier and Type	Field	Description
static final javafx.scene.input.DataFormat	DOCKABLE_DATA_FORMAT	Data format used for dragging a DockItem with the drag board.
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.

Fields inherited from interface org.jhotdraw8.fxcontrols.dock.DockChild

SHOWING_PROPERTY

Fields inherited from interface org.jhotdraw8.fxcontrols.dock.DockNode

DOCK_PARENT_PROPERTY

Fields inherited from interface org.jhotdraw8.fxcontrols.dock.DockParent

EDITABLE_PROPERTY

Method Summary

Modifier and Type	Method	Description
@NonNull javafx.beans.property.ObjectProperty<Predicate<Dockable>>	dockablePredicateProperty()	Only Dockables accepted by this filter can be docked.
static @NonNull 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.
default @NonNull Predicate<Dockable>	getDockablePredicate()	Gets the value of the dockablePredicate property.
static @Nullable Dockable	getDraggedDockable()	Gets the value of the draggedDockable property.
@NonNull javafx.scene.Parent	getNode()
default void	setDockablePredicate(@NonNull Predicate<Dockable> value)	Sets the value of the dockablePredicate property.
static void	setDraggedDockable(@Nullable Dockable value)	Sets the value of the draggedDockable property.

Methods inherited from interface org.jhotdraw8.fxcontrols.dock.DockChild

isShowing, setShowing, showingProperty

Methods inherited from interface org.jhotdraw8.fxcontrols.dock.DockNode

dockParentProperty, getDockParent, getDockRoot, setDockParent

Methods inherited from interface org.jhotdraw8.fxcontrols.dock.DockParent

editableProperty, getDockAxis, getDockChildren, getDockChildrenReadOnly, isEditable, isResizesDockChildren, setEditable

Property Details

draggedDockable

static @NonNull 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.

See Also:

• getDraggedDockable()
• setDraggedDockable(Dockable)
• draggedDockableProperty()

dockablePredicate

@NonNull 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.

See Also:

• getDockablePredicate()
• setDockablePredicate(Predicate)
• dockablePredicateProperty()

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 @NonNull 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()
• setDraggedDockable(Dockable)

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(Dockable)
• draggedDockableProperty()

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:

• getDraggedDockable()
• draggedDockableProperty()

dockablePredicateProperty

@NonNull 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()
• setDockablePredicate(Predicate)

getDockablePredicate

default @NonNull 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(Predicate)
• dockablePredicateProperty()

setDockablePredicate

default void setDockablePredicate(@NonNull 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:

• getDockablePredicate()
• dockablePredicateProperty()

getNode

@NonNull javafx.scene.Parent getNode()

Specified by:

getNode in interface DockNode