Module org.jhotdraw8.fxcontrols

Package org.jhotdraw8.fxcontrols.dock

Interface DockParent

All Superinterfaces:

DockChild, DockNode

All Known Subinterfaces:

DockRoot, Track

All Known Implementing Classes:

AbstractDockParent, AbstractDockRoot, HBoxTrack, SimpleDockRoot, SplitPaneTrack, TabbedAccordionTrack, TabPaneTrack, VBoxTrack

public interface DockParent
extends DockChild

A DockParent provides screen space for one or more DockChildren.

The DockParent lays out the screen space along an implementation-specific TrackAxis.

Property Summary

Properties

Type	Property	Description
@NonNull javafx.beans.property.BooleanProperty	editable	Whether this dock parent is editable.

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

showing

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

dockParent

Field Summary

Fields

Modifier and Type	Field	Description
static final @NonNull String	EDITABLE_PROPERTY	The name of the editableProperty().

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

SHOWING_PROPERTY

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

DOCK_PARENT_PROPERTY

Method Summary

Modifier and Type	Method	Description
@NonNull javafx.beans.property.BooleanProperty	editableProperty()	Whether this dock parent is editable.
@NonNull TrackAxis	getDockAxis()
@NonNull javafx.collections.ObservableList<DockChild>	getDockChildren()
default @NonNull ReadOnlyList<DockChild>	getDockChildrenReadOnly()	Gets the children of this node.
default boolean	isEditable()	Returns whether the user can edit this dock parent.
boolean	isResizesDockChildren()	Returns true if this parent dock resizes the items.
default void	setEditable(boolean value)	Sets whether the user can edit this dock parent.

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

isShowing, setShowing, showingProperty

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

dockParentProperty, getDockParent, getDockRoot, getNode, setDockParent

Property Details

editable

@NonNull javafx.beans.property.BooleanProperty editableProperty

Whether this dock parent is editable.

See Also:

• isEditable()
• setEditable(boolean)
• editableProperty()

Field Details

EDITABLE_PROPERTY

static final @NonNull String EDITABLE_PROPERTY

The name of the editableProperty().

See Also:

• Constant Field Values

Method Details

getDockChildren

@NonNull javafx.collections.ObservableList<DockChild> getDockChildren()

getDockChildrenReadOnly

default @NonNull ReadOnlyList<DockChild> getDockChildrenReadOnly()

Description copied from interface: DockNode

Gets the children of this node.

Specified by:

getDockChildrenReadOnly in interface DockNode

Returns:

the children

editableProperty

@NonNull javafx.beans.property.BooleanProperty editableProperty()

Whether this dock parent is editable.

Returns:

true if this dock parent is editable.

See Also:

• isEditable()
• setEditable(boolean)

isEditable

default boolean isEditable()

Returns whether the user can edit this dock parent.

Returns:

true if the user can edit this dock parent.

setEditable

default void setEditable(boolean value)

Sets whether the user can edit this dock parent.

Parameters:

value - true if the user can edit this dock parent.

getDockAxis

@NonNull TrackAxis getDockAxis()

isResizesDockChildren

boolean isResizesDockChildren()

Returns true if this parent dock resizes the items. If this method returns true, a dock child should not provide resize controls.

Returns:

true if the track resizes items.