File	Doc	Category	Size	Date	Package
Box.java	API Doc	Java SE 6 API	14169	Tue Jun 10 00:26:34 BST 2008	javax.swing

Box

• java.lang.Object
  • java.awt.Component
    • java.awt.Container
      • javax.swing.JComponent

Fields Summary

Constructors Summary
public Box(int axis) Creates a Box that displays its components along the the specified axis. param axis can be {@link BoxLayout#X_AXIS}, {@link BoxLayout#Y_AXIS}, {@link BoxLayout#LINE_AXIS} or {@link BoxLayout#PAGE_AXIS}. throws AWTError if the axis is invalid see #createHorizontalBox see #createVerticalBox super(); super.setLayout(new BoxLayout(this, axis));

Methods Summary
public static java.awt.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. return the component return new Filler(new Dimension(0,0), new Dimension(0,0), new Dimension(Short.MAX_VALUE, Short.MAX_VALUE));
public static javax.swing.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); return the box return new Box(BoxLayout.X_AXIS);
public static java.awt.Component	createHorizontalGlue() Creates a horizontal glue component. return the component return new Filler(new Dimension(0,0), new Dimension(0,0), new Dimension(Short.MAX_VALUE, 0));
public static java.awt.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. param width the width of the invisible component, in pixels >= 0 return the component see #createVerticalStrut see #createGlue see #createRigidArea return new Filler(new Dimension(width,0), new Dimension(width,0), new Dimension(width, Short.MAX_VALUE));
public static java.awt.Component	createRigidArea(java.awt.Dimension d) Creates an invisible component that's always the specified size. param d the dimensions of the invisible component return the component see #createGlue see #createHorizontalStrut see #createVerticalStrut return new Filler(d, d, d);
public static javax.swing.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); return the box return new Box(BoxLayout.Y_AXIS);
public static java.awt.Component	createVerticalGlue() Creates a vertical glue component. return the component return new Filler(new Dimension(0,0), new Dimension(0,0), new Dimension(0, Short.MAX_VALUE));
public static java.awt.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. param height the height of the invisible component, in pixels >= 0 return the component see #createHorizontalStrut see #createGlue see #createRigidArea return new Filler(new Dimension(0,height), new Dimension(0,height), new Dimension(Short.MAX_VALUE, height));
public javax.accessibility.AccessibleContext	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. return an AccessibleBox that serves as the AccessibleContext of this Box if (accessibleContext == null) { accessibleContext = new AccessibleBox(); } return accessibleContext;
protected void	paintComponent(java.awt.Graphics g) 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. param g the Graphics to paint to throws NullPointerException if g is null since 1.6 if (ui != null) { // On the off chance some one created a UI, honor it super.paintComponent(g); } else if (isOpaque()) { g.setColor(getBackground()); g.fillRect(0, 0, getWidth(), getHeight()); }
public void	setLayout(java.awt.LayoutManager l) Throws an AWTError, since a Box can use only a BoxLayout. param l the layout manager to use throw new AWTError("Illegal request");