Package com.jidesoft.swing

Class JideBorderLayout

java.lang.Object
com.jidesoft.swing.JideBorderLayout
All Implemented Interfaces:
LayoutManager, LayoutManager2, Serializable
public class JideBorderLayout extends Object implements LayoutManager2, Serializable
This is a modified version of BorderLayout. Different from BorderLayout, the TOP and BOTTOM component's width are same as CENTER component's width. In BorderLayout, their width are the same as the container's width.
See Also:

  • Field Details

  • Constructor Details

    • JideBorderLayout

      public JideBorderLayout()
      Constructs a new border layout with no gaps between components.

    • JideBorderLayout

      public JideBorderLayout(int hgap, int vgap)
      Constructs a border layout with the specified gaps between components. The horizontal gap is specified by hgap and the vertical gap is specified by vgap.
      Parameters:
      hgap - the horizontal gap.
      vgap - the vertical gap.

  • Method Details

    • getHgap

      public int getHgap()
      Returns the horizontal gap between components.
      Since:
      JDK1.1

    • setHgap

      public void setHgap(int hgap)
      Sets the horizontal gap between components.
      Parameters:
      hgap - the horizontal gap between components
      Since:
      JDK1.1

    • getVgap

      public int getVgap()
      Returns the vertical gap between components.
      Since:
      JDK1.1

    • setVgap

      public void setVgap(int vgap)
      Sets the vertical gap between components.
      Parameters:
      vgap - the vertical gap between components
      Since:
      JDK1.1

    • addLayoutComponent

      public void addLayoutComponent(Component comp, Object constraints)
      Adds the specified component to the layout, using the specified constraint object. For border layouts, the constraint must be one of the following constants: NORTH, SOUTH, EAST, WEST, or CENTER.

      Most applications do not call this method directly. This method is called when a component is added to a container using the Container.add method with the same argument types.

      Specified by:
      addLayoutComponent in interface LayoutManager2
      Parameters:
      comp - the component to be added.
      constraints - an object that specifies how and where the component is added to the layout.
      Throws:
      IllegalArgumentException - if the constraint object is not a string, or if it not one of the five specified constants.
      Since:
      JDK1.1
      See Also:

    • addLayoutComponent

      @Deprecated public void addLayoutComponent(String name, Component comp)
      Deprecated.
      replaced by addLayoutComponent(Component, Object).
      Specified by:
      addLayoutComponent in interface LayoutManager

    • removeLayoutComponent

      public void removeLayoutComponent(Component comp)
      Removes the specified component from this border layout. This method is called when a container calls its remove or removeAll methods. Most applications do not call this method directly.
      Specified by:
      removeLayoutComponent in interface LayoutManager
      Parameters:
      comp - the component to be removed.
      See Also:

    • getLayoutComponent

      public Component getLayoutComponent(Object constraints)
      Gets the component that was added using the given constraint
      Parameters:
      constraints - the desired constraint, one of CENTER, NORTH, SOUTH, WEST, EAST, PAGE_START, PAGE_END, LINE_START, LINE_END
      Returns:
      the component at the given location, or null if the location is empty
      Throws:
      IllegalArgumentException - if the constraint object is not one of the nine specified constants
      Since:
      1.5
      See Also:

    • getLayoutComponent

      public Component getLayoutComponent(Container target, Object constraints)
      Returns the component that corresponds to the given constraint location based on the target Container's component orientation. Components added with the relative constraints PAGE_START, PAGE_END, LINE_START, and LINE_END take precedence over components added with the explicit constraints NORTH, SOUTH, WEST, and EAST. The Container's component orientation is used to determine the location of components added with LINE_START and LINE_END.
      Parameters:
      target - the Container used to obtain the constraint location based on the target Container's component orientation.
      constraints - the desired absolute position, one of CENTER, NORTH, SOUTH, EAST, WEST
      Returns:
      the component at the given location, or null if the location is empty
      Throws:
      IllegalArgumentException - if the constraint object is not one of the five specified constants
      NullPointerException - if the target parameter is null
      Since:
      1.5
      See Also:

    • getConstraints

      public Object getConstraints(Component comp)
      Gets the constraints for the specified component
      Parameters:
      comp - the component to be queried
      Returns:
      the constraint for the specified component, or null if component is null or is not present in this layout
      Since:
      1.5
      See Also:

    • minimumLayoutSize

      public Dimension minimumLayoutSize(Container target)
      Determines the minimum size of the target container using this layout manager.

      This method is called when a container calls its getMinimumSize method. Most applications do not call this method directly.

      Specified by:
      minimumLayoutSize in interface LayoutManager
      Parameters:
      target - the container in which to do the layout.
      Returns:
      the minimum dimensions needed to lay out the subcomponents of the specified container.
      See Also:

    • preferredLayoutSize

      public Dimension preferredLayoutSize(Container target)
      Determines the preferred size of the target container using this layout manager, based on the components in the container.

      Most applications do not call this method directly. This method is called when a container calls its getPreferredSize method.

      Specified by:
      preferredLayoutSize in interface LayoutManager
      Parameters:
      target - the container in which to do the layout.
      Returns:
      the preferred dimensions to lay out the subcomponents of the specified container.
      See Also:

    • maximumLayoutSize

      public Dimension maximumLayoutSize(Container target)
      Returns the maximum dimensions for this layout given the components in the specified target container.
      Specified by:
      maximumLayoutSize in interface LayoutManager2
      Parameters:
      target - the component which needs to be laid out
      See Also:

    • getLayoutAlignmentX

      public float getLayoutAlignmentX(Container parent)
      Returns the alignment along the x axis. This specifies how the component would like to be aligned relative to other components. The value should be a number between 0 and 1 where 0 represents alignment along the origin, 1 is aligned the furthest away from the origin, 0.5 is centered, etc.
      Specified by:
      getLayoutAlignmentX in interface LayoutManager2

    • getLayoutAlignmentY

      public float getLayoutAlignmentY(Container parent)
      Returns the alignment along the y axis. This specifies how the component would like to be aligned relative to other components. The value should be a number between 0 and 1 where 0 represents alignment along the origin, 1 is aligned the furthest away from the origin, 0.5 is centered, etc.
      Specified by:
      getLayoutAlignmentY in interface LayoutManager2

    • invalidateLayout

      public void invalidateLayout(Container target)
      Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.
      Specified by:
      invalidateLayout in interface LayoutManager2

    • layoutContainer

      public void layoutContainer(Container target)
      Lays out the container argument using this border layout.

      This method actually reshapes the components in the specified container in order to satisfy the constraints of this BorderLayout object. The NORTH and SOUTH components, if any, are placed at the top and bottom of the container, respectively. The WEST and EAST components are then placed on the left and right, respectively. Finally, the CENTER object is placed in any remaining space in the middle.

      Most applications do not call this method directly. This method is called when a container calls its doLayout method.

      Specified by:
      layoutContainer in interface LayoutManager
      Parameters:
      target - the container in which to do the layout.
      See Also:

    • toString

      public String toString()
      Returns a string representation of the state of this border layout.
      Overrides:
      toString in class Object
      Returns:
      a string representation of this border layout.