The class BorderLayout arranges the components to fit in the five regions: east, west, north, south and center. Each region is can contain only one component and each component in each region is identified by the corresponding constant NORTH, SOUTH, EAST, WEST, and CENTER.

Class declaration

Following is the declaration for java.awt.BorderLayout class:

  1. public class BorderLayout
  2. extends Object
  3. implements LayoutManager2, Serializable


Following are the fields for java.awt.BorderLayout class:

  • static String AFTER_LAST_LINE — Synonym for PAGE_END.

  • static String AFTER_LINE_ENDS — Synonym for LINE_END.

  • static String BEFORE_FIRST_LINE — Synonym for PAGE_START.

  • static String BEFORE_LINE_BEGINS — Synonym for LINE_START.

  • static String CENTER — The center layout constraint (middle of container).

  • static String EAST — The east layout constraint (right side of container).

  • static String LINE_END — The component goes at the end of the line direction for the layout.

  • static String LINE_START — The component goes at the beginning of the line direction for the layout.

  • static String NORTH — The north layout constraint (top of container).

  • static String PAGE_END — The component comes after the last line of the layout's content.

  • static String PAGE_START — The component comes before the first line of the layout's content.

  • static String SOUTH — The south layout constraint (bottom of container).

  • static String WEST — The west layout constraint (left side of container).

Class constructors

S.N.Constructor & Description
1 BorderLayout() Constructs a new border layout with no gaps between components.
2 BorderLayout(int hgap, int vgap) Constructs a border layout with the specified gaps between components.

Class methods

S.N.Method & Description
1 void addLayoutComponent(Component comp, Object constraints) Adds the specified component to the layout, using the specified constraint object.
2 void addLayoutComponent(String name, Component comp) If the layout manager uses a per-component string, adds the component comp to the layout, associating it with the string specified by name.
3 int getHgap() Returns the horizontal gap between components.
4 float getLayoutAlignmentX(Container parent) Returns the alignment along the x axis.
5 float getLayoutAlignmentY(Container parent) Returns the alignment along the y axis.
6 int getVgap() Returns the vertical gap between components.
7 void invalidateLayout(Container target) Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.
8 void layoutContainer(Container target) Lays out the container argument using this border layout.
9 Dimension maximumLayoutSize(Container target) Returns the maximum dimensions for this layout given the components in the specified target container.
10 Dimension minimumLayoutSize(Container target) Determines the minimum size of the target container using this layout manager.
11 Dimension preferredLayoutSize(Container target) Determines the preferred size of the target container using this layout manager, based on the components in the container.
12 void removeLayoutComponent(Component comp) Removes the specified component from this border layout.
13 void setHgap(int hgap) Sets the horizontal gap between components.
14 void setVgap(int vgap) Sets the vertical gap between components.
15 String toString() Returns a string representation of the state of this border layout.

Methods inherited

This class inherits methods from the following classes:

  • java.lang.Object

BorderLayout Example

Create the following java program using any editor of your choice in say D:/ > AWT > com > tutorialspoint > gui >

  1. package com.tutorialspoint.gui;
  3. import java.awt.*;
  4. import java.awt.event.*;
  6. public class AwtLayoutDemo {
  7. private Frame mainFrame;
  8. private Label headerLabel;
  9. private Label statusLabel;
  10. private Panel controlPanel;
  11. private Label msglabel;
  13. public AwtLayoutDemo(){
  14. prepareGUI();
  15. }
  17. public static void main(String[] args){
  18. AwtLayoutDemo awtLayoutDemo = new AwtLayoutDemo();
  19. awtLayoutDemo.showBorderLayoutDemo();
  20. }
  22. private void prepareGUI(){
  23. mainFrame = new Frame("Java AWT Examples");
  24. mainFrame.setSize(400,400);
  25. mainFrame.setLayout(new GridLayout(3, 1));
  26. mainFrame.addWindowListener(new WindowAdapter() {
  27. public void windowClosing(WindowEvent windowEvent){
  28. System.exit(0);
  29. }
  30. });
  31. headerLabel = new Label();
  32. headerLabel.setAlignment(Label.CENTER);
  33. statusLabel = new Label();
  34. statusLabel.setAlignment(Label.CENTER);
  35. statusLabel.setSize(350,100);
  37. msglabel = new Label();
  38. msglabel.setAlignment(Label.CENTER);
  39. msglabel.setText("Welcome to TutorialsPoint AWT Tutorial.");
  41. controlPanel = new Panel();
  42. controlPanel.setLayout(new FlowLayout());
  44. mainFrame.add(headerLabel);
  45. mainFrame.add(controlPanel);
  46. mainFrame.add(statusLabel);
  47. mainFrame.setVisible(true);
  48. }
  50. private void showBorderLayoutDemo(){
  51. headerLabel.setText("Layout in action: BorderLayout");
  53. Panel panel = new Panel();
  54. panel.setBackground(Color.darkGray);
  55. panel.setSize(300,300);
  56. BorderLayout layout = new BorderLayout();
  57. layout.setHgap(10);
  58. layout.setVgap(10);
  59. panel.setLayout(layout);
  61. panel.add(new Button("Center"),BorderLayout.CENTER);
  62. panel.add(new Button("Line Start"),BorderLayout.LINE_START);
  63. panel.add(new Button("Line End"),BorderLayout.LINE_END);
  64. panel.add(new Button("East"),BorderLayout.EAST);
  65. panel.add(new Button("West"),BorderLayout.WEST);
  66. panel.add(new Button("North"),BorderLayout.NORTH);
  67. panel.add(new Button("South"),BorderLayout.SOUTH);
  69. controlPanel.add(panel);
  71. mainFrame.setVisible(true);
  72. }
  73. }

Compile the program using command prompt. Go to D:/ > AWT and type the following command.

  1. D:\AWT>javac com\tutorialspoint\gui\

If no error comes that means compilation is successful. Run the program using following command.

  1. D:\AWT>java com.tutorialspoint.gui.AwtlayoutDemo

Verify the following output