Package net.officefloor.gef.editor

Interface OverlayVisualContext

  • All Known Implementing Classes:
    AdaptedOverlayHandlePart
    public interface OverlayVisualContext
    Context for an overlay.
    Author:
    Daniel Sagenschneider

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void close()
      Closes the overlay.
      javafx.scene.layout.Pane getOverlayParent()
      Obtains the parent Pane that loads as the overlay.
      void setFixedHeight​(boolean isFixedHeight)
      Indicates whether the overlay is fixed height.
      void setFixedWidth​(boolean isFixedWith)
      Indicates whether the overlay is fixed width.

    • Method Detail

      • getOverlayParent

        javafx.scene.layout.Pane getOverlayParent()

        Obtains the parent Pane that loads as the overlay.

        Content for the overlay to be added to this Pane.

        Returns:
        Parent Pane to load in the overlay.

      • setFixedWidth

        void setFixedWidth​(boolean isFixedWith)

        Indicates whether the overlay is fixed width.

        By default the overlay resizes.

        Parameters:
        isFixedWith - true for fixed width.

      • setFixedHeight

        void setFixedHeight​(boolean isFixedHeight)

        Indicates whether the overlay is fixed height.

        By default the overlay resizes.

        Parameters:
        isFixedHeight - true for fixed height.

      • close

        void close()
        Closes the overlay.