Package org.uberfire.client.workbench.panels

Interface SplitPanel

  • All Superinterfaces:
    com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.ProvidesResize, com.google.gwt.user.client.ui.RequiresResize
    public interface SplitPanel
extends com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.RequiresResize, com.google.gwt.user.client.ui.ProvidesResize
    Common operations for UberFire's horizontal and vertical splitter panels.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int DEFAULT_MIN_SIZE
      The default minimum size for a fixed-size child.
      static int DEFAULT_SIZE
      The default initial size for a fixed-size child.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clear()  
      int getFixedWidgetSize()
      Gets the current pixel size of the component that doesn't expand/contract when the whole split pane's container is resized.
      com.google.gwt.user.client.ui.Widget getParent()  
      com.google.gwt.user.client.ui.Widget getWidget​(org.uberfire.workbench.model.CompassPosition position)
      Returns the widget on the given side of this splitter.
      void setFixedWidgetSize​(int newSize)
      Sets the pixel size of the component that doesn't expand/contract when the whole split pane's container is resized.
      void setup​(com.google.gwt.user.client.ui.IsWidget eastOrNorthWidget, com.google.gwt.user.client.ui.IsWidget westOsSouthWidget, org.uberfire.workbench.model.CompassPosition fixedSizeComponent, Integer preferredSize, Integer preferredMinSize)
      Sets up this split panel's contents and divider location.

      • Methods inherited from interface com.google.gwt.user.client.ui.IsWidget

        asWidget

      • Methods inherited from interface com.google.gwt.user.client.ui.RequiresResize

        onResize

    • Field Detail

      • DEFAULT_SIZE

        static final int DEFAULT_SIZE
        The default initial size for a fixed-size child.
        See Also:
        Constant Field Values

      • DEFAULT_MIN_SIZE

        static final int DEFAULT_MIN_SIZE
        The default minimum size for a fixed-size child.
        See Also:
        Constant Field Values

    • Method Detail

      • getParent

        com.google.gwt.user.client.ui.Widget getParent()

      • setup

        void setup​(com.google.gwt.user.client.ui.IsWidget eastOrNorthWidget,
           com.google.gwt.user.client.ui.IsWidget westOsSouthWidget,
           org.uberfire.workbench.model.CompassPosition fixedSizeComponent,
           Integer preferredSize,
           Integer preferredMinSize)
        Sets up this split panel's contents and divider location.
        Parameters:
        eastOrNorthWidget - the widget to place in the east side a horizontal panel or north side of a vertical panel.
        westOsSouthWidget - the widget to place in the west side a horizontal panel or south side of a vertical panel.
        fixedSizeComponent - the component that should not change size when the whole split panel grows or shrinks (eg. because the browser window is being resized)
        preferredSize - the width or height that the fixed-size component should be given initially. If null, a default of 64 will be used.
        preferredMinSize - the minimum width or height of the fixed-size component. If null, a default of 32 will be used.

      • clear

        void clear()

      • getWidget

        com.google.gwt.user.client.ui.Widget getWidget​(org.uberfire.workbench.model.CompassPosition position)
        Returns the widget on the given side of this splitter.
        Parameters:
        position - which widget to get
        Returns:
        the widget on the given side of the splitter; null if that side is empty or the given position is not supported by this panel. (For example, NORTH is not a supported position of HorizontalSplitterPanel).

      • getFixedWidgetSize

        int getFixedWidgetSize()
        Gets the current pixel size of the component that doesn't expand/contract when the whole split pane's container is resized.

      • setFixedWidgetSize

        void setFixedWidgetSize​(int newSize)
        Sets the pixel size of the component that doesn't expand/contract when the whole split pane's container is resized.