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

Class AbstractDockable

java.lang.Object
org.jhotdraw8.fxcontrols.dock.AbstractDockable
All Implemented Interfaces:
Dockable, DockChild, DockNode
Direct Known Subclasses:
SimpleDockable
public abstract class AbstractDockable extends Object implements Dockable
Abstract base class for implementations of Dockable.

  • Property Details

  • Field Details

    • dockParent

      protected final javafx.beans.property.ObjectProperty<DockParent> dockParent

    • graphic

      protected final javafx.beans.property.ObjectProperty<javafx.scene.Node> graphic

    • text

      protected final javafx.beans.property.StringProperty text

    • showing

      protected final javafx.beans.property.BooleanProperty showing

  • Constructor Details

    • AbstractDockable

      public AbstractDockable()

  • Method Details

    • graphicProperty

      public @NonNull javafx.beans.property.ObjectProperty<javafx.scene.Node> graphicProperty()
      Description copied from interface: Dockable
      The graphic of this dockable.

      The user uses the graphic to drag and drop the dockable.

      Specified by:
      graphicProperty in interface Dockable
      Returns:
      the graphic property

    • textProperty

      public @NonNull javafx.beans.property.StringProperty textProperty()
      Description copied from interface: Dockable
      The text of this dockable.

      The user uses the text to identify the dockable.

      Specified by:
      textProperty in interface Dockable
      Returns:
      the text property

    • showingProperty

      public @NonNull javafx.beans.property.BooleanProperty showingProperty()
      Description copied from interface: DockChild
      Whether this dock child is showing.

      A dock child that is not showing should not consume CPU resources.

      This property is set by DockParent, for example depending on whether this dockable is in a collapsed pane.

      Specified by:
      showingProperty in interface DockChild
      Returns:
      the showing property

    • dockParentProperty

      public @NonNull javafx.beans.property.ObjectProperty<DockParent> dockParentProperty()
      Description copied from interface: DockNode
      Gets the parent of this node.
      Specified by:
      dockParentProperty in interface DockNode
      Returns:
      the dockParent property

    • getDockChildrenReadOnly

      public @NonNull ReadOnlyList<DockChild> getDockChildrenReadOnly()
      Description copied from interface: DockNode
      Gets the children of this node.
      Specified by:
      getDockChildrenReadOnly in interface DockNode
      Returns:
      the children