Module com.googlecode.lanterna
Package com.googlecode.lanterna.gui2

Class BorderLayout

java.lang.Object
com.googlecode.lanterna.gui2.BorderLayout
All Implemented Interfaces:
LayoutManager
public class BorderLayout extends Object implements LayoutManager
BorderLayout imitates the BorderLayout class from AWT, allowing you to add a center component with optional components around it in top, bottom, left and right locations. The edge components will be sized at their preferred size and the center component will take up whatever remains.
Author:
martin

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    BorderLayout.Location
    This type is what you use as the layout data for components added to a panel using BorderLayout for its layout manager.

  • Constructor Summary

    Constructors
    Constructor
    Description
    BorderLayout()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    doLayout(TerminalSize area, List<Component> components)
    Given a size constraint, update the location and size of each component in the component list by laying them out in the available area.
    TerminalSize
    getPreferredSize(List<Component> components)
    This method returns the dimensions it would prefer to have to be able to layout all components while giving all of them as much space as they are asking for.
    boolean
    hasChanged()
    Returns true if the internal state of this LayoutManager has changed since the last call to doLayout.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • BorderLayout

      public BorderLayout()

  • Method Details

    • getPreferredSize

      public TerminalSize getPreferredSize(List<Component> components)
      Description copied from interface: LayoutManager
      This method returns the dimensions it would prefer to have to be able to layout all components while giving all of them as much space as they are asking for.
      Specified by:
      getPreferredSize in interface LayoutManager
      Parameters:
      components - List of components
      Returns:
      Size the layout manager would like to have

    • doLayout

      public void doLayout(TerminalSize area, List<Component> components)
      Description copied from interface: LayoutManager
      Given a size constraint, update the location and size of each component in the component list by laying them out in the available area. This method will call setPosition(..) and setSize(..) on the Components.
      Specified by:
      doLayout in interface LayoutManager
      Parameters:
      area - Size available to this layout manager to lay out the components on
      components - List of components to lay out

    • hasChanged

      public boolean hasChanged()
      Description copied from interface: LayoutManager
      Returns true if the internal state of this LayoutManager has changed since the last call to doLayout. This will tell the container that it needs to call doLayout again.
      Specified by:
      hasChanged in interface LayoutManager
      Returns:
      true if this layout manager's internal state has changed since the last call to doLayout