Overview
Package
Class
Use
Tree
Deprecated
Index
All Classes
Help
Prev Class
Next Class
Sample
Document
Class java.awt.BorderLayout
Inherited members: ShowHide
Deprecated: ShowHide
View: ClientSubclassPackageImplementation
java.awt

Class BorderLayout

  • java.lang.Object
    • java.awt.BorderLayout
  • All Implemented Interfaces:
    LayoutManager, LayoutManager2, java.io.Serializable
    public class BorderLayout extends java.lang.Object implements LayoutManager2, java.io.Serializable
    A border layout lays out a container, arranging and resizing its components to fit in five regions: north, south, east, west, and center. Each region may contain no more than one component, and is identified by a corresponding constant: NORTH, SOUTH, EAST, WEST, and CENTER. When adding a component to a container with a border layout, use one of these five constants, for example:
        Panel p = new Panel();
        p.setLayout(new BorderLayout());
        p.add(new Button("Okay"), BorderLayout.SOUTH);
     
    As a convenience, BorderLayout interprets the absence of a string specification the same as the constant CENTER:
        Panel p2 = new Panel();
        p2.setLayout(new BorderLayout());
        p2.add(new TextArea());  // Same as p.add(new TextArea(), BorderLayout.CENTER);
     

    In addition, BorderLayout supports the relative positioning constants, PAGE_START, PAGE_END, LINE_START, and LINE_END. In a container whose ComponentOrientation is set to ComponentOrientation.LEFT_TO_RIGHT, these constants map to NORTH, SOUTH, WEST, and EAST, respectively.

    For compatibility with previous releases, BorderLayout also includes the relative positioning constants BEFORE_FIRST_LINE, AFTER_LAST_LINE, BEFORE_LINE_BEGINS and AFTER_LINE_ENDS. These are equivalent to PAGE_START, PAGE_END, LINE_START and LINE_END respectively. For consistency with the relative positioning constants used by other components, the latter constants are preferred.

    Mixing both absolute and relative positioning constants can lead to unpredicable results. If you use both types, the relative constants will take precedence. For example, if you add components using both the NORTH and PAGE_START constants in a container whose orientation is LEFT_TO_RIGHT, only the PAGE_START will be layed out.

    NOTE: Currently (in the Java 2 platform v1.2), BorderLayout does not support vertical orientations. The isVertical setting on the container's ComponentOrientation is not respected.

    The components are laid out according to their preferred sizes and the constraints of the container's size. The NORTH and SOUTH components may be stretched horizontally; the EAST and WEST components may be stretched vertically; the CENTER component may stretch both horizontally and vertically to fill any space left over.

    Here is an example of five buttons in an applet laid out using the BorderLayout layout manager:

    Diagram of an applet demonstrating BorderLayout.
      Each section of the BorderLayout contains a Button corresponding to its position in the layout, one of:
      North, West, Center, East, or South.

    The code for this applet is as follows:


     import java.awt.*;
     import java.applet.Applet;
    
     public class buttonDir extends Applet {
       public void init() {
         setLayout(new BorderLayout());
         add(new Button("North"), BorderLayout.NORTH);
         add(new Button("South"), BorderLayout.SOUTH);
         add(new Button("East"), BorderLayout.EAST);
         add(new Button("West"), BorderLayout.WEST);
         add(new Button("Center"), BorderLayout.CENTER);
       }
     }
     

    Since:
    JDK1.0
    See Also:
    Container.add(String, Component), ComponentOrientation, Serialized Form
    • Fields 
      Modifier and Type Field and Description
      Ordinary member indicator AFTER_LAST_LINE Reveal DetailHide Detail
      static java.lang.String AFTER_LAST_LINE
      Synonym for PAGE_END.
      public static final java.lang.String AFTER_LAST_LINE
      Synonym for PAGE_END. Exists for compatibility with previous versions. PAGE_END is preferred.
      Since:
      1.2
      See Also:
      PAGE_END, Constant Field Values
      Ordinary member indicator AFTER_LINE_ENDS Reveal DetailHide Detail
      static java.lang.String AFTER_LINE_ENDS
      Synonym for LINE_END.
      public static final java.lang.String AFTER_LINE_ENDS
      Synonym for LINE_END. Exists for compatibility with previous versions. LINE_END is preferred.
      Since:
      1.2
      See Also:
      LINE_END, Constant Field Values
      Ordinary member indicator BEFORE_FIRST_LINE Reveal DetailHide Detail
      static java.lang.String BEFORE_FIRST_LINE
      Synonym for PAGE_START.
      public static final java.lang.String BEFORE_FIRST_LINE
      Synonym for PAGE_START. Exists for compatibility with previous versions. PAGE_START is preferred.
      Since:
      1.2
      See Also:
      PAGE_START, Constant Field Values
      Ordinary member indicator BEFORE_LINE_BEGINS Reveal DetailHide Detail
      static java.lang.String BEFORE_LINE_BEGINS
      Synonym for LINE_START.
      public static final java.lang.String BEFORE_LINE_BEGINS
      Synonym for LINE_START. Exists for compatibility with previous versions. LINE_START is preferred.
      Since:
      1.2
      See Also:
      LINE_START, Constant Field Values
      Ordinary member indicator CENTER Reveal DetailHide Detail
      static java.lang.String CENTER
      The center layout constraint (middle of container).
      public static final java.lang.String CENTER
      The center layout constraint (middle of container).
      See Also:
      Constant Field Values
      Ordinary member indicator EAST Reveal DetailHide Detail
      static java.lang.String EAST
      The east layout constraint (right side of container).
      public static final java.lang.String EAST
      The east layout constraint (right side of container).
      See Also:
      Constant Field Values
      Ordinary member indicator LINE_END Reveal DetailHide Detail
      static java.lang.String LINE_END
      The component goes at the end of the line direction for the layout.
      public static final java.lang.String LINE_END
      The component goes at the end of the line direction for the layout. For Western, left-to-right and top-to-bottom orientations, this is equivalent to EAST.
      Since:
      1.4
      See Also:
      Component.getComponentOrientation(), Constant Field Values
      Ordinary member indicator LINE_START Reveal DetailHide Detail
      static java.lang.String LINE_START
      The component goes at the beginning of the line direction for the layout.
      public static final java.lang.String LINE_START
      The component goes at the beginning of the line direction for the layout. For Western, left-to-right and top-to-bottom orientations, this is equivalent to WEST.
      Since:
      1.4
      See Also:
      Component.getComponentOrientation(), Constant Field Values
      Ordinary member indicator NORTH Reveal DetailHide Detail
      static java.lang.String NORTH
      The north layout constraint (top of container).
      public static final java.lang.String NORTH
      The north layout constraint (top of container).
      See Also:
      Constant Field Values
      Ordinary member indicator PAGE_END Reveal DetailHide Detail
      static java.lang.String PAGE_END
      The component comes after the last line of the layout's content.
      public static final java.lang.String PAGE_END
      The component comes after the last line of the layout's content. For Western, left-to-right and top-to-bottom orientations, this is equivalent to SOUTH.
      Since:
      1.4
      See Also:
      Component.getComponentOrientation(), Constant Field Values
      Ordinary member indicator PAGE_START Reveal DetailHide Detail
      static java.lang.String PAGE_START
      The component comes before the first line of the layout's content.
      public static final java.lang.String PAGE_START
      The component comes before the first line of the layout's content. For Western, left-to-right and top-to-bottom orientations, this is equivalent to NORTH.
      Since:
      1.4
      See Also:
      Component.getComponentOrientation(), Constant Field Values
      Ordinary member indicator SOUTH Reveal DetailHide Detail
      static java.lang.String SOUTH
      The south layout constraint (bottom of container).
      public static final java.lang.String SOUTH
      The south layout constraint (bottom of container).
      See Also:
      Constant Field Values
      Ordinary member indicator WEST Reveal DetailHide Detail
      static java.lang.String WEST
      The west layout constraint (left side of container).
      public static final java.lang.String WEST
      The west layout constraint (left side of container).
      See Also:
      Constant Field Values
    • Constructors 
      Constructor and Description
      Ordinary member indicator BorderLayout Reveal DetailHide Detail
      BorderLayout()
      Constructs a new border layout with no gaps between components.
      public BorderLayout()
      Constructs a new border layout with no gaps between components.
      Ordinary member indicator BorderLayout Reveal DetailHide Detail
      BorderLayout(int hgap, int vgap)
      Constructs a border layout with the specified gaps between components.
      public BorderLayout(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.
    • Methods 
      Modifier and Type Method and Description
      Ordinary member indicator addLayoutComponent Reveal DetailHide Detail
      void addLayoutComponent(Component comp, java.lang.Object constraints)
      Adds the specified component to the layout, using the specified constraint object.
      public void addLayoutComponent(Component comp, java.lang.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:
      java.lang.IllegalArgumentException - if the constraint object is not a string, or if it not one of the five specified constants.
      Since:
      JDK1.1
      See Also:
      Container.add(java.awt.Component, java.lang.Object)
      Ordinary member indicator addLayoutComponent Reveal DetailHide Detail
      void addLayoutComponent(java.lang.String name, Component comp)
      Deprecated replaced by addLayoutComponent(Component, Object).
      @Deprecated public void addLayoutComponent(java.lang.String name, Component comp)
      Deprecated replaced by addLayoutComponent(Component, Object).
      Description copied from interface: LayoutManager
      If the layout manager uses a per-component string, adds the component comp to the layout, associating it with the string specified by name.
      Specified by:
      addLayoutComponent in interface LayoutManager
      Parameters:
      name - the string to be associated with the component
      comp - the component to be added
      Ordinary member indicator getConstraints Reveal DetailHide Detail
      java.lang.Object getConstraints(Component comp)
      Gets the constraints for the specified component
      public java.lang.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:
      addLayoutComponent(java.awt.Component, java.lang.Object)
      Ordinary member indicator getHgap Reveal DetailHide Detail
      int getHgap()
      Returns the horizontal gap between components.
      public int getHgap()
      Returns the horizontal gap between components.
      Since:
      JDK1.1
      Ordinary member indicator getLayoutAlignmentX Reveal DetailHide Detail
      float getLayoutAlignmentX(Container parent)
      Returns the alignment along the x axis.
      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
      Ordinary member indicator getLayoutAlignmentY Reveal DetailHide Detail
      float getLayoutAlignmentY(Container parent)
      Returns the alignment along the y axis.
      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
      Ordinary member indicator getLayoutComponent Reveal DetailHide Detail
      Component getLayoutComponent(Container target, java.lang.Object constraints)
      Returns the component that corresponds to the given constraint location based on the target Container's component orientation.
      public Component getLayoutComponent(Container target, java.lang.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:
      constraints - the desired absolute position, one of CENTER, NORTH, SOUTH, EAST, WEST
      target - the Container used to obtain the constraint location based on the target Container's component orientation.
      Returns:
      the component at the given location, or null if the location is empty
      Throws:
      java.lang.IllegalArgumentException - if the constraint object is not one of the five specified constants
      java.lang.NullPointerException - if the target parameter is null
      Since:
      1.5
      See Also:
      addLayoutComponent(java.awt.Component, java.lang.Object)
      Ordinary member indicator getLayoutComponent Reveal DetailHide Detail
      Component getLayoutComponent(java.lang.Object constraints)
      Gets the component that was added using the given constraint
      public Component getLayoutComponent(java.lang.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:
      java.lang.IllegalArgumentException - if the constraint object is not one of the nine specified constants
      Since:
      1.5
      See Also:
      addLayoutComponent(java.awt.Component, java.lang.Object)
      Ordinary member indicator getVgap Reveal DetailHide Detail
      int getVgap()
      Returns the vertical gap between components.
      public int getVgap()
      Returns the vertical gap between components.
      Since:
      JDK1.1
      Ordinary member indicator invalidateLayout Reveal DetailHide Detail
      void invalidateLayout(Container target)
      Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.
      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
      Ordinary member indicator layoutContainer Reveal DetailHide Detail
      void layoutContainer(Container target)
      Lays out the container argument using this border layout.
      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:
      Container, Container.doLayout()
      Ordinary member indicator maximumLayoutSize Reveal DetailHide Detail
      Dimension maximumLayoutSize(Container target)
      Returns the maximum dimensions for this layout given the components in the specified target container.
      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:
      Container, minimumLayoutSize(java.awt.Container), preferredLayoutSize(java.awt.Container)
      Ordinary member indicator minimumLayoutSize Reveal DetailHide Detail
      Dimension minimumLayoutSize(Container target)
      Determines the minimum size of the target container using this layout manager.
      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:
      Container, preferredLayoutSize(java.awt.Container), Container.getMinimumSize()
      Ordinary member indicator preferredLayoutSize Reveal DetailHide Detail
      Dimension preferredLayoutSize(Container target)
      Determines the preferred size of the target container using this layout manager, based on the components in the container.
      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:
      Container, minimumLayoutSize(java.awt.Container), Container.getPreferredSize()
      Ordinary member indicator removeLayoutComponent Reveal DetailHide Detail
      void removeLayoutComponent(Component comp)
      Removes the specified component from this border layout.
      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:
      Container.remove(java.awt.Component), Container.removeAll()
      Ordinary member indicator setHgap Reveal DetailHide Detail
      void setHgap(int hgap)
      Sets the horizontal gap between components.
      public void setHgap(int hgap)
      Sets the horizontal gap between components.
      Parameters:
      hgap - the horizontal gap between components
      Since:
      JDK1.1
      Ordinary member indicator setVgap Reveal DetailHide Detail
      void setVgap(int vgap)
      Sets the vertical gap between components.
      public void setVgap(int vgap)
      Sets the vertical gap between components.
      Parameters:
      vgap - the vertical gap between components
      Since:
      JDK1.1
      Overridden member indicator toString Reveal DetailHide Detail
      java.lang.String toString()
      Returns a string representation of the state of this border layout.
      public java.lang.String toString()
      Returns a string representation of the state of this border layout.
      Overrides:
      toString in class java.lang.Object
      Returns:
      a string representation of this border layout.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
This document was created by Dulcet from the OpenJDK sources. Copyright © 1993, 2012 Oracle and/or its affiliates. All rights reserved.

SourceForge