| java.lang.Object java.awt.BorderLayout
BorderLayout | public class BorderLayout implements LayoutManager2,java.io.Serializable(Code) | | A border layout lays out a container, arranging and resizing
its components to fit in five regions:
North , South , East ,
West , and Center . When adding a
component to a container with a border layout, use one of these
five names, for example:
Panel p = new Panel();
p.setLayout(new BorderLayout());
p.add(new Button("Okay"), "South");
As a convenience, BorderLayout interprets the absence of a string
specification the same as "Center":
Panel p2 = new Panel();
p2.setLayout(new BorderLayout());
p2.add(new TextArea()); // Same as p.add(new TextArea(), "Center");
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:
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("North", new Button("North"));
add("South", new Button("South"));
add("East", new Button("East"));
add("West", new Button("West"));
add("Center", new Button("Center"));
}
}
version: 1.27 02/11/97 author: Arthur van Hoff See Also: java.awt.Container.add(StringComponent) since: JDK1.0 |
Constructor Summary | |
public | BorderLayout() Constructs a new border layout with
no gaps between components. | public | BorderLayout(int hgap, int vgap) Constructs a border layout with the specified gaps
between components. |
CENTER | final public static String CENTER(Code) | | The center layout constraint (middle of container).
|
EAST | final public static String EAST(Code) | | The east layout constraint (left side of container).
|
NORTH | final public static String NORTH(Code) | | The north layout constraint (top of container).
|
SOUTH | final public static String SOUTH(Code) | | The south layout constraint (bottom of container).
|
WEST | final public static String WEST(Code) | | The west layout constraint (right side of container).
|
BorderLayout | public BorderLayout()(Code) | | Constructs a new border layout with
no gaps between components.
since: JDK1.0 |
BorderLayout | public BorderLayout(int hgap, int vgap)(Code) | | 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. Parameters: vgap - the vertical gap. since: JDK1.0 |
addLayoutComponent | public void addLayoutComponent(Component comp, Object constraints)(Code) | | Adds the specified component to the layout, using the specified
constraint object. For border layouts, the constraint must be
one of the following strings: "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.
Parameters: comp - the component to be added. Parameters: constraints - an object that specifies how and where the component is added to the layout. See Also: java.awt.Container.add(java.awt.Componentjava.lang.Object) exception: IllegalArgumentException - if the constraint object is nota string, or if it not one of the five specified strings. since: JDK1.1 |
getHgap | public int getHgap()(Code) | | Returns the horizontal gap between components.
since: JDK1.1 |
getLayoutAlignmentX | public float getLayoutAlignmentX(Container parent)(Code) | | 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.
|
getLayoutAlignmentY | public float getLayoutAlignmentY(Container parent)(Code) | | 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.
|
getVgap | public int getVgap()(Code) | | Returns the vertical gap between components.
since: JDK1.1 |
invalidateLayout | public void invalidateLayout(Container target)(Code) | | Invalidates the layout, indicating that if the layout manager
has cached information it should be discarded.
|
layoutContainer | public void layoutContainer(Container target)(Code) | | 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.
Parameters: target - the container in which to do the layout. See Also: java.awt.Container See Also: See Also: java.awt.Container.doLayout since: JDK1.0 |
preferredLayoutSize | public Dimension preferredLayoutSize(Container target)(Code) | | 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.
Parameters: target - the container in which to do the layout. the preferred dimensions to lay out the subcomponents of the specified container. See Also: java.awt.Container See Also: See Also: java.awt.BorderLayout.minimumLayoutSize See Also: See Also: java.awt.Container.getPreferredSize since: JDK1.0 |
setHgap | public void setHgap(int hgap)(Code) | | Sets the horizontal gap between components.
Parameters: hgap - the horizontal gap between components since: JDK1.1 |
setVgap | public void setVgap(int vgap)(Code) | | Sets the vertical gap between components.
Parameters: vgap - the vertical gap between components since: JDK1.1 |
toString | public String toString()(Code) | | Returns a string representation of the state of this border layout.
a string representation of this border layout. since: JDK1.0 |
|
|