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

Class FlowLayout

  • java.lang.Object
    • java.awt.FlowLayout
  • All Implemented Interfaces:
    LayoutManager, java.io.Serializable
    public class FlowLayout extends java.lang.Object implements LayoutManager, java.io.Serializable
    A flow layout arranges components in a directional flow, much like lines of text in a paragraph. The flow direction is determined by the container's componentOrientation property and may be one of two values:
    • ComponentOrientation.LEFT_TO_RIGHT
    • ComponentOrientation.RIGHT_TO_LEFT
    Flow layouts are typically used to arrange buttons in a panel. It arranges buttons horizontally until no more buttons fit on the same line. The line alignment is determined by the align property. The possible values are:
    • LEFT
    • RIGHT
    • CENTER
    • LEADING
    • TRAILING

    For example, the following picture shows an applet using the flow layout manager (its default layout manager) to position three buttons:

    Graphic of Layout for Three Buttons

    Here is the code for this applet:


     import java.awt.*;
     import java.applet.Applet;
    
     public class myButtons extends Applet {
         Button button1, button2, button3;
         public void init() {
             button1 = new Button("Ok");
             button2 = new Button("Open");
             button3 = new Button("Close");
             add(button1);
             add(button2);
             add(button3);
         }
     }
     

    A flow layout lets each component assume its natural (preferred) size.

    Since:
    JDK1.0
    See Also:
    ComponentOrientation, Serialized Form
    • Fields 
      Modifier and Type Field and Description
      Ordinary member indicator CENTER Reveal DetailHide Detail
      static int CENTER
      This value indicates that each row of components should be centered.
      public static final int CENTER
      This value indicates that each row of components should be centered.
      See Also:
      Constant Field Values
      Ordinary member indicator LEADING Reveal DetailHide Detail
      static int LEADING
      This value indicates that each row of components should be justified to the leading edge of the container's orientation, for example, to the left in left-to-right orientations.
      public static final int LEADING
      This value indicates that each row of components should be justified to the leading edge of the container's orientation, for example, to the left in left-to-right orientations.
      Since:
      1.2
      See Also:
      Component.getComponentOrientation(), ComponentOrientation, Constant Field Values
      Ordinary member indicator LEFT Reveal DetailHide Detail
      static int LEFT
      This value indicates that each row of components should be left-justified.
      public static final int LEFT
      This value indicates that each row of components should be left-justified.
      See Also:
      Constant Field Values
      Ordinary member indicator RIGHT Reveal DetailHide Detail
      static int RIGHT
      This value indicates that each row of components should be right-justified.
      public static final int RIGHT
      This value indicates that each row of components should be right-justified.
      See Also:
      Constant Field Values
      Ordinary member indicator TRAILING Reveal DetailHide Detail
      static int TRAILING
      This value indicates that each row of components should be justified to the trailing edge of the container's orientation, for example, to the right in left-to-right orientations.
      public static final int TRAILING
      This value indicates that each row of components should be justified to the trailing edge of the container's orientation, for example, to the right in left-to-right orientations.
      Since:
      1.2
      See Also:
      Component.getComponentOrientation(), ComponentOrientation, Constant Field Values
    • Constructors 
      Constructor and Description
      Ordinary member indicator FlowLayout Reveal DetailHide Detail
      FlowLayout()
      Constructs a new FlowLayout with a centered alignment and a default 5-unit horizontal and vertical gap.
      public FlowLayout()
      Constructs a new FlowLayout with a centered alignment and a default 5-unit horizontal and vertical gap.
      Ordinary member indicator FlowLayout Reveal DetailHide Detail
      FlowLayout(int align)
      Constructs a new FlowLayout with the specified alignment and a default 5-unit horizontal and vertical gap.
      public FlowLayout(int align)
      Constructs a new FlowLayout with the specified alignment and a default 5-unit horizontal and vertical gap. The value of the alignment argument must be one of FlowLayout.LEFT, FlowLayout.RIGHT, FlowLayout.CENTER, FlowLayout.LEADING, or FlowLayout.TRAILING.
      Parameters:
      align - the alignment value
      Ordinary member indicator FlowLayout Reveal DetailHide Detail
      FlowLayout(int align, int hgap, int vgap)
      Creates a new flow layout manager with the indicated alignment and the indicated horizontal and vertical gaps.
      public FlowLayout(int align, int hgap, int vgap)
      Creates a new flow layout manager with the indicated alignment and the indicated horizontal and vertical gaps.

      The value of the alignment argument must be one of FlowLayout.LEFT, FlowLayout.RIGHT, FlowLayout.CENTER, FlowLayout.LEADING, or FlowLayout.TRAILING.

      Parameters:
      align - the alignment value
      hgap - the horizontal gap between components and between the components and the borders of the Container
      vgap - the vertical gap between components and between the components and the borders of the Container
    • Methods 
      Modifier and Type Method and Description
      Ordinary member indicator addLayoutComponent Reveal DetailHide Detail
      void addLayoutComponent(java.lang.String name, Component comp)
      Adds the specified component to the layout.
      public void addLayoutComponent(java.lang.String name, Component comp)
      Adds the specified component to the layout. Not used by this class.
      Specified by:
      addLayoutComponent in interface LayoutManager
      Parameters:
      name - the name of the component
      comp - the component to be added
      Ordinary member indicator getAlignment Reveal DetailHide Detail
      int getAlignment()
      Gets the alignment for this layout.
      public int getAlignment()
      Gets the alignment for this layout. Possible values are FlowLayout.LEFT, FlowLayout.RIGHT, FlowLayout.CENTER, FlowLayout.LEADING, or FlowLayout.TRAILING.
      Returns:
      the alignment value for this layout
      Since:
      JDK1.1
      See Also:
      setAlignment(int)
      Ordinary member indicator getAlignOnBaseline Reveal DetailHide Detail
      boolean getAlignOnBaseline()
      Returns true if components are to be vertically aligned along their baseline.
      public boolean getAlignOnBaseline()
      Returns true if components are to be vertically aligned along their baseline. The default is false.
      Returns:
      true if components are to be vertically aligned along their baseline
      Since:
      1.6
      Ordinary member indicator getHgap Reveal DetailHide Detail
      int getHgap()
      Gets the horizontal gap between components and between the components and the borders of the Container
      public int getHgap()
      Gets the horizontal gap between components and between the components and the borders of the Container
      Returns:
      the horizontal gap between components and between the components and the borders of the Container
      Since:
      JDK1.1
      See Also:
      setHgap(int)
      Ordinary member indicator getVgap Reveal DetailHide Detail
      int getVgap()
      Gets the vertical gap between components and between the components and the borders of the Container.
      public int getVgap()
      Gets the vertical gap between components and between the components and the borders of the Container.
      Returns:
      the vertical gap between components and between the components and the borders of the Container
      Since:
      JDK1.1
      See Also:
      setVgap(int)
      Ordinary member indicator layoutContainer Reveal DetailHide Detail
      void layoutContainer(Container target)
      Lays out the container.
      public void layoutContainer(Container target)
      Lays out the container. This method lets each visible component take its preferred size by reshaping the components in the target container in order to satisfy the alignment of this FlowLayout object.
      Specified by:
      layoutContainer in interface LayoutManager
      Parameters:
      target - the specified component being laid out
      See Also:
      Container, Container.doLayout()
      Ordinary member indicator minimumLayoutSize Reveal DetailHide Detail
      Dimension minimumLayoutSize(Container target)
      Returns the minimum dimensions needed to layout the visible components contained in the specified target container.
      public Dimension minimumLayoutSize(Container target)
      Returns the minimum dimensions needed to layout the visible components contained in the specified target container.
      Specified by:
      minimumLayoutSize in interface LayoutManager
      Parameters:
      target - the container that needs to be laid out
      Returns:
      the minimum dimensions to lay out the subcomponents of the specified container
      See Also:
      preferredLayoutSize(java.awt.Container), Container, Container.doLayout()
      Ordinary member indicator preferredLayoutSize Reveal DetailHide Detail
      Dimension preferredLayoutSize(Container target)
      Returns the preferred dimensions for this layout given the visible components in the specified target container.
      public Dimension preferredLayoutSize(Container target)
      Returns the preferred dimensions for this layout given the visible components in the specified target container.
      Specified by:
      preferredLayoutSize in interface LayoutManager
      Parameters:
      target - the container that needs to be laid out
      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 the layout.
      public void removeLayoutComponent(Component comp)
      Removes the specified component from the layout. Not used by this class.
      Specified by:
      removeLayoutComponent in interface LayoutManager
      Parameters:
      comp - the component to remove
      See Also:
      Container.removeAll()
      Ordinary member indicator setAlignment Reveal DetailHide Detail
      void setAlignment(int align)
      Sets the alignment for this layout.
      public void setAlignment(int align)
      Sets the alignment for this layout. Possible values are
      • FlowLayout.LEFT
      • FlowLayout.RIGHT
      • FlowLayout.CENTER
      • FlowLayout.LEADING
      • FlowLayout.TRAILING
      Parameters:
      align - one of the alignment values shown above
      Since:
      JDK1.1
      See Also:
      getAlignment()
      Ordinary member indicator setAlignOnBaseline Reveal DetailHide Detail
      void setAlignOnBaseline(boolean alignOnBaseline)
      Sets whether or not components should be vertically aligned along their baseline.
      public void setAlignOnBaseline(boolean alignOnBaseline)
      Sets whether or not components should be vertically aligned along their baseline. Components that do not have a baseline will be centered. The default is false.
      Parameters:
      alignOnBaseline - whether or not components should be vertically aligned on their baseline
      Since:
      1.6
      Ordinary member indicator setHgap Reveal DetailHide Detail
      void setHgap(int hgap)
      Sets the horizontal gap between components and between the components and the borders of the Container.
      public void setHgap(int hgap)
      Sets the horizontal gap between components and between the components and the borders of the Container.
      Parameters:
      hgap - the horizontal gap between components and between the components and the borders of the Container
      Since:
      JDK1.1
      See Also:
      getHgap()
      Ordinary member indicator setVgap Reveal DetailHide Detail
      void setVgap(int vgap)
      Sets the vertical gap between components and between the components and the borders of the Container.
      public void setVgap(int vgap)
      Sets the vertical gap between components and between the components and the borders of the Container.
      Parameters:
      vgap - the vertical gap between components and between the components and the borders of the Container
      Since:
      JDK1.1
      See Also:
      getVgap()
      Overridden member indicator toString Reveal DetailHide Detail
      java.lang.String toString()
      Returns a string representation of this FlowLayout object and its values.
      public java.lang.String toString()
      Returns a string representation of this FlowLayout object and its values.
      Overrides:
      toString in class java.lang.Object
      Returns:
      a string representation of this 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