java.awt
Class Container

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
All Implemented Interfaces:
java.awt.image.ImageObserver, MenuContainer, Serializable
Direct Known Subclasses:
CellRendererPane, javax.swing.text.ComponentView.Invalidator, JComponent, Panel, ScrollPane, Window

public class Container
extends Component

Safe: 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).

Since:
JDK1.0
Version:
1.229, 04/02/02
Author:
Arthur van Hoff, Sami Shaio
See Also:
add(java.awt.Component, int), getComponent(int), LayoutManager, Serialized Form

Field Summary
(package private)  Component[] component
          The components in this container.
(package private)  ContainerListener containerListener
           
private  int containerSerializedDataVersion
          Container Serial Data Version.
private static sun.awt.DebugHelper dbg
           
(package private)  int descendantsCount
           
private  LightweightDispatcher dispatcher
          Event router for lightweight components.
private  boolean focusCycleRoot
          Indicates whether this Component is the root of a focus traversal cycle.
private  FocusTraversalPolicy focusTraversalPolicy
          The focus traversal policy that will manage keyboard traversal of this Container's children, if this Container is a focus cycle root.
(package private) static boolean INCLUDE_SELF
          A constant which toggles one of the controllable behaviors of getMouseEventTarget.
(package private)  LayoutManager layoutMgr
          Layout manager for this container.
(package private)  int listeningBoundsChildren
           
(package private)  int listeningChildren
           
private  Dimension maxSize
           
(package private)  int ncomponents
          The number of components in this container.
private  boolean printing
           
private  Set printingThreads
           
(package private) static boolean SEARCH_HEAVYWEIGHTS
          A constant which toggles one of the controllable behaviors of getMouseEventTarget.
private static long serialVersionUID
          JDK 1.1 serialVersionUID
 
Fields inherited from class java.awt.Component
accessibleContext, actionListenerK, adjustmentListenerK, appContext, background, BOTTOM_ALIGNMENT, bufferStrategy, CENTER_ALIGNMENT, componentListener, componentListenerK, componentOrientation, containerListenerK, cursor, dropTarget, enabled, eventMask, focusListener, focusListenerK, focusTraversalKeys, font, foreground, graphicsConfig, height, hierarchyBoundsListener, hierarchyBoundsListenerK, hierarchyListener, hierarchyListenerK, ignoreRepaint, incRate, inputMethodListener, inputMethodListenerK, isInc, isPacked, itemListenerK, keyListener, keyListenerK, LEFT_ALIGNMENT, locale, LOCK, metrics, minSize, mouseListener, mouseListenerK, mouseMotionListener, mouseMotionListenerK, mouseWheelListener, mouseWheelListenerK, newEventsOnly, ownedWindowK, parent, peer, peerFont, popups, prefSize, RIGHT_ALIGNMENT, textListenerK, TOP_ALIGNMENT, valid, visible, width, windowClosingException, windowFocusListenerK, windowListenerK, windowStateListenerK, x, y
 
Constructor Summary
Container()
          Suppressed: Constructs a new Container.
 
Method Summary
 Component add(Component comp)
          Enabled: Appends the specified component to the end of this container.
 Component add(Component comp, int index)
          Enabled: Adds the specified component to this container at the given position.
 void add(Component comp, Object constraints)
          Enabled: Adds the specified component to the end of this container.
 void add(Component comp, Object constraints, int index)
          Enabled: Adds the specified component to this container with the specified constraints at the specified index.
 Component add(String name, Component comp)
          Suppressed: Adds the specified component to this container.
 void addContainerListener(ContainerListener l)
          Enabled: Adds the specified container listener to receive container events from this container.
protected  void addImpl(Component comp, Object constraints, int index)
          Adds the specified component to this container at the specified index.
 void addNotify()
          Suppressed: Makes this Container displayable by connecting it to a native screen resource.
 void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
          Suppressed: Adds a PropertyChangeListener to the listener list.
 void addPropertyChangeListener(String propertyName, java.beans.PropertyChangeListener listener)
          Suppressed: Adds a PropertyChangeListener to the listener list for a specific property.
(package private)  void adjustDecendantsOnParent(int num)
           
(package private)  void adjustDescendants(int num)
           
(package private)  void adjustListeningChildren(long mask, int num)
           
 void applyComponentOrientation(ComponentOrientation o)
          Suppressed: Sets the ComponentOrientation property of this container and all components contained within it.
 boolean areFocusTraversalKeysSet(int id)
          Suppressed: Returns whether the Set of focus traversal keys for the given focus traversal operation has been explicitly defined for this Container.
(package private)  void checkGD(String stringID)
          Checks that all Components that this Container contains are on the same GraphicsDevice as this Container.
(package private)  void clearCurrentFocusCycleRootOnHide()
           
(package private)  void clearMostRecentFocusOwnerOnHide()
           
(package private)  boolean containsFocus()
           
 int countComponents()
          Deprecated. As of JDK version 1.1, replaced by getComponentCount().
(package private)  int countHierarchyMembers()
           
(package private)  void createChildHierarchyEvents(int id, long changeFlags, boolean enabledOnToolkit)
           
(package private)  int createHierarchyEvents(int id, Component changed, Container changedParent, long changeFlags, boolean enabledOnToolkit)
           
 void deliverEvent(Event e)
          Suppressed: @deprecated As of JDK version 1.1, replaced by dispatchEvent(AWTEvent e)
(package private)  void dispatchEventImpl(AWTEvent e)
           
(package private)  void dispatchEventToSelf(AWTEvent e)
           
 void doLayout()
          Suppressed: Causes this container to lay out its components.
(package private)  boolean eventEnabled(AWTEvent e)
           
 Component findComponentAt(int x, int y)
          Enabled: Locates the visible child component that contains the specified position.
(package private)  Component findComponentAt(int x, int y, boolean ignoreEnabled)
          Private version of findComponentAt which has a controllable behavior.
 Component findComponentAt(Point p)
          Suppressed: Locates the visible child component that contains the specified point.
private  Container findTraversalRoot()
           
 Component get(int n)
          Added: So container[n] will work in E.
(package private)  Accessible getAccessibleAt(Point p)
          Returns the Accessible child contained at the local coordinate Point, if one exists.
(package private)  Accessible getAccessibleChild(int i)
          Returns the nth Accessible child of the object.
(package private)  int getAccessibleChildrenCount()
          Returns the number of accessible children in the object.
 float getAlignmentX()
          Enabled: Returns the alignment along the x axis.
 float getAlignmentY()
          Enabled: Returns the alignment along the y axis.
 Component getComponent(int n)
          Enabled: Gets the nth component in this container.
 Component getComponentAt(int x, int y)
          Enabled: Locates the component that contains the x,y position.
 Component getComponentAt(Point p)
          Suppressed: Gets the component that contains the specified point.
 int getComponentCount()
          Enabled: Gets the number of components in this panel.
(package private)  Component[] getComponents_NoClientCode()
           
 Component[] getComponents()
          Enabled: Gets all the components in this container.
 ContainerListener[] getContainerListeners()
          Suppressed: Returns an array of all the container listeners registered on this container.
(package private)  Component getDropTargetEventTarget(int x, int y, boolean includeSelf)
          Fetches the top-most (deepest) component to receive SunDropTargetEvents.
 Set getFocusTraversalKeys(int id)
          Suppressed: Returns the Set of focus traversal keys for a given traversal operation for this Container.
 FocusTraversalPolicy getFocusTraversalPolicy()
          Suppressed: 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.
 Insets getInsets()
          Enabled: Determines the insets of this container, which indicate the size of the container's border.
 LayoutManager getLayout()
          Enabled: Gets the layout manager for this container.
 EventListener[] getListeners(Class listenerType)
          Suppressed: Returns an array of all the objects currently registered as FooListeners upon this Container.
 Dimension getMaximumSize()
          Enabled: Returns the maximum size of this container.
 Dimension getMinimumSize()
          Enabled: Returns the minimum size of this container.
(package private)  Component getMouseEventTarget(int x, int y, boolean includeSelf)
          Fetchs the top-most (deepest) lightweight component that is interested in receiving mouse events.
private  Component getMouseEventTarget(int x, int y, boolean includeSelf, java.awt.Container.EventTargetFilter filter, boolean searchHeavyweights)
          A private version of getMouseEventTarget which has two additional controllable behaviors.
private  Component getMouseEventTargetImpl(int x, int y, boolean includeSelf, java.awt.Container.EventTargetFilter filter, boolean searchHeavyweightChildren, boolean searchHeavyweightDescendants)
          A private version of getMouseEventTarget which has three additional controllable behaviors.
 Dimension getPreferredSize()
          Enabled: Returns the preferred size of this container.
(package private)  void initializeFocusTraversalKeys()
           
private static void initIDs()
          Initialize JNI field and method IDs for fields that may be called from C.
 Insets insets()
          Suppressed: @deprecated As of JDK version 1.1, replaced by getInsets().
 void invalidate()
          Enabled: Invalidates the container.
(package private)  void invalidateTree()
          Recursively descends the container tree and invalidates all contained components.
 boolean isAncestorOf(Component c)
          Enabled: Checks if the component is contained in the component hierarchy of this container.
 boolean isFocusCycleRoot()
          Suppressed: Returns whether this Container is the root of a focus traversal cycle.
 boolean isFocusCycleRoot(Container container)
          Suppressed: Returns whether the specified Container is the focus cycle root of this Container's focus traversal cycle.
 boolean isFocusTraversalPolicySet()
          Suppressed: Returns whether the focus traversal policy has been explicitly set for this Container.
 void iterate(AssocFunc func)
          Added: A Container enumerates its components
 void layout()
          Deprecated. As of JDK version 1.1, replaced by doLayout().
(package private)  void lightweightPaint(Graphics g)
          Simulates the peer callbacks into java.awt for printing of lightweight Containers.
(package private)  void lightweightPrint(Graphics g)
          Simulates the peer callbacks into java.awt for printing of lightweight Containers.
 void list(PrintStream out, int indent)
          Suppressed: Prints a listing of this container to the specified output stream.
 void list(PrintWriter out, int indent)
          Suppressed: Prints out a list, starting at the specified indention, to the specified print writer.
 Component locate(int x, int y)
          Suppressed: @deprecated As of JDK version 1.1, replaced by getComponentAt(int, int).
 Dimension minimumSize()
          Deprecated. As of JDK version 1.1, replaced by getMinimumSize().
(package private)  boolean nextFocusHelper()
           
(package private)  int numListening(long mask)
           
 void paint(Graphics g)
          Suppressed: Paints the container.
 void paintComponents(Graphics g)
          Suppressed: Paints each of the components in this container.
(package private)  void paintHeavyweightComponents(Graphics g)
          Prints all the heavyweight subcomponents.
protected  String paramString()
          Returns a string representing the state of this Container.
(package private)  void postProcessKeyEvent(KeyEvent e)
           
(package private)  boolean postsOldMouseEvents()
           
 Dimension preferredSize()
          Deprecated. As of JDK version 1.1, replaced by getPreferredSize().
(package private)  void preProcessKeyEvent(KeyEvent e)
           
 void print(Graphics g)
          Suppressed: Prints the container.
 void printComponents(Graphics g)
          Suppressed: Prints each of the components in this container.
(package private)  void printHeavyweightComponents(Graphics g)
          Prints all the heavyweight subcomponents.
protected  void processContainerEvent(ContainerEvent e)
          Processes container events occurring on this container by dispatching them to any registered ContainerListener objects.
protected  void processEvent(AWTEvent e)
          Processes events on this container.
(package private)  void proxyEnableEvents(long events)
          This is called by lightweight components that want the containing windowed parent to enable some kind of events on their behalf.
private  void readObject(ObjectInputStream s)
          Deserializes this Container from the specified ObjectInputStream.
 void remove(Component comp)
          Enabled: Removes the specified component from this container.
 void remove(int index)
          Enabled: Removes the component, specified by index, from this container.
 void removeAll()
          Enabled: Removes all the components from this container.
 void removeContainerListener(ContainerListener l)
          Enabled: Removes the specified container listener so it no longer receives container events from this container.
 void removeNotify()
          Suppressed: Makes this Container undisplayable by removing its connection to its native screen resource.
 void setFocusCycleRoot(boolean focusCycleRoot)
          Suppressed: Sets whether this Container is the root of a focus traversal cycle.
 void setFocusTraversalKeys(int id, Set keystrokes)
          Suppressed: Sets the focus traversal keys for a given traversal operation for this Container.
 void setFocusTraversalPolicy(FocusTraversalPolicy policy)
          Suppressed: Sets the focus traversal policy that will manage keyboard traversal of this Container's children, if this Container is a focus cycle root.
 void setFont(Font f)
          Enabled: Sets the font of this container.
 void setLayout(LayoutManager mgr)
          Enabled: Sets the layout manager for this container.
(package private)  void setZOrder(Component comp, int index)
           
 int size()
          Added: An unfortunate ambiguity.
 void transferFocusBackward()
          Suppressed:
 void transferFocusDownCycle()
          Suppressed: Transfers the focus down one focus traversal cycle.
 void update(Graphics g)
          Enabled: Updates the container.
 void validate()
          Suppressed: Validates this container and all of its subcomponents.
protected  void validateTree()
          Recursively descends the container tree and recomputes the layout for any subtrees marked as needing it (those marked as invalid).
private  void writeObject(ObjectOutputStream s)
          Serializes this Container to the specified ObjectOutputStream.
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, adjustListeningChildrenOnParent, areInputMethodsEnabled, autoProcessMouseWheel, autoTransferFocus, bounds, checkImage, checkImage, checkWindowClosingException, coalesceEvents, constructComponentName, contains, contains, createBufferStrategy, createBufferStrategy, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, dispatchMouseWheelToAncestor, enable, enable, enableEvents, enableInputMethods, eventTypeEnabled, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getAccessibleIndexInParent, getAccessibleStateSet, getBackBuffer, getBackground, getBounds, getBounds, getBufferStrategy, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys_NoIDCheck, getFocusTraversalKeysEnabled, getFont_NoClientCode, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen_NoTreeLock, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getNativeContainer, getParent_NoClientCode, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getToolkitImpl, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isEnabledImpl, isFocusable, isFocusOwner, isFocusTraversable, isFocusTraversableOverridden, isFontSet, isForegroundSet, isLightweight, isOpaque, isRecursivelyVisible, 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, requestFocusHelper, requestFocusInWindow, requestFocusInWindow, resetGC, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys_NoIDCheck, setFocusTraversalKeysEnabled, setForeground, setGCFromPeer, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, toString, transferFocus, transferFocus, transferFocusUpCycle, updateCursorImmediately
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ncomponents

int ncomponents
The number of components in this container. This value can be null.

See Also:
getComponent(int), getComponents(), getComponentCount()

component

Component[] component
The components in this container.

See Also:
add(java.awt.Component), getComponents()

layoutMgr

LayoutManager layoutMgr
Layout manager for this container.

See Also:
doLayout(), setLayout(java.awt.LayoutManager), getLayout()

dispatcher

private LightweightDispatcher dispatcher
Event router for lightweight components. If this container is native, this dispatcher takes care of forwarding and retargeting the events to lightweight components contained (if any).


maxSize

private Dimension maxSize

focusTraversalPolicy

private transient FocusTraversalPolicy focusTraversalPolicy
The focus traversal policy that will manage keyboard traversal of this Container's children, if this Container is a focus cycle root. If the value is null, this Container inherits its policy from its focus-cycle- root ancestor. If all such ancestors of this Container have null policies, then the current KeyboardFocusManager's default policy is used. If the value is non-null, this policy will be inherited by all focus-cycle-root children that have no keyboard-traversal policy of their own (as will, recursively, their focus-cycle-root children).

If this Container is not a focus cycle root, the value will be remembered, but will not be used or inherited by this or any other Containers until this Container is made a focus cycle root.

Since:
1.4
See Also:
setFocusTraversalPolicy(java.awt.FocusTraversalPolicy), getFocusTraversalPolicy()

focusCycleRoot

private boolean focusCycleRoot
Indicates whether this Component is the root of a focus traversal cycle. Once focus enters a traversal cycle, typically it cannot leave it via focus traversal unless one of the up- or down-cycle keys is pressed. Normal traversal is limited to this Container, and all of this Container's descendants that are not descendants of inferior focus cycle roots.

Since:
1.4
See Also:
setFocusCycleRoot(boolean), isFocusCycleRoot(java.awt.Container)

printingThreads

private transient Set printingThreads

printing

private transient boolean printing

containerListener

transient ContainerListener containerListener

listeningChildren

transient int listeningChildren

listeningBoundsChildren

transient int listeningBoundsChildren

descendantsCount

transient int descendantsCount

serialVersionUID

private static final long serialVersionUID
JDK 1.1 serialVersionUID


dbg

private static final sun.awt.DebugHelper dbg

INCLUDE_SELF

static final boolean INCLUDE_SELF
A constant which toggles one of the controllable behaviors of getMouseEventTarget. It is used to specify whether the method can return the Container on which it is originally called in case if none of its children are the current mouse event targets.

See Also:
#getMouseEventTarget(int, int, boolean, boolean, boolean)

SEARCH_HEAVYWEIGHTS

static final boolean SEARCH_HEAVYWEIGHTS
A constant which toggles one of the controllable behaviors of getMouseEventTarget. It is used to specify whether the method should search only lightweight components.

See Also:
#getMouseEventTarget(int, int, boolean, boolean, boolean)

containerSerializedDataVersion

private int containerSerializedDataVersion
Container Serial Data Version.

Constructor Detail

Container

public Container()
Suppressed: 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

initIDs

private static void initIDs()
Initialize JNI field and method IDs for fields that may be called from C.


initializeFocusTraversalKeys

void initializeFocusTraversalKeys()
Overrides:
initializeFocusTraversalKeys in class Component

getComponentCount

public int getComponentCount()
Enabled: Gets the number of components in this panel.

Returns:
the number of components in this panel.
Since:
JDK1.1
See Also:
getComponent(int)

countComponents

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

Suppressed:


getComponent

public Component getComponent(int n)
Enabled: Gets the nth component in this container.

Parameters:
n - the index of the component to get.
Returns:
the nth component in this container.

getComponents

public Component[] getComponents()
Enabled: Gets all the components in this container.

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

getComponents_NoClientCode

final Component[] getComponents_NoClientCode()

getInsets

public Insets getInsets()
Enabled: 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

public Insets insets()
Suppressed: @deprecated As of JDK version 1.1, replaced by getInsets().


add

public Component add(Component comp)
Enabled: Appends the specified component to the end of this container. This is a convenience method for addImpl(java.awt.Component, java.lang.Object, int).

Note: If a component has been added to a container that has been displayed, validate must be called on that container to display the new component. If multiple components are being added, you can improve efficiency by calling validate only once, after all the components have been added.

Parameters:
comp - the component to be added
Returns:
the component argument
See Also:
addImpl(java.awt.Component, java.lang.Object, int), validate(), #revalidate

add

public Component add(String name,
                     Component comp)
Suppressed: Adds the specified component to this container. This is a convenience method for addImpl(java.awt.Component, java.lang.Object, int).

This method is obsolete as of 1.1. Please use the method add(Component, Object) instead.

See Also:
add(Component, Object)

add

public Component add(Component comp,
                     int index)
Enabled: Adds the specified component to this container at the given position. This is a convenience method for addImpl(java.awt.Component, java.lang.Object, int).

Note: If a component has been added to a container that has been displayed, validate must be called on that container to display the new component. If multiple components are being added, you can improve efficiency by calling validate only once, after all the components have been added.

Parameters:
comp - the component to be added
index - the position at which to insert the component, or -1 to append the component to the end
Returns:
the component comp
See Also:
addImpl(java.awt.Component, java.lang.Object, int), remove(int), validate(), #revalidate

setZOrder

void setZOrder(Component comp,
               int index)

add

public void add(Component comp,
                Object constraints)
Enabled: Adds the specified component to the end of this container. Also notifies the layout manager to add the component to this container's layout using the specified constraints object. This is a convenience method for addImpl(java.awt.Component, java.lang.Object, int).

Note: If a component has been added to a container that has been displayed, validate must be called on that container to display the new component. If multiple components are being added, you can improve efficiency by calling validate only once, after all the components have been added.

Parameters:
comp - the component to be added
constraints - an object expressing layout contraints for this component
Since:
JDK1.1
See Also:
addImpl(java.awt.Component, java.lang.Object, int), validate(), #revalidate, LayoutManager

add

public void add(Component comp,
                Object constraints,
                int index)
Enabled: Adds the specified component to this container with the specified constraints at the specified index. Also notifies the layout manager to add the component to the this container's layout using the specified constraints object. This is a convenience method for addImpl(java.awt.Component, java.lang.Object, int).

Note: If a component has been added to a container that has been displayed, validate must be called on that container to display the new component. If multiple components are being added, you can improve efficiency by calling validate only once, after all the components have been added.

Parameters:
comp - the component to be added
constraints - an object expressing layout contraints for this
index - the position in the container's list at which to insert the component; -1 means insert at the end component
See Also:
addImpl(java.awt.Component, java.lang.Object, int), validate(), #revalidate, remove(int), LayoutManager

addImpl

protected void addImpl(Component comp,
                       Object constraints,
                       int index)
Adds the specified component to this container at the specified index. This method also notifies the layout manager to add the component to this container's layout using the specified constraints object via the addLayoutComponent method. The constraints are defined by the particular layout manager being used. For example, the BorderLayout class defines five constraints: BorderLayout.NORTH, BorderLayout.SOUTH, BorderLayout.EAST, BorderLayout.WEST, and BorderLayout.CENTER.

Note that if the component already exists in this container or a child of this container, it is removed from that container before being added to this container.

This is the method to override if a program needs to track every add request to a container as all other add methods defer to this one. An overriding method should usually include a call to the superclass's version of the method:

super.addImpl(comp, constraints, index)

Parameters:
comp - the component to be added
constraints - an object expressing layout constraints for this component
index - the position in the container's list at which to insert the component, where -1 means append to the end
Since:
JDK1.1
See Also:
add(Component), add(Component, int), add(Component, java.lang.Object), LayoutManager, LayoutManager2

checkGD

void checkGD(String stringID)
Checks that all Components that this Container contains are on the same GraphicsDevice as this Container. If not, throws an IllegalArgumentException.

Overrides:
checkGD in class Component

remove

public void remove(int index)
Enabled: Removes the component, specified by index, from this container.

Parameters:
index - the index of the component to be removed.
Since:
JDK1.1
See Also:
add(java.awt.Component)

remove

public void remove(Component comp)
Enabled: Removes the specified component from this container.

Parameters:
comp - the component to be removed
See Also:
add(java.awt.Component)

removeAll

public void removeAll()
Enabled: Removes all the components from this container.

See Also:
add(java.awt.Component), remove(int)

numListening

int numListening(long mask)
Overrides:
numListening in class Component

adjustListeningChildren

void adjustListeningChildren(long mask,
                             int num)

adjustDescendants

void adjustDescendants(int num)

adjustDecendantsOnParent

void adjustDecendantsOnParent(int num)

countHierarchyMembers

int countHierarchyMembers()
Overrides:
countHierarchyMembers in class Component

createHierarchyEvents

int createHierarchyEvents(int id,
                          Component changed,
                          Container changedParent,
                          long changeFlags,
                          boolean enabledOnToolkit)
Overrides:
createHierarchyEvents in class Component

createChildHierarchyEvents

void createChildHierarchyEvents(int id,
                                long changeFlags,
                                boolean enabledOnToolkit)
Overrides:
createChildHierarchyEvents in class Component

getLayout

public LayoutManager getLayout()
Enabled: Gets the layout manager for this container.

See Also:
doLayout(), setLayout(java.awt.LayoutManager)

setLayout

public void setLayout(LayoutManager mgr)
Enabled: Sets the layout manager for this container.

Parameters:
mgr - the specified layout manager
See Also:
doLayout(), getLayout()

doLayout

public void doLayout()
Suppressed: Causes this container to lay out its components. Most programs should not call this method directly, but should invoke the validate method instead.

Overrides:
doLayout in class Component
Since:
JDK1.1
See Also:
LayoutManager.layoutContainer(java.awt.Container), setLayout(java.awt.LayoutManager), validate()

layout

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

Suppressed:

Overrides:
layout in class Component

invalidate

public void invalidate()
Enabled: Invalidates the container. The container and all parents above it are marked as needing to be laid out. This method can be called often, so it needs to execute quickly.

Overrides:
invalidate in class Component
See Also:
validate(), layout(), LayoutManager

validate

public void validate()
Suppressed: Validates this container and all of its subcomponents.

The validate method is used to cause a container to lay out its subcomponents again. It should be invoked when this container's subcomponents are modified (added to or removed from the container, or layout-related information changed) after the container has been displayed.

Overrides:
validate in class Component
See Also:
add(java.awt.Component), Component.invalidate(), #revalidate

validateTree

protected void validateTree()
Recursively descends the container t