java.

awt

Class Container

java.lang.Object

java.awt.Component

java.awt.Container

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

Direct Known Subclasses:

BasicSplitPaneDivider, CellRendererPane, DefaultTreeCellEditor.EditorContainer, JComponent, Panel, ScrollPane, Window

public class Container extends Component

A generic Abstract Window Toolkit(AWT) container object is a component that can contain other AWT components. Components added to a container are tracked in a list. The order of the list will define the components' front-to-back stacking order within the container. If no index is specified when adding a component to a container, it will be added to the end of the list (and hence to the bottom of the stacking order). Note: For details on the focus subsystem, see How to Use the Focus Subsystem, a section in The Java Tutorial, and the Focus Specification for more information.

Since:
JDK1.0

See Also:

add(java.awt.Component, int), getComponent(int), LayoutManager, Serialized Form

Nested Class Summary

Nested Classes Modifier and Type Class and Description

protected class

Container.AccessibleAWTContainer
Inner class of Container used to provide default support for accessibility.

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary
Constructors Constructor and Description

Container()
Constructs a new Container.

Method Summary
Methods Modifier and Type Method and Description

Component Component void void

add(Component comp)
Appends the specified component to the end of this container.

add(Component comp, int index)

Adds the specified component to this container at the given position.

add(Component comp, Object constraints)

Adds the specified component to the end of this container.

add(Component comp, Object constraints, int index)

Adds the specified component to this container with the specified constraints at the specified index.

Component void protected void

add(String name, Component comp)

Adds the specified component to this container.

addContainerListener(ContainerListener l)
Adds the specified container listener to receive container events from this container.

addImpl(Component comp, Object constraints, int index)

Adds the specified component to this container at the specified index.

void void

addNotify()
Makes this Container displayable by connecting it to a native screen resource.

addPropertyChangeListener(PropertyChangeList ener listener)

Adds a PropertyChangeListener to the listener list.

void

addPropertyChangeListener(String propertyNam e, PropertyChangeListener listener)

Adds a PropertyChangeListener to the listener list for a specific property.

void

applyComponentOrientation(ComponentOrientati on o) Sets the ComponentOrientation property of this container and

all components contained within it.

boolean int void

areFocusTraversalKeysSet(int id)
Returns whether the Set of focus traversal keys for the given focus traversal operation has been explicitly defined for this Container.

countComponents()
Deprecated. As of JDK version 1.1, replaced by getComponentCount().

deliverEvent(Event e)
Deprecated. As of JDK version 1.1, replaced by

dispatchEvent(AWTEvent

e) void Component Component float float Component Component Component int Component[] int ContainerListener[] Set<AWTKeyStroke> FocusTraversalPolicy Insets LayoutManager <T extends EventListener> T[] doLayout()
Causes this container to lay out its components.

findComponentAt(int x, int y)
Locates the visible child component that contains the specified position.

findComponentAt(Point p)
Locates the visible child component that contains the specified point.

getAlignmentX()
Returns the alignment along the x axis.

getAlignmentY()
Returns the alignment along the y axis.

getComponent(int n)
Gets the nth component in this container.

getComponentAt(int x, int y)
Locates the component that contains the x,y position.

getComponentAt(Point p)
Gets the component that contains the specified point.

getComponentCount()
Gets the number of components in this panel.

getComponents()
Gets all the components in this container.

getComponentZOrder(Component comp)
Returns the z-order index of the component inside the container.

getContainerListeners()
Returns an array of all the container listeners registered on this container.

getFocusTraversalKeys(int id)
Returns the Set of focus traversal keys for a given traversal operation for this Container.

getFocusTraversalPolicy()
Returns the focus traversal policy that will manage keyboard traversal of this Container's children, or null if this Container is not a focus cycle root.

getInsets()
Determines the insets of this container, which indicate the size of the container's border.

getLayout()
Gets the layout manager for this container.

getListeners(Class<T> listenerType)
Returns an array of all the objects currently registered as FooListeners upon this Container.

Dimension Dimension Point

getMaximumSize()
Returns the maximum size of this container.

getMinimumSize()
Returns the minimum size of this container.

getMousePosition(boolean allowChildren) Returns the position of the mouse pointer in this Container's coordinate space if the Container is under the mouse pointer, otherwise returns null. getPreferredSize()
Returns the preferred size of this container.

Dimension Insets

insets()
Deprecated. As of JDK version 1.1, replaced by

getInsets().

void boolean boolean boolean boolean boolean boolean void

invalidate()
Invalidates the container.

isAncestorOf(Component c)
Checks if the component is contained in the component hierarchy of this container.

isFocusCycleRoot()
Returns whether this Container is the root of a focus traversal cycle.

isFocusCycleRoot(Container container)
Returns whether the specified Container is the focus cycle root of this Container's focus traversal cycle.

isFocusTraversalPolicyProvider()
Returns whether this container provides focus traversal policy.

isFocusTraversalPolicySet()
Returns whether the focus traversal policy has been explicitly set for this Container.

isValidateRoot()
Indicates if this container is a validate root.

layout()
Deprecated. As of JDK version 1.1, replaced by

doLayout().

void void Component

list(PrintStream out, int indent)

Prints a listing of this container to the specified output stream.

list(PrintWriter out, int indent)

Prints out a list, starting at the specified indentation, to the specified print writer.

locate(int x, int y)
Deprecated. As of JDK version 1.1, replaced by int).

getComponentAt(int,

Dimension

minimumSize()
Deprecated. As of JDK version 1.1, replaced by

getMinimumSize().

void void protected String

paint(Graphics g)
Paints the container.

paintComponents(Graphics g)
Paints each of the components in this container.

paramString()
Returns a string representing the state of this

Container.

Dimension

preferredSize()
Deprecated. As of JDK version 1.1, replaced by

getPreferredSize().

void void protected void protected void void void void void void void

print(Graphics g)
Prints the container.

printComponents(Graphics g)
Prints each of the components in this container.

processContainerEvent(ContainerEvent e)
Processes container events occurring on this container by dispatching them to any registered ContainerListener objects.

processEvent(AWTEvent e)
Processes events on this container.

remove(Component comp)
Removes the specified component from this container.

remove(int index)
Removes the component, specified by index, from this container.

removeAll()
Removes all the components from this container.

removeContainerListener(ContainerListener l)
Removes the specified container listener so it no longer receives container events from this container.

removeNotify()
Makes this Container undisplayable by removing its connection to its native screen resource.

setComponentZOrder(Component comp, int index)

Moves the specified component to the specified z-order index in the container.

void void

setFocusCycleRoot(boolean focusCycleRoot)
Sets whether this Container is the root of a focus traversal cycle.

setFocusTraversalKeys(int id, Set<? extends AWTKeyStroke> keystrokes)

Sets the focus traversal keys for a given traversal operation for this Container.

void

setFocusTraversalPolicy(FocusTraversalPolicy policy)
Sets the focus traversal policy that will manage keyboard traversal of this Container's children, if this Container is a focus cycle root.

void

setFocusTraversalPolicyProvider(boolean prov ider)

Sets whether this container will be used to provide focus traversal policy.

void void void void void protected void

setFont(Font f)
Sets the font of this container.

setLayout(LayoutManager mgr)
Sets the layout manager for this container.

transferFocusDownCycle()
Transfers the focus down one focus traversal cycle.

update(Graphics g)
Updates the container.

validate()
Validates this container and all of its subcomponents.

validateTree()

Recursively descends the container tree and recomputes the layout for any subtrees marked as needing it (those marked as invalid).

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize,

setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail
Container public Container()
Constructs a new Container. Containers can be extended directly, but are lightweight in this case and must be contained by a parent somewhere higher up in the component tree that is native. (such as Frame for example).

Method Detail
getComponentCount public int getComponentCount()
Gets the number of components in this panel. Note: This method should be called under AWT tree lock.

Returns:
the number of components in this panel.

Since:
JDK1.1

See Also:

getComponent(int), Component.getTreeLock()

countComponents @Deprecated public int countComponents()

Deprecated. As of JDK version 1.1, replaced by getComponentCount().

getComponent public Component getComponent(int n)

Gets the nth component in this container. Note: This method should be called under AWT tree lock.

Parameters:

n - the index of the component to get.

Returns:
the n component in this container.
th

Throws:

ArrayIndexOutOfBoundsException - if the n value does not exist.

th

See Also:

Component.getTreeLock()

getComponents public Component[] getComponents()

Gets all the components in this container. Note: This method should be called under AWT tree lock.

Returns:
an array of all the components in this container.

See Also:

Component.getTreeLock()

getInsets public Insets getInsets()

Determines the insets of this container, which indicate the size of the container's border. A Frame object, for example, has a top inset that corresponds to the height of the frame's title bar.

Returns:
the insets of this container.

Since:
JDK1.1

See Also:

Insets, LayoutManager

insets @Deprecated public Insets insets()

Deprecated. As of JDK version 1.1, replaced by

getInsets().

add public Component add(Component comp)

Appends the specified component to the end of this container. This is a convenience method for addImpl(java.awt.Component, java.lang.Object, int). This method changes layout-related information, and therefore, invalidates the component hierarchy. If the container has already been displayed, the hierarchy must be validated thereafter in order to display the added component.

Parameters: