All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.awt.Container

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container

public class Container
extends Component
A generic Abstract Window Toolkit(AWT) container object is a component that can contain other AWT components.


Method Index

 o add(Component)
Adds the specified component to this container.
 o add(Component, int)
Adds the specified component to this container at the given position in the container's component list.
 o add(Component, Object)
Adds the specified component to this container at the specified index.
 o add(String, Component)
DEPRECATED: Replaced by add(Component, Object).
 o addImpl(Component, Object, int)
Adds the specified component to this container at the specified index.
 o addNotify()
Notifies the container to create a peer.
 o countComponents()
DEPRECATED: Replaced by getComponentCount().
 o deliverEvent(Event)
Delivers an event.
 o doLayout()
Does a layout on this Container.
 o getComponent(int)
Gets the nth component in this container.
 o getComponentAt(int, int)
Locates the component that contains the x,y position.
 o getComponentAt(Point)
Locates the component that contains the specified point.
 o getComponentCount()
Returns the number of components in this panel.
 o getComponents()
Gets all the components in this container.
 o getInsets()
Returns the insets of the container.
 o getLayout()
Gets the layout manager for this container.
 o getMinimumSize()
Returns the minimum size of this container.
 o getPreferredSize()
Returns the preferred size of this container.
 o insets()
DEPRECATED: Replaced by getInsets().
 o isAncestorOf(Component)
Checks if the component is contained in the component hierarchy of this container.
 o layout()
DEPRECATED: Replaced by doLayout().
 o list(PrintStream, int)
Prints out a list, starting at the specified indention, to the specified out stream.
 o locate(int, int)
DEPRECATED: Replaced by getComponentAt(int, int).
 o minimumSize()
DEPRECATED: Replaced by getMinimumSize().
 o paintComponents(Graphics)
Paints the components in this container.
 o paramString()
Returns the parameter String of this Container.
 o preferredSize()
DEPRECATED: Replaced by getPreferredSize().
 o printComponents(Graphics)
Prints the components in this container.
 o remove(Component)
Removes the specified component from this container.
 o remove(int)
Removes the component at the specified index from this container.
 o removeAll()
Removes all the components from this container.
 o removeNotify()
Notifies the container to remove its peer.
 o setLayout(LayoutManager)
Sets the layout manager for this container.
 o validate()
Validates this Container and all of the components contained within it.
 o validateTree()
Recursively descends the container tree and recomputes the layout for any subtrees marked as needing it (those marked as invalid).

Methods

 o getComponentCount
  public int getComponentCount()
Returns the number of components in this panel.

See Also:
getComponent
 o countComponents
  public int countComponents()
DEPRECATED: Replaced by getComponentCount().

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

Parameters:
n - the number of the component to get
Throws: ArrayIndexOutOfBoundsException
If the nth value does not exist.
 o getComponents
  public Component[] getComponents()
Gets all the components in this container.

 o getInsets
  public Insets getInsets()
Returns the insets of the container. The insets indicate the size of the border of the container. A Frame, for example, will have a top inset that corresponds to the height of the Frame's title bar.

See Also:
LayoutManager
 o insets
  public Insets insets()
DEPRECATED: Replaced by getInsets().

 o add
  public Component add(Component comp)
Adds the specified component to this container.

Parameters:
comp - the component to be added
 o add
  public Component add(String name,
                       Component comp)
DEPRECATED: Replaced by add(Component, Object).

 o add
  public Component add(Component comp,
                       int index)
Adds the specified component to this container at the given position in the container's component list.

Parameters:
comp - the component to be added
index - the position in the container's list at which to insert the component. -1 means insert at the end.
See Also:
remove
 o add
  public void add(Component comp,
                  Object constraints)
Adds the specified component to this container at the specified index. Also notifies the layout manager to add the component to the this container's layout using the specified constraints object.

Parameters:
comp - the component to be added
constraints - an object expressing layout contraints for this component
See Also:
remove, LayoutManager
 o addImpl
  protected void addImpl(Component comp,
                         Object constraints,
                         int index)
Adds the specified component to this container 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 the method to override if you want to track every add request to a container. An overriding method should usually include a call to super.addImpl(comp, constraints, index).

Parameters:
comp - the component to be added
constraints - an object expressing layout contraints for this component
index - the position in the container's list at which to insert the component. -1 means insert at the end.
See Also:
remove, LayoutManager
 o remove
  public void remove(int index)
Removes the component at the specified index from this container.

Parameters:
index - the index of the component to be removed
See Also:
add
 o remove
  public void remove(Component comp)
Removes the specified component from this container.

Parameters:
comp - the component to be removed
See Also:
add
 o removeAll
  public void removeAll()
Removes all the components from this container.

See Also:
add, remove
 o getLayout
  public LayoutManager getLayout()
Gets the layout manager for this container.

See Also:
doLayout, setLayout
 o setLayout
  public void setLayout(LayoutManager mgr)
Sets the layout manager for this container.

Parameters:
mgr - the specified layout manager
See Also:
doLayout, getLayout
 o doLayout
  public void doLayout()
Does a layout on this Container. Most programs should not call this directly, but should invoke validate instead.

Overrides:
doLayout in class Component
See Also:
setLayout, validate
 o layout
  public void layout()
DEPRECATED: Replaced by doLayout().

Overrides:
layout in class Component
 o validate
  public void validate()
Validates this Container and all of the components contained within it.

Overrides:
validate in class Component
See Also:
validate, invalidate
 o validateTree
  protected void validateTree()
Recursively descends the container tree and recomputes the layout for any subtrees marked as needing it (those marked as invalid). Synchronization should be provided by the method that calls this: validate.

 o getPreferredSize
  public Dimension getPreferredSize()
Returns the preferred size of this container.

Overrides:
getPreferredSize in class Component
See Also:
getMinimumSize
 o preferredSize
  public Dimension preferredSize()
DEPRECATED: Replaced by getPreferredSize().

Overrides:
preferredSize in class Component
 o getMinimumSize
  public Dimension getMinimumSize()
Returns the minimum size of this container.

Overrides:
getMinimumSize in class Component
See Also:
getPreferredSize
 o minimumSize
  public Dimension minimumSize()
DEPRECATED: Replaced by getMinimumSize().

Overrides:
minimumSize in class Component
 o paintComponents
  public void paintComponents(Graphics g)
Paints the components in this container.

Parameters:
g - the specified Graphics window
See Also:
paint, paintAll
 o printComponents
  public void printComponents(Graphics g)
Prints the components in this container.

Parameters:
g - the specified Graphics window
See Also:
print, printAll
 o deliverEvent
  public void deliverEvent(Event e)
Delivers an event. The appropriate component is located and the event is delivered to it.

Parameters:
e - the event
Overrides:
deliverEvent in class Component
See Also:
handleEvent, postEvent
 o getComponentAt
  public Component getComponentAt(int x,
                                  int y)
Locates the component that contains the x,y position.

Parameters:
x - the x coordinate
y - the y coordinate
Returns:
null if the component is not within the x and y coordinates; returns the component otherwise.
Overrides:
getComponentAt in class Component
See Also:
contains
 o locate
  public Component locate(int x,
                          int y)
DEPRECATED: Replaced by getComponentAt(int, int).

Overrides:
locate in class Component
 o getComponentAt
  public Component getComponentAt(Point p)
Locates the component that contains the specified point.

Parameters:
p - the point
Returns:
null if the component does not contain the point; returns the component otherwise.
Overrides:
getComponentAt in class Component
See Also:
contains
 o addNotify
  public void addNotify()
Notifies the container to create a peer. It will also notify the components contained in this container. This method should be called by Container.add, and not by user code directly.

Overrides:
addNotify in class Component
See Also:
removeNotify
 o removeNotify
  public void removeNotify()
Notifies the container to remove its peer. It will also notify the components contained in this container. This method should be called by Container.remove, and not by user code directly.

Overrides:
removeNotify in class Component
See Also:
addNotify
 o isAncestorOf
  public boolean isAncestorOf(Component c)
Checks if the component is contained in the component hierarchy of this container.

Parameters:
c - the component
 o paramString
  protected String paramString()
Returns the parameter String of this Container.

Overrides:
paramString in class Component
 o list
  public void list(PrintStream out,
                   int indent)
Prints out a list, starting at the specified indention, to the specified out stream.

Parameters:
out - the Stream name
indent - the start of the list
Overrides:
list in class Component

All Packages  Class Hierarchy  This Package  Previous  Next  Index