Example:
Nesting multiple panels with different combinations of horizontal and
vertical gives an effect similar to
GridBagLayout, without the
complexity. The diagram shows two panels arranged horizontally, each
of which contains 3 components arranged vertically.
The BoxLayout manager is constructed with an axis parameter that
specifies the type of layout that will be done. There are four choices:
X_AXIS - Components are laid out horizontally
from left to right.Y_AXIS - Components are laid out vertically
from top to bottom.LINE_AXIS - Components are laid out the way
words are laid out in a line, based on the container's
ComponentOrientation property. If the container's
ComponentOrientation is horizontal then components are laid out
horizontally, otherwise they are laid out vertically. For horizontal
orientations, if the container's ComponentOrientation is left to
right then components are laid out left to right, otherwise they are laid
out right to left. For vertical orientations components are always laid out
from top to bottom.PAGE_AXIS - Components are laid out the way
text lines are laid out on a page, based on the container's
ComponentOrientation property. If the container's
ComponentOrientation is horizontal then components are laid out
vertically, otherwise they are laid out horizontally. For horizontal
orientations, if the container's ComponentOrientation is left to
right then components are laid out left to right, otherwise they are laid
out right to left. For vertical orientations components are always
laid out from top to bottom.For all directions, components are arranged in the same order as they were added to the container.
BoxLayout attempts to arrange components at their preferred widths (for a horizontal layout) or heights (for a vertical layout).
For a horizontal layout,
if not all the components are the same height,
BoxLayout attempts to make all the components
as high as the highest component.
If that's not possible for a particular component,
then BoxLayout aligns that component vertically,
according to the component's Y alignment.
By default, a component has a Y alignment of 0.5,
which means that the vertical center of the component
should have the same Y coordinate as
the vertical centers of other components with 0.5 Y alignment.
Similarly, for a vertical layout,
BoxLayout attempts to make all components in the column
as wide as the widest component.
If that fails, it aligns them horizontally
according to their X alignments. For PAGE_AXIS layout,
horizontal alignment is done based on the leading edge of the component.
In other words, an X alignment value of 0.0 means the left edge of a
component if the container's ComponentOrientation is left to
right, and it means the right edge of the component otherwise.
Instead of using BoxLayout directly,
many programs use the Box class.
The Box class is a lightweight container that uses
the BoxLayout layout manager.
It also provides handy methods to help you use BoxLayout well.
Adding components to multiple nested boxes is a powerful way to get
the arrangement you want.
For further information and examples see How to Use BoxLayout, a section in The Java Tutorial.
Warning
Serialized objects of this class will not be compatible with
future Swing releases. The current serialization support is
appropriate for short term storage or RMI between applications running
the same version of Swing. As of 1.4, support for long term storage
of all JavaBeans
has been added to the java.beans package.
Please see java..
Box, java.awt.ComponentOrientation , JComponent#getAlignmentX, JComponent#getAlignmentY
| Modifier and Type | Field and Description |
|---|---|
| private int | |
| private transient PrintStream | |
| public static final int | LINE_AXIS
Specifies that components should be laid out in the direction of
a line of text as determined by the target container's
|
| public static final int | PAGE_AXIS
Specifies that components should be laid out in the direction that
lines flow across a page as determined by the target container's
|
| private Container | |
| public static final int | X_AXIS
Specifies that components should be laid out left to right. |
| private transient SizeRequirements[] | |
| private transient SizeRequirements | |
| public static final int | Y_AXIS
Specifies that components should be laid out top to bottom. |
| private transient SizeRequirements[] | |
| private transient SizeRequirements |
| Access | Constructor and Description |
|---|---|
| public | |
| pack-priv | BoxLayout(Container
the container that needs to be laid out target, int the axis to lay out components along. Can be one of:
axis, PrintStream BoxLayout.X_AXIS, BoxLayout.Y_AXIS,
BoxLayout.LINE_AXIS or BoxLayout.PAGE_AXISthe stream to which debugging messages should be sent,
null if none dbg)Constructs a BoxLayout that produces debugging messages. |
| Modifier and Type | Method and Description |
|---|---|
| public void | addLayoutComponent(String
the name of the component name, Component the component comp)Implements java. Not used by this class. |
| public void | addLayoutComponent(Component
the component comp, Object constraints constraints)Implements java. Not used by this class. |
| pack-priv void | |
| pack-priv void | |
| public final int | Returns: the axis that was used to lay out componentsReturns the axis that was used to lay out components. |
| public synchronized float | Returns: the alignment >= 0.0f && <= 1.0fthe container target)Implements java. Returns the alignment along the X axis for the container. |
| public synchronized float | Returns: the alignment >= 0.0f && <= 1.0fthe container target)Implements java. Returns the alignment along the Y axis for the container. |
| public final Container | Returns: the container that uses this layout managerReturns the container that uses this layout manager. |
| public synchronized void | invalidateLayout(Container
the affected container target)Implements java. Indicates that a child has changed its layout related information, and thus any cached calculations should be flushed. |
| public void | layoutContainer(Container
the container to lay out target)Implements java. Called by the AWT when the specified container needs to be laid out. |
| public Dimension | Returns: the dimensions >= 0 && <= Integer.MAX_VALUEthe container that needs to be laid out target)Implements java. Returns the maximum dimensions the target container can use to lay out the components it contains. |
| public Dimension | Returns: the dimensions >= 0 && <= Integer.MAX_VALUEthe container that needs to be laid out target)Implements java. Returns the minimum dimensions needed to lay out the components contained in the specified target container. |
| public Dimension | Returns: the dimensions >= 0 && <= Integer.MAX_VALUEthe container that needs to be laid out target)Implements java. Returns the preferred dimensions for this layout, given the components in the specified target container. |
| public void | removeLayoutComponent(Component
the component comp)Implements java. Not used by this class. |
| private int | Returns: the resolved axisthe axis to resolve axis, ComponentOrientation the ComponentOrientation to resolve against o)Given one of the 4 axis values, resolve it to an absolute axis. |
| axis | back to summary |
|---|---|
| private int axis | |
| dbg | back to summary |
|---|---|
| private transient PrintStream dbg | |
| LINE_AXIS | back to summary |
|---|---|
| public static final int LINE_AXIS Specifies that components should be laid out in the direction of
a line of text as determined by the target container's
| |
| PAGE_AXIS | back to summary |
|---|---|
| public static final int PAGE_AXIS Specifies that components should be laid out in the direction that
lines flow across a page as determined by the target container's
| |
| target | back to summary |
|---|---|
| private Container target | |
| X_AXIS | back to summary |
|---|---|
| public static final int X_AXIS Specifies that components should be laid out left to right. | |
| xChildren | back to summary |
|---|---|
| private transient SizeRequirements[] xChildren | |
| xTotal | back to summary |
|---|---|
| private transient SizeRequirements xTotal | |
| Y_AXIS | back to summary |
|---|---|
| public static final int Y_AXIS Specifies that components should be laid out top to bottom. | |
| yChildren | back to summary |
|---|---|
| private transient SizeRequirements[] yChildren | |
| yTotal | back to summary |
|---|---|
| private transient SizeRequirements yTotal | |
| BoxLayout | back to summary |
|---|---|
| public BoxLayout(Container target, int axis) Creates a layout manager that will lay out components along the given axis.
| |
| BoxLayout | back to summary |
|---|---|
| pack-priv BoxLayout(Container target, int axis, PrintStream dbg) Constructs a BoxLayout that produces debugging messages.
| |
| addLayoutComponent | back to summary |
|---|---|
| public void addLayoutComponent(String name, Component comp) Implements java. Not used by this class. | |
| addLayoutComponent | back to summary |
|---|---|
| public void addLayoutComponent(Component comp, Object constraints) Implements java. Not used by this class. | |
| checkContainer | back to summary |
|---|---|
| pack-priv void checkContainer(Container target) | |
| checkRequests | back to summary |
|---|---|
| pack-priv void checkRequests() | |
| getAxis | back to summary |
|---|---|
| public final int getAxis() Returns the axis that was used to lay out components.
Returns one of:
| |
| getLayoutAlignmentX | back to summary |
|---|---|
| public synchronized float getLayoutAlignmentX(Container target) Implements java. Returns the alignment along the X axis for the container. If the box is horizontal, the default alignment will be returned. Otherwise, the alignment needed to place the children along the X axis will be returned. | |
| getLayoutAlignmentY | back to summary |
|---|---|
| public synchronized float getLayoutAlignmentY(Container target) Implements java. Returns the alignment along the Y axis for the container. If the box is vertical, the default alignment will be returned. Otherwise, the alignment needed to place the children along the Y axis will be returned. | |
| getTarget | back to summary |
|---|---|
| public final Container getTarget() Returns the container that uses this layout manager.
| |
| invalidateLayout | back to summary |
|---|---|
| public synchronized void invalidateLayout(Container target) Implements java. Indicates that a child has changed its layout related information, and thus any cached calculations should be flushed. This method is called by AWT when the invalidate method is called on the Container. Since the invalidate method may be called asynchronously to the event thread, this method may be called asynchronously. | |
| layoutContainer | back to summary |
|---|---|
| public void layoutContainer(Container target) Implements java. Called by the AWT when the specified container needs to be laid out. | |
| maximumLayoutSize | back to summary |
|---|---|
| public Dimension maximumLayoutSize(Container target) Implements java. Returns the maximum dimensions the target container can use to lay out the components it contains.
| |
| minimumLayoutSize | back to summary |
|---|---|
| public Dimension minimumLayoutSize(Container target) Implements java. Returns the minimum dimensions needed to lay out the components contained in the specified target container.
| |
| preferredLayoutSize | back to summary |
|---|---|
| public Dimension preferredLayoutSize(Container target) Implements java. Returns the preferred dimensions for this layout, given the components in the specified target container.
| |
| removeLayoutComponent | back to summary |
|---|---|
| public void removeLayoutComponent(Component comp) Implements java. Not used by this class.
| |
| resolveAxis | back to summary |
|---|---|
| private int resolveAxis(int axis, ComponentOrientation o) Given one of the 4 axis values, resolve it to an absolute axis. The relative axis values, PAGE_AXIS and LINE_AXIS, are converted to their absolute counterpart given the target's ComponentOrientation value. The absolute axes, X_AXIS and Y_AXIS, are returned unmodified.
| |