A lightweight container that uses a BoxLayout object as its layout manager. Box provides several class methods that are useful for containers using BoxLayout -- even non-Box containers.

The Box class can create several kinds of invisible components that affect layout: glue, struts, and rigid areas. If all the components your Box contains have a fixed size, you might want to use a glue component (returned by createGlue) to control the components' positions. If you need a fixed amount of space between two components, try using a strut (createHorizontalStrut or createVerticalStrut). If you need an invisible component that always takes up the same amount of space, get it by invoking createRigidArea.

If you are implementing a BoxLayout you can find further information and examples in 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.beans.XMLEncoder.

Nested and Inner Type Summary

Modifier and Type	Class and Description
protected class	Box.AccessibleBox This class implements accessibility support for the `Box` class.
public static class	Box.Filler An implementation of a lightweight component that participates in layout but has no view.

Field Summary

Inherited from javax.swing.JComponent:: DEBUG_GRAPHICS_LOADED focusController ivSourceComponent listenerList paintingChild TOOL_TIP_TEXT_KEY ui UNDEFINED_CONDITION WHEN_ANCESTOR_OF_FOCUSED_COMPONENT WHEN_FOCUSED WHEN_IN_FOCUSED_WINDOW

Constructor Summary

Access	Constructor and Description
public	Box(int can be `BoxLayout#X_AXIS`, `BoxLayout#Y_AXIS`, `BoxLayout#LINE_AXIS` or `BoxLayout#PAGE_AXIS`. axis) Creates a `Box` that displays its components along the specified axis.

Method Summary

Modifier and Type	Method and Description
public static Component	Returns: the component createGlue() Creates an invisible "glue" component that can be useful in a Box whose visible components have a maximum width (for a horizontal box) or height (for a vertical box).
public static Box	Returns: the box createHorizontalBox() Creates a `Box` that displays its components from left to right.
public static Component	Returns: the component createHorizontalGlue() Creates a horizontal glue component.
public static Component	Returns: the component createHorizontalStrut(int the width of the invisible component, in pixels >= 0 width) Creates an invisible, fixed-width component.
public static Component	Returns: the component createRigidArea(Dimension the dimensions of the invisible component d) Creates an invisible component that's always the specified size.
public static Box	Returns: the box createVerticalBox() Creates a `Box` that displays its components from top to bottom.
public static Component	Returns: the component createVerticalGlue() Creates a vertical glue component.
public static Component	Returns: the component createVerticalStrut(int the height of the invisible component, in pixels >= 0 height) Creates an invisible, fixed-height component.
public AccessibleContext	Returns: an AccessibleBox that serves as the AccessibleContext of this Box getAccessibleContext() Overrides java.awt.Component.getAccessibleContext. Implements javax.accessibility.Accessible.getAccessibleContext. Gets the AccessibleContext associated with this Box.
protected void	paintComponent(Graphics the `Graphics` to paint to g) Overrides javax.swing.JComponent.paintComponent. Paints this `Box`.
public void	setLayout(LayoutManager the layout manager to use l) Overrides java.awt.Container.setLayout. Throws an AWTError, since a Box can use only a BoxLayout.

Inherited from javax.swing.JComponent:: _paintImmediately addAncestorListener addNotify addVetoableChangeListener alwaysOnTop checkIfChildObscuredBySibling clientPropertyChanged componentInputMapChanged computeVisibleRect computeVisibleRect compWriteObjectNotify contains createToolTip disable dndDone dropLocationForPoint enable firePropertyChange firePropertyChange firePropertyChange fireVetoableChange getActionForKeyStroke getActionMap getActionMap getAlignmentX getAlignmentY getAncestorListeners getAutoscrolls getBaseline getBaselineResizeBehavior getBorder getBounds getClientProperty getComponentGraphics getComponentPopupMenu getConditionForKeyStroke getCreatedDoubleBuffer getDebugGraphicsOptions getDefaultLocale getFontMetrics getGraphics getGraphicsInvoked getHeight getInheritsPopupMenu getInputMap getInputMap getInputMap getInputVerifier getInsets getInsets getListeners getLocation getManagingFocusBackwardTraversalKeys getManagingFocusForwardTraversalKeys getMaximumSize getMinimumSize getNextFocusableComponent getPopupLocation getPreferredSize getRegisteredKeyStrokes getRootPane getSize getToolTipLocation getToolTipText getToolTipText getTopLevelAncestor getTransferHandler getUI getUIClassID getVerifyInputWhenFocusTarget getVetoableChangeListeners getVisibleRect getWidth getWriteObjCounter getX getY grabFocus hide isDoubleBuffered isLightweightComponent isManagingFocus isOpaque isOptimizedDrawingEnabled isPainting isPaintingForPrint isPaintingOrigin isPaintingTile isRequestFocusEnabled isValidateRoot paint paintBorder paintChildren paintForceDoubleBuffered paintImmediately paintImmediately paintToOffscreen paramString print printAll printBorder printChildren printComponent processComponentKeyEvent processKeyBinding processKeyBindings processKeyBindingsForAllComponents processKeyEvent processMouseEvent processMouseMotionEvent putClientProperty rectangleIsObscured registerKeyboardAction registerKeyboardAction removeAncestorListener removeNotify removeVetoableChangeListener repaint repaint requestDefaultFocus requestFocus requestFocus requestFocusInWindow requestFocusInWindow resetKeyboardActions reshape revalidate safelyGetGraphics safelyGetGraphics scrollRectToVisible setActionMap setAlignmentX setAlignmentY setAutoscrolls setBackground setBorder setComponentPopupMenu setCreatedDoubleBuffer setDebugGraphicsOptions setDefaultLocale setDoubleBuffered setDropLocation setEnabled setFocusTraversalKeys setFont setForeground setInheritsPopupMenu setInputMap setInputVerifier setMaximumSize setMinimumSize setNextFocusableComponent setOpaque setPaintingChild setPreferredSize setRequestFocusEnabled setToolTipText setTransferHandler setUI setUIProperty setVerifyInputWhenFocusTarget setVisible setWriteObjCounter shouldDebugGraphics superProcessMouseMotionEvent unregisterKeyboardAction update updateUI

Constructor Detail

Box back to summary

Box	back to summary
public Box(int axis) Creates a `Box` that displays its components along the specified axis. Parameters axis:int can be `BoxLayout#X_AXIS`, `BoxLayout#Y_AXIS`, `BoxLayout#LINE_AXIS` or `BoxLayout#PAGE_AXIS`. Exceptions AWTError: if the `axis` is invalid See Also `createHorizontalBox`, `createVerticalBox`

public Box(int axis)

Creates a Box that displays its components along the specified axis.

Parameters

axis:int: can be BoxLayout#X_AXIS, BoxLayout#Y_AXIS, BoxLayout#LINE_AXIS or BoxLayout#PAGE_AXIS.

Exceptions

AWTError:: if the axis is invalid

Method Detail

createGlue back to summary

createGlue	back to summary
public static Component createGlue() Creates an invisible "glue" component that can be useful in a Box whose visible components have a maximum width (for a horizontal box) or height (for a vertical box). You can think of the glue component as being a gooey substance that expands as much as necessary to fill the space between its neighboring components. For example, suppose you have a horizontal box that contains two fixed-size components. If the box gets extra space, the fixed-size components won't become larger, so where does the extra space go? Without glue, the extra space goes to the right of the second component. If you put glue between the fixed-size components, then the extra space goes there. If you put glue before the first fixed-size component, the extra space goes there, and the fixed-size components are shoved against the right edge of the box. If you put glue before the first fixed-size component and after the second fixed-size component, the fixed-size components are centered in the box. To use glue, call `Box.createGlue` and add the returned component to a container. The glue component has no minimum or preferred size, so it takes no space unless excess space is available. If excess space is available, then the glue component takes its share of available horizontal or vertical space, just like any other component that has no maximum width or height. Returns:Component the component

public static Component createGlue()

Creates an invisible "glue" component that can be useful in a Box whose visible components have a maximum width (for a horizontal box) or height (for a vertical box). You can think of the glue component as being a gooey substance that expands as much as necessary to fill the space between its neighboring components.

For example, suppose you have a horizontal box that contains two fixed-size components. If the box gets extra space, the fixed-size components won't become larger, so where does the extra space go? Without glue, the extra space goes to the right of the second component. If you put glue between the fixed-size components, then the extra space goes there. If you put glue before the first fixed-size component, the extra space goes there, and the fixed-size components are shoved against the right edge of the box. If you put glue before the first fixed-size component and after the second fixed-size component, the fixed-size components are centered in the box.

To use glue, call Box.createGlue and add the returned component to a container. The glue component has no minimum or preferred size, so it takes no space unless excess space is available. If excess space is available, then the glue component takes its share of available horizontal or vertical space, just like any other component that has no maximum width or height.

Returns:Component: the component

createHorizontalBox back to summary

createHorizontalBox	back to summary
public static Box createHorizontalBox() Creates a `Box` that displays its components from left to right. If you want a `Box` that respects the component orientation you should create the `Box` using the constructor and pass in `BoxLayout.LINE_AXIS`, eg: Box lineBox = new Box(BoxLayout.LINE_AXIS); Returns:Box the box

public static Box createHorizontalBox()

Creates a Box that displays its components from left to right. If you want a Box that respects the component orientation you should create the Box using the constructor and pass in BoxLayout.LINE_AXIS, eg:

  Box lineBox = new Box(BoxLayout.LINE_AXIS);

Returns:Box: the box

createHorizontalGlue	back to summary
public static Component createHorizontalGlue() Creates a horizontal glue component. Returns:Component the component

createHorizontalGlue

back to summary

public static Component createHorizontalGlue()

Creates a horizontal glue component.

Returns:Component: the component

createHorizontalStrut back to summary

createHorizontalStrut	back to summary
public static Component createHorizontalStrut(int width) Creates an invisible, fixed-width component. In a horizontal box, you typically use this method to force a certain amount of space between two components. In a vertical box, you might use this method to force the box to be at least the specified width. The invisible component has no height unless excess space is available, in which case it takes its share of available space, just like any other component that has no maximum height. Parameters width:int the width of the invisible component, in pixels >= 0 Returns:Component the component See Also `createVerticalStrut`, `createGlue`, `createRigidArea`

public static Component createHorizontalStrut(int width)

Creates an invisible, fixed-width component. In a horizontal box, you typically use this method to force a certain amount of space between two components. In a vertical box, you might use this method to force the box to be at least the specified width. The invisible component has no height unless excess space is available, in which case it takes its share of available space, just like any other component that has no maximum height.

Parameters

width:int: the width of the invisible component, in pixels >= 0

Returns:Component

the component

createRigidArea back to summary

createRigidArea	back to summary
public static Component createRigidArea(Dimension d) Creates an invisible component that's always the specified size. Parameters d:Dimension the dimensions of the invisible component Returns:Component the component See Also `createGlue`, `createHorizontalStrut`, `createVerticalStrut`

public static Component createRigidArea(Dimension d)

Creates an invisible component that's always the specified size.

Parameters

d:Dimension: the dimensions of the invisible component

Returns:Component

the component

createVerticalBox back to summary

createVerticalBox	back to summary
public static Box createVerticalBox() Creates a `Box` that displays its components from top to bottom. If you want a `Box` that respects the component orientation you should create the `Box` using the constructor and pass in `BoxLayout.PAGE_AXIS`, eg: Box lineBox = new Box(BoxLayout.PAGE_AXIS); Returns:Box the box

public static Box createVerticalBox()

Creates a Box that displays its components from top to bottom. If you want a Box that respects the component orientation you should create the Box using the constructor and pass in BoxLayout.PAGE_AXIS, eg:

  Box lineBox = new Box(BoxLayout.PAGE_AXIS);

Returns:Box: the box

createVerticalGlue	back to summary
public static Component createVerticalGlue() Creates a vertical glue component. Returns:Component the component

createVerticalGlue

back to summary

public static Component createVerticalGlue()

Creates a vertical glue component.

Returns:Component: the component

createVerticalStrut back to summary

createVerticalStrut	back to summary
public static Component createVerticalStrut(int height) Creates an invisible, fixed-height component. In a vertical box, you typically use this method to force a certain amount of space between two components. In a horizontal box, you might use this method to force the box to be at least the specified height. The invisible component has no width unless excess space is available, in which case it takes its share of available space, just like any other component that has no maximum width. Parameters height:int the height of the invisible component, in pixels >= 0 Returns:Component the component See Also `createHorizontalStrut`, `createGlue`, `createRigidArea`

public static Component createVerticalStrut(int height)

Creates an invisible, fixed-height component. In a vertical box, you typically use this method to force a certain amount of space between two components. In a horizontal box, you might use this method to force the box to be at least the specified height. The invisible component has no width unless excess space is available, in which case it takes its share of available space, just like any other component that has no maximum width.

Parameters

height:int: the height of the invisible component, in pixels >= 0

Returns:Component

the component

getAccessibleContext	back to summary
public AccessibleContext getAccessibleContext() Overrides java.awt.Component.getAccessibleContext. Implements javax.accessibility.Accessible.getAccessibleContext. Gets the AccessibleContext associated with this Box. For boxes, the AccessibleContext takes the form of an AccessibleBox. A new AccessibleAWTBox instance is created if necessary. Returns:AccessibleContext an AccessibleBox that serves as the AccessibleContext of this Box Annotations @BeanProperty bound:false

getAccessibleContext

back to summary

public AccessibleContext getAccessibleContext()

Overrides java.awt.Component.getAccessibleContext.

Implements javax.accessibility.Accessible.getAccessibleContext.

Gets the AccessibleContext associated with this Box. For boxes, the AccessibleContext takes the form of an AccessibleBox. A new AccessibleAWTBox instance is created if necessary.

Returns:AccessibleContext

an AccessibleBox that serves as the AccessibleContext of this Box

Annotations

@BeanProperty
bound:false

paintComponent back to summary

paintComponent	back to summary
protected void paintComponent(Graphics g) Overrides javax.swing.JComponent.paintComponent. Paints this `Box`. If this `Box` has a UI this method invokes super's implementation, otherwise if this `Box` is opaque the `Graphics` is filled using the background. Parameters g:Graphics the `Graphics` to paint to Exceptions NullPointerException: if `g` is null Since 1.6

protected void paintComponent(Graphics g)

Overrides javax.swing.JComponent.paintComponent.

Paints this Box. If this Box has a UI this method invokes super's implementation, otherwise if this Box is opaque the Graphics is filled using the background.

Parameters

g:Graphics: the Graphics to paint to

Exceptions

NullPointerException:: if g is null

Since

1.6

setLayout	back to summary
public void setLayout(LayoutManager l) Overrides java.awt.Container.setLayout. Throws an AWTError, since a Box can use only a BoxLayout. Parameters l:LayoutManager the layout manager to use

setLayout

back to summary

public void setLayout(LayoutManager l)

Overrides java.awt.Container.setLayout.

Throws an AWTError, since a Box can use only a BoxLayout.

Parameters

l:LayoutManager: the layout manager to use

javax.swing back to summary

protected Class Box.AccessibleBox

Class Inheritance

extends AccessibleAWTContainer

java.lang.Object
javax.accessibility.AccessibleContext
java.awt.Component.AccessibleAWTComponent
java.awt.Container.AccessibleAWTContainer
javax.swing.Box.AccessibleBox

Annotations

@SuppressWarnings:serial

This class implements accessibility support for the Box class.

Field Summary

Inherited from java.awt.Container.AccessibleAWTContainer:: accessibleContainerHandler

Constructor Summary

Access	Constructor and Description
protected	AccessibleBox() Constructs an `AccessibleBox`.

Method Summary

Modifier and Type	Method and Description
public AccessibleRole	Returns: an instance of AccessibleRole describing the role of the object (AccessibleRole.FILLER) getAccessibleRole() Overrides java.awt.Component.AccessibleAWTComponent.getAccessibleRole. Gets the role of this object.

Inherited from java.awt.Container.AccessibleAWTContainer:: addPropertyChangeListener getAccessibleAt getAccessibleChild getAccessibleChildrenCount removePropertyChangeListener

Constructor Detail

AccessibleBox	back to summary
protected AccessibleBox() Constructs an `AccessibleBox`.

Method Detail

getAccessibleRole back to summary

getAccessibleRole	back to summary
public AccessibleRole getAccessibleRole() Overrides java.awt.Component.AccessibleAWTComponent.getAccessibleRole. Gets the role of this object. Returns:AccessibleRole an instance of AccessibleRole describing the role of the object (AccessibleRole.FILLER) See Also `AccessibleRole`

public AccessibleRole getAccessibleRole()

Overrides java.awt.Component.AccessibleAWTComponent.getAccessibleRole.

Gets the role of this object.

Returns:AccessibleRole: an instance of AccessibleRole describing the role of the object (AccessibleRole.FILLER)
See Also: AccessibleRole

public Class Box

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

protected Class Box.AccessibleBox

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public Class Box.Filler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

protected Class Box.Filler.AccessibleBoxFiller

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

Modifier and Type	Method and Description
public void	changeShape(Dimension Value to return for getMinimumSize min, Dimension Value to return for getPreferredSize pref, Dimension Value to return for getMaximumSize max) Change the size requests for this shape.
public AccessibleContext	Returns: an AccessibleBoxFiller that serves as the AccessibleContext of this Box.Filler. getAccessibleContext() Overrides java.awt.Component.getAccessibleContext. Implements javax.accessibility.Accessible.getAccessibleContext. Gets the AccessibleContext associated with this Box.Filler.
protected void	paintComponent(Graphics the `Graphics` to paint to g) Overrides javax.swing.JComponent.paintComponent. Paints this `Filler`.