java.awt
Class BorderLayout

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.awt.BorderLayout
All Implemented Interfaces:
LayoutManager sample code for java.awt.LayoutManager definition code for java.awt.LayoutManager , LayoutManager2 sample code for java.awt.LayoutManager2 definition code for java.awt.LayoutManager2 , Serializable sample code for java.io.Serializable definition code for java.io.Serializable

public class BorderLayout
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements LayoutManager2 sample code for java.awt.LayoutManager2 definition code for java.awt.LayoutManager2 , Serializable sample code for java.io.Serializable definition code for 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) sample code for java.awt.Container.add(java.lang.String, java.awt.Component) definition code for java.awt.Container.add(java.lang.String, java.awt.Component) , ComponentOrientation sample code for java.awt.ComponentOrientation definition code for java.awt.ComponentOrientation , Serialized Form

Field Summary
static String sample code for java.lang.String definition code for java.lang.String AFTER_LAST_LINE sample code for java.awt.BorderLayout.AFTER_LAST_LINE definition code for java.awt.BorderLayout.AFTER_LAST_LINE
          Synonym for PAGE_END.
static String sample code for java.lang.String definition code for java.lang.String AFTER_LINE_ENDS sample code for java.awt.BorderLayout.AFTER_LINE_ENDS definition code for java.awt.BorderLayout.AFTER_LINE_ENDS
          Synonym for LINE_END.
static String sample code for java.lang.String definition code for java.lang.String BEFORE_FIRST_LINE sample code for java.awt.BorderLayout.BEFORE_FIRST_LINE definition code for java.awt.BorderLayout.BEFORE_FIRST_LINE
          Synonym for PAGE_START.
static String sample code for java.lang.String definition code for java.lang.String BEFORE_LINE_BEGINS sample code for java.awt.BorderLayout.BEFORE_LINE_BEGINS definition code for java.awt.BorderLayout.BEFORE_LINE_BEGINS
          Synonym for LINE_START.
static String sample code for java.lang.String definition code for java.lang.String CENTER sample code for java.awt.BorderLayout.CENTER definition code for java.awt.BorderLayout.CENTER
          The center layout constraint (middle of container).
static String sample code for java.lang.String definition code for java.lang.String EAST sample code for java.awt.BorderLayout.EAST definition code for java.awt.BorderLayout.EAST
          The east layout constraint (right side of container).
static String sample code for java.lang.String definition code for java.lang.String LINE_END sample code for java.awt.BorderLayout.LINE_END definition code for java.awt.BorderLayout.LINE_END
          The component goes at the end of the line direction for the layout.
static String sample code for java.lang.String definition code for java.lang.String LINE_START sample code for java.awt.BorderLayout.LINE_START definition code for java.awt.BorderLayout.LINE_START
          The component goes at the beginning of the line direction for the layout.
static String sample code for java.lang.String definition code for java.lang.String NORTH sample code for java.awt.BorderLayout.NORTH definition code for java.awt.BorderLayout.NORTH
          The north layout constraint (top of container).
static String sample code for java.lang.String definition code for java.lang.String PAGE_END sample code for java.awt.BorderLayout.PAGE_END definition code for java.awt.BorderLayout.PAGE_END
          The component comes after the last line of the layout's content.
static String sample code for java.lang.String definition code for java.lang.String PAGE_START sample code for java.awt.BorderLayout.PAGE_START definition code for java.awt.BorderLayout.PAGE_START
          The component comes before the first line of the layout's content.
static String sample code for java.lang.String definition code for java.lang.String SOUTH sample code for java.awt.BorderLayout.SOUTH definition code for java.awt.BorderLayout.SOUTH
          The south layout constraint (bottom of container).
static String sample code for java.lang.String definition code for java.lang.String WEST sample code for java.awt.BorderLayout.WEST definition code for java.awt.BorderLayout.WEST
          The west layout constraint (left side of container).
 
Constructor Summary
BorderLayout sample code for java.awt.BorderLayout.BorderLayout() definition code for java.awt.BorderLayout.BorderLayout() ()
          Constructs a new border layout with no gaps between components.
BorderLayout sample code for java.awt.BorderLayout.BorderLayout(int, int) definition code for java.awt.BorderLayout.BorderLayout(int, int) (int hgap, int vgap)
          Constructs a border layout with the specified gaps between components.
 
Method Summary
 void addLayoutComponent sample code for java.awt.BorderLayout.addLayoutComponent(java.awt.Component, java.lang.Object) definition code for java.awt.BorderLayout.addLayoutComponent(java.awt.Component, java.lang.Object) (Component sample code for java.awt.Component definition code for java.awt.Component  comp, Object sample code for java.lang.Object definition code for java.lang.Object  constraints)
          Adds the specified component to the layout, using the specified constraint object.
 void addLayoutComponent sample code for java.awt.BorderLayout.addLayoutComponent(java.lang.String, java.awt.Component) definition code for java.awt.BorderLayout.addLayoutComponent(java.lang.String, java.awt.Component) (String sample code for java.lang.String definition code for java.lang.String  name, Component sample code for java.awt.Component definition code for java.awt.Component  comp)
          Deprecated. replaced by addLayoutComponent(Component, Object).
 Object sample code for java.lang.Object definition code for java.lang.Object getConstraints sample code for java.awt.BorderLayout.getConstraints(java.awt.Component) definition code for java.awt.BorderLayout.getConstraints(java.awt.Component) (Component sample code for java.awt.Component definition code for java.awt.Component  comp)
          Gets the constraints for the specified component
 int getHgap sample code for java.awt.BorderLayout.getHgap() definition code for java.awt.BorderLayout.getHgap() ()
          Returns the horizontal gap between components.
 float getLayoutAlignmentX sample code for java.awt.BorderLayout.getLayoutAlignmentX(java.awt.Container) definition code for java.awt.BorderLayout.getLayoutAlignmentX(java.awt.Container) (Container sample code for java.awt.Container definition code for java.awt.Container  parent)
          Returns the alignment along the x axis.
 float getLayoutAlignmentY sample code for java.awt.BorderLayout.getLayoutAlignmentY(java.awt.Container) definition code for java.awt.BorderLayout.getLayoutAlignmentY(java.awt.Container) (Container sample code for java.awt.Container definition code for java.awt.Container  parent)
          Returns the alignment along the y axis.
 Component sample code for java.awt.Component definition code for java.awt.Component getLayoutComponent sample code for java.awt.BorderLayout.getLayoutComponent(java.awt.Container, java.lang.Object) definition code for java.awt.BorderLayout.getLayoutComponent(java.awt.Container, java.lang.Object) (Container sample code for java.awt.Container definition code for java.awt.Container  target, Object sample code for java.lang.Object definition code for java.lang.Object  constraints)
          Gets the component that corresponds to the given constraint location based on the target Container's component orientation
 Component sample code for java.awt.Component definition code for java.awt.Component getLayoutComponent sample code for java.awt.BorderLayout.getLayoutComponent(java.lang.Object) definition code for java.awt.BorderLayout.getLayoutComponent(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  constraints)
          Gets the component that was added using the given constraint
 int getVgap sample code for java.awt.BorderLayout.getVgap() definition code for java.awt.BorderLayout.getVgap() ()
          Returns the vertical gap between components.
 void invalidateLayout sample code for java.awt.BorderLayout.invalidateLayout(java.awt.Container) definition code for java.awt.BorderLayout.invalidateLayout(java.awt.Container) (Container sample code for java.awt.Container definition code for java.awt.Container  target)
          Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.
 void layoutContainer sample code for java.awt.BorderLayout.layoutContainer(java.awt.Container) definition code for java.awt.BorderLayout.layoutContainer(java.awt.Container) (Container sample code for java.awt.Container definition code for java.awt.Container  target)
          Lays out the container argument using this border layout.
 Dimension sample code for java.awt.Dimension definition code for java.awt.Dimension maximumLayoutSize sample code for java.awt.BorderLayout.maximumLayoutSize(java.awt.Container) definition code for java.awt.BorderLayout.maximumLayoutSize(java.awt.Container) (Container sample code for java.awt.Container definition code for java.awt.Container  target)
          Returns the maximum dimensions for this layout given the components in the specified target container.
 Dimension sample code for java.awt.Dimension definition code for java.awt.Dimension minimumLayoutSize sample code for java.awt.BorderLayout.minimumLayoutSize(java.awt.Container) definition code for java.awt.BorderLayout.minimumLayoutSize(java.awt.Container) (Container sample code for java.awt.Container definition code for java.awt.Container  target)
          Determines the minimum size of the target container using this layout manager.
 Dimension sample code for java.awt.Dimension definition code for java.awt.Dimension preferredLayoutSize sample code for java.awt.BorderLayout.preferredLayoutSize(java.awt.Container) definition code for java.awt.BorderLayout.preferredLayoutSize(java.awt.Container) (Container sample code for java.awt.Container definition code for java.awt.Container  target)
          Determines the preferred size of the target container using this layout manager, based on the components in the container.
 void removeLayoutComponent sample code for java.awt.BorderLayout.removeLayoutComponent(java.awt.Component) definition code for java.awt.BorderLayout.removeLayoutComponent(java.awt.Component) (Component sample code for java.awt.Component definition code for java.awt.Component  comp)
          Removes the specified component from this border layout.
 void setHgap sample code for java.awt.BorderLayout.setHgap(int) definition code for java.awt.BorderLayout.setHgap(int) (int hgap)
          Sets the horizontal gap between components.
 void setVgap sample code for java.awt.BorderLayout.setVgap(int) definition code for java.awt.BorderLayout.setVgap(int) (int vgap)
          Sets the vertical gap between components.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for java.awt.BorderLayout.toString() definition code for java.awt.BorderLayout.toString() ()
          Returns a string representation of the state of this border layout.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

NORTH sample code for java.awt.BorderLayout.NORTH

public static final String sample code for java.lang.String definition code for java.lang.String  NORTH
The north layout constraint (top of container).

See Also:
Constant Field Values

SOUTH sample code for java.awt.BorderLayout.SOUTH

public static final String sample code for java.lang.String definition code for java.lang.String  SOUTH
The south layout constraint (bottom of container).

See Also:
Constant Field Values

EAST sample code for java.awt.BorderLayout.EAST

public static final String sample code for java.lang.String definition code for java.lang.String  EAST
The east layout constraint (right side of container).

See Also:
Constant Field Values

WEST sample code for java.awt.BorderLayout.WEST

public static final String sample code for java.lang.String definition code for java.lang.String  WEST
The west layout constraint (left side of container).

See Also:
Constant Field Values

CENTER sample code for java.awt.BorderLayout.CENTER

public static final String sample code for java.lang.String definition code for java.lang.String  CENTER
The center layout constraint (middle of container).

See Also:
Constant Field Values

BEFORE_FIRST_LINE sample code for java.awt.BorderLayout.BEFORE_FIRST_LINE

public static final String sample code for java.lang.String definition code for 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 sample code for java.awt.BorderLayout.PAGE_START definition code for java.awt.BorderLayout.PAGE_START , Constant Field Values

AFTER_LAST_LINE sample code for java.awt.BorderLayout.AFTER_LAST_LINE

public static final String sample code for java.lang.String definition code for 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 sample code for java.awt.BorderLayout.PAGE_END definition code for java.awt.BorderLayout.PAGE_END , Constant Field Values

BEFORE_LINE_BEGINS sample code for java.awt.BorderLayout.BEFORE_LINE_BEGINS

public static final String sample code for java.lang.String definition code for 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 sample code for java.awt.BorderLayout.LINE_START definition code for java.awt.BorderLayout.LINE_START , Constant Field Values

AFTER_LINE_ENDS sample code for java.awt.BorderLayout.AFTER_LINE_ENDS

public static final String sample code for java.lang.String definition code for 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 sample code for java.awt.BorderLayout.LINE_END definition code for java.awt.BorderLayout.LINE_END , Constant Field Values

PAGE_START sample code for java.awt.BorderLayout.PAGE_START

public static final String sample code for java.lang.String definition code for 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() sample code for java.awt.Component.getComponentOrientation() definition code for java.awt.Component.getComponentOrientation() , Constant Field Values

PAGE_END sample code for java.awt.BorderLayout.PAGE_END

public static final String sample code for java.lang.String definition code for 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() sample code for java.awt.Component.getComponentOrientation() definition code for java.awt.Component.getComponentOrientation() , Constant Field Values

LINE_START sample code for java.awt.BorderLayout.LINE_START

public static final String sample code for java.lang.String definition code for 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() sample code for java.awt.Component.getComponentOrientation() definition code for java.awt.Component.getComponentOrientation() , Constant Field Values

LINE_END sample code for java.awt.BorderLayout.LINE_END

public static final String sample code for java.lang.String definition code for 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() sample code for java.awt.Component.getComponentOrientation() definition code for java.awt.Component.getComponentOrientation() , Constant Field Values
Constructor Detail

BorderLayout sample code for java.awt.BorderLayout() definition code for java.awt.BorderLayout()

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


BorderLayout sample code for java.awt.BorderLayout(int, int) definition code for java.awt.BorderLayout(int, int)

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.
Method Detail

getHgap sample code for java.awt.BorderLayout.getHgap() definition code for java.awt.BorderLayout.getHgap()

public int getHgap()
Returns the horizontal gap between components.

Since:
JDK1.1

setHgap sample code for java.awt.BorderLayout.setHgap(int) definition code for java.awt.BorderLayout.setHgap(int)

public void setHgap(int hgap)
Sets the horizontal gap between components.

Parameters:
hgap - the horizontal gap between components
Since:
JDK1.1

getVgap sample code for java.awt.BorderLayout.getVgap() definition code for java.awt.BorderLayout.getVgap()

public int getVgap()
Returns the vertical gap between components.

Since:
JDK1.1

setVgap sample code for java.awt.BorderLayout.setVgap(int) definition code for java.awt.BorderLayout.setVgap(int)

public void setVgap(int vgap)
Sets the vertical gap between components.

Parameters:
vgap - the vertical gap between components
Since:
JDK1.1

addLayoutComponent sample code for java.awt.BorderLayout.addLayoutComponent(java.awt.Component, java.lang.Object) definition code for java.awt.BorderLayout.addLayoutComponent(java.awt.Component, java.lang.Object)

public void addLayoutComponent(Component sample code for java.awt.Component definition code for java.awt.Component  comp,
                               Object sample code for java.lang.Object definition code for 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 sample code for java.awt.LayoutManager2.addLayoutComponent(java.awt.Component, java.lang.Object) definition code for java.awt.LayoutManager2.addLayoutComponent(java.awt.Component, java.lang.Object) in interface LayoutManager2 sample code for java.awt.LayoutManager2 definition code for java.awt.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 sample code for java.lang.IllegalArgumentException definition code for 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) sample code for java.awt.Container.add(java.awt.Component, java.lang.Object) definition code for java.awt.Container.add(java.awt.Component, java.lang.Object)

addLayoutComponent sample code for java.awt.BorderLayout.addLayoutComponent(java.lang.String, java.awt.Component) definition code for java.awt.BorderLayout.addLayoutComponent(java.lang.String, java.awt.Component)

@Deprecated
public void addLayoutComponent(String sample code for java.lang.String definition code for java.lang.String  name,
                                          Component sample code for java.awt.Component definition code for java.awt.Component  comp)
Deprecated. replaced by addLayoutComponent(Component, Object).

Description copied from interface: LayoutManager sample code for java.awt.LayoutManager.addLayoutComponent(java.lang.String, java.awt.Component) definition code for java.awt.LayoutManager.addLayoutComponent(java.lang.String, java.awt.Component)
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 sample code for java.awt.LayoutManager.addLayoutComponent(java.lang.String, java.awt.Component) definition code for java.awt.LayoutManager.addLayoutComponent(java.lang.String, java.awt.Component) in interface LayoutManager sample code for java.awt.LayoutManager definition code for java.awt.LayoutManager
Parameters:
name - the string to be associated with the component
comp - the component to be added

removeLayoutComponent sample code for java.awt.BorderLayout.removeLayoutComponent(java.awt.Component) definition code for java.awt.BorderLayout.removeLayoutComponent(java.awt.Component)

public void removeLayoutComponent(Component sample code for java.awt.Component definition code for java.awt.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 sample code for java.awt.LayoutManager.removeLayoutComponent(java.awt.Component) definition code for java.awt.LayoutManager.removeLayoutComponent(java.awt.Component) in interface LayoutManager sample code for java.awt.LayoutManager definition code for java.awt.LayoutManager
Parameters:
comp - the component to be removed.
See Also:
Container.remove(java.awt.Component) sample code for java.awt.Container.remove(java.awt.Component) definition code for java.awt.Container.remove(java.awt.Component) , Container.removeAll() sample code for java.awt.Container.removeAll() definition code for java.awt.Container.removeAll()

getLayoutComponent sample code for java.awt.BorderLayout.getLayoutComponent(java.lang.Object) definition code for java.awt.BorderLayout.getLayoutComponent(java.lang.Object)

public Component sample code for java.awt.Component definition code for java.awt.Component  getLayoutComponent(Object sample code for java.lang.Object definition code for 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:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for 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) sample code for java.awt.BorderLayout.addLayoutComponent(java.awt.Component, java.lang.Object) definition code for java.awt.BorderLayout.addLayoutComponent(java.awt.Component, java.lang.Object)

getLayoutComponent sample code for java.awt.BorderLayout.getLayoutComponent(java.awt.Container, java.lang.Object) definition code for java.awt.BorderLayout.getLayoutComponent(java.awt.Container, java.lang.Object)

public Component sample code for java.awt.Component definition code for java.awt.Component  getLayoutComponent(Container sample code for java.awt.Container definition code for java.awt.Container  target,
                                    Object sample code for java.lang.Object definition code for java.lang.Object  constraints)
Gets the component that corresponds to the given constraint location based on the target Container's component orientation

Parameters:
constraints - the desired absolute position, one of CENTER, one of NORTH, SOUTH, EAST, WEST
target - the Container using this BorderLayout
Returns:
the component at the given location, or null if the location is empty
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if the constraint object is not one of the five specified constants
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if the target parameter is null
Since:
1.5
See Also:
addLayoutComponent(java.awt.Component, java.lang.Object) sample code for java.awt.BorderLayout.addLayoutComponent(java.awt.Component, java.lang.Object) definition code for java.awt.BorderLayout.addLayoutComponent(java.awt.Component, java.lang.Object)

getConstraints sample code for java.awt.BorderLayout.getConstraints(java.awt.Component) definition code for java.awt.BorderLayout.getConstraints(java.awt.Component)

public Object sample code for java.lang.Object definition code for java.lang.Object  getConstraints(Component sample code for java.awt.Component definition code for java.awt.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) sample code for java.awt.BorderLayout.addLayoutComponent(java.awt.Component, java.lang.Object) definition code for java.awt.BorderLayout.addLayoutComponent(java.awt.Component, java.lang.Object)

minimumLayoutSize sample code for java.awt.BorderLayout.minimumLayoutSize(java.awt.Container) definition code for java.awt.BorderLayout.minimumLayoutSize(java.awt.Container)

public Dimension sample code for java.awt.Dimension definition code for java.awt.Dimension  minimumLayoutSize(Container sample code for java.awt.Container definition code for java.awt.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 sample code for java.awt.LayoutManager.minimumLayoutSize(java.awt.Container) definition code for java.awt.LayoutManager.minimumLayoutSize(java.awt.Container) in interface LayoutManager sample code for java.awt.LayoutManager definition code for java.awt.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 sample code for java.awt.Container definition code for java.awt.Container , preferredLayoutSize(java.awt.Container) sample code for java.awt.BorderLayout.preferredLayoutSize(java.awt.Container) definition code for java.awt.BorderLayout.preferredLayoutSize(java.awt.Container) , Container.getMinimumSize() sample code for java.awt.Container.getMinimumSize() definition code for java.awt.Container.getMinimumSize()

preferredLayoutSize sample code for java.awt.BorderLayout.preferredLayoutSize(java.awt.Container) definition code for java.awt.BorderLayout.preferredLayoutSize(java.awt.Container)

public Dimension sample code for java.awt.Dimension definition code for java.awt.Dimension  preferredLayoutSize(Container sample code for java.awt.Container definition code for java.awt.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 sample code for java.awt.LayoutManager.preferredLayoutSize(java.awt.Container) definition code for java.awt.LayoutManager.preferredLayoutSize(java.awt.Container) in interface LayoutManager sample code for java.awt.LayoutManager definition code for java.awt.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 sample code for java.awt.Container definition code for java.awt.Container , minimumLayoutSize(java.awt.Container) sample code for java.awt.BorderLayout.minimumLayoutSize(java.awt.Container) definition code for java.awt.BorderLayout.minimumLayoutSize(java.awt.Container) , Container.getPreferredSize() sample code for java.awt.Container.getPreferredSize() definition code for java.awt.Container.getPreferredSize()

maximumLayoutSize sample code for java.awt.BorderLayout.maximumLayoutSize(java.awt.Container) definition code for java.awt.BorderLayout.maximumLayoutSize(java.awt.Container)

public Dimension sample code for java.awt.Dimension definition code for java.awt.Dimension  maximumLayoutSize(Container sample code for java.awt.Container definition code for java.awt.Container  target)
Returns the maximum dimensions for this layout given the components in the specified target container.

Specified by:
maximumLayoutSize sample code for java.awt.LayoutManager2.maximumLayoutSize(java.awt.Container) definition code for java.awt.LayoutManager2.maximumLayoutSize(java.awt.Container) in interface LayoutManager2 sample code for java.awt.LayoutManager2 definition code for java.awt.LayoutManager2
Parameters:
target - the component which needs to be laid out
See Also:
Container sample code for java.awt.Container definition code for java.awt.Container , minimumLayoutSize(java.awt.Container) sample code for java.awt.BorderLayout.minimumLayoutSize(java.awt.Container) definition code for java.awt.BorderLayout.minimumLayoutSize(java.awt.Container) , preferredLayoutSize(java.awt.Container) sample code for java.awt.BorderLayout.preferredLayoutSize(java.awt.Container) definition code for java.awt.BorderLayout.preferredLayoutSize(java.awt.Container)

getLayoutAlignmentX sample code for java.awt.BorderLayout.getLayoutAlignmentX(java.awt.Container) definition code for java.awt.BorderLayout.getLayoutAlignmentX(java.awt.Container)

public float getLayoutAlignmentX(Container sample code for java.awt.Container definition code for java.awt.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 sample code for java.awt.LayoutManager2.getLayoutAlignmentX(java.awt.Container) definition code for java.awt.LayoutManager2.getLayoutAlignmentX(java.awt.Container) in interface LayoutManager2 sample code for java.awt.LayoutManager2 definition code for java.awt.LayoutManager2

getLayoutAlignmentY sample code for java.awt.BorderLayout.getLayoutAlignmentY(java.awt.Container) definition code for java.awt.BorderLayout.getLayoutAlignmentY(java.awt.Container)

public float getLayoutAlignmentY(Container sample code for java.awt.Container definition code for java.awt.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 sample code for java.awt.LayoutManager2.getLayoutAlignmentY(java.awt.Container) definition code for java.awt.LayoutManager2.getLayoutAlignmentY(java.awt.Container) in interface LayoutManager2 sample code for java.awt.LayoutManager2 definition code for java.awt.LayoutManager2

invalidateLayout sample code for java.awt.BorderLayout.invalidateLayout(java.awt.Container) definition code for java.awt.BorderLayout.invalidateLayout(java.awt.Container)

public void invalidateLayout(Container sample code for java.awt.Container definition code for java.awt.Container  target)
Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.

Specified by:
invalidateLayout sample code for java.awt.LayoutManager2.invalidateLayout(java.awt.Container) definition code for java.awt.LayoutManager2.invalidateLayout(java.awt.Container) in interface LayoutManager2 sample code for java.awt.LayoutManager2 definition code for java.awt.LayoutManager2

layoutContainer sample code for java.awt.BorderLayout.layoutContainer(java.awt.Container) definition code for java.awt.BorderLayout.layoutContainer(java.awt.Container)

public void layoutContainer(Container sample code for java.awt.Container definition code for java.awt.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 sample code for java.awt.LayoutManager.layoutContainer(java.awt.Container) definition code for java.awt.LayoutManager.layoutContainer(java.awt.Container) in interface LayoutManager sample code for java.awt.LayoutManager definition code for java.awt.LayoutManager
Parameters:
target - the container in which to do the layout.
See Also:
Container sample code for java.awt.Container definition code for java.awt.Container , Container.doLayout() sample code for java.awt.Container.doLayout() definition code for java.awt.Container.doLayout()

toString sample code for java.awt.BorderLayout.toString() definition code for java.awt.BorderLayout.toString()

public String sample code for java.lang.String definition code for java.lang.String  toString()
Returns a string representation of the state of this border layout.

Overrides:
toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a string representation of this border layout.