|
JavaTM 2 Platform Standard Edition |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.awt.Component | +--java.awt.Container
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).
add(java.awt.Component, int)
,
getComponent(int)
,
LayoutManager
, Serialized FormFields inherited from class java.awt.Component |
BOTTOM_ALIGNMENT,
CENTER_ALIGNMENT,
LEFT_ALIGNMENT,
RIGHT_ALIGNMENT,
TOP_ALIGNMENT |
Constructor Summary | |
Container()
Constructs a new Container. |
Method Summary | |
Component |
add(Component comp)
Adds the specified component to the end of this container. |
Component |
add(Component comp,
int index)
Adds the specified component to this container at the given position. |
void |
add(Component comp,
Object constraints)
Adds the specified component to the end of this container. |
void |
add(Component comp,
Object constraints,
int index)
Adds the specified component to this container with the specified constraints at the specified index. |
Component |
add(String name,
Component comp)
Adds the specified component to this container. |
void |
addContainerListener(ContainerListener l)
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()
Makes this Container displayable by connecting it to a native screen resource. |
int |
countComponents()
Deprecated. As of JDK version 1.1, replaced by getComponentCount(). |
void |
deliverEvent(Event e)
Deprecated. As of JDK version 1.1, replaced by dispatchEvent(AWTEvent e) |
void |
doLayout()
Causes this container to lay out its components. |
Component |
findComponentAt(int x,
int y)
Locates the visible child component that contains the specified position. |
Component |
findComponentAt(Point p)
Locates the visible child component that contains the specified point. |
float |
getAlignmentX()
Returns the alignment along the x axis. |
float |
getAlignmentY()
Returns the alignment along the y axis. |
Component |
getComponent(int n)
Gets the nth component in this container. |
Component |
getComponentAt(int x,
int y)
Locates the component that contains the x,y position. |
Component |
getComponentAt(Point p)
Gets the component that contains the specified point. |
int |
getComponentCount()
Gets the number of components in this panel. |
Component[] |
getComponents()
Gets all the components in this container. |
Insets |
getInsets()
Determines the insets of this container, which indicate the size of the container's border. |
LayoutManager |
getLayout()
Gets the layout manager for this container. |
Dimension |
getMaximumSize()
Returns the maximum size of this container. |
Dimension |
getMinimumSize()
Returns the minimum size of this container. |
Dimension |
getPreferredSize()
Returns the preferred size of this container. |
Insets |
insets()
Deprecated. As of JDK version 1.1, replaced by getInsets() . |
void |
invalidate()
Invalidates the container. |
boolean |
isAncestorOf(Component c)
Checks if the component is contained in the component hierarchy of this container. |
void |
layout()
Deprecated. As of JDK version 1.1, replaced by doLayout() . |
void |
list(PrintStream out,
int indent)
Prints a listing of this container to the specified output stream. |
void |
list(PrintWriter out,
int indent)
Prints out a list, starting at the specified indention, to the specified print writer. |
Component |
locate(int x,
int y)
Deprecated. As of JDK version 1.1, replaced by getComponentAt(int, int) . |
Dimension |
minimumSize()
Deprecated. As of JDK version 1.1, replaced by getMinimumSize() . |
void |
paint(Graphics g)
Paints the container. |
void |
paintComponents(Graphics g)
Paints each of the components in this container. |
protected String |
paramString()
Returns the parameter string representing the state of this container. |
Dimension |
preferredSize()
Deprecated. As of JDK version 1.1, replaced by getPreferredSize() . |
void |
print(Graphics g)
Prints the container. |
void |
printComponents(Graphics g)
Prints each of the components in this container. |
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. |
void |
remove(Component comp)
Removes the specified component from this container. |
void |
remove(int index)
Removes the component, specified by index ,
from this container. |
void |
removeAll()
Removes all the components from this container. |
void |
removeContainerListener(ContainerListener l)
Removes the specified container listener so it no longer receives container events from this container. |
void |
removeNotify()
Makes this Container undisplayable by removing its connection to its native screen resource. |
void |
setCursor(Cursor cursor)
Sets the cursor image to the specified cursor. |
void |
setFont(Font f)
Sets the font of this container. |
void |
setLayout(LayoutManager mgr)
Sets the layout manager for this container. |
void |
update(Graphics g)
Updates the container. |
void |
validate()
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). |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Constructor Detail |
public Container()
Method Detail |
public int getComponentCount()
getComponent(int)
public int countComponents()
public Component getComponent(int n)
n
- the index of the component to get.public Component[] getComponents()
public Insets getInsets()
A Frame
object, for example, has a top inset that
corresponds to the height of the frame's title bar.
Insets
,
LayoutManager
public Insets insets()
getInsets()
.
public Component add(Component comp)
comp
- the component to be added.public Component add(String name, Component comp)
public Component add(Component comp, int index)
comp
- the component to be added.index
- the position at which to insert the component,
or -1
to insert the component at the end.comp
remove(int)
public void add(Component comp, Object constraints)
comp
- the component to be addedconstraints
- an object expressing
layout contraints for this componentLayoutManager
public void add(Component comp, Object constraints, int index)
comp
- the component to be addedconstraints
- an object expressing layout contraints for thisindex
- the position in the container's list at which to insert
the component. -1 means insert at the end.
componentremove(int)
,
LayoutManager
protected void addImpl(Component comp, Object constraints, int index)
This is the method to override if a program needs to track every add request to a container. An overriding method should usually include a call to the superclass's version of the method:
super.addImpl(comp, constraints, index)
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, where -1
means insert at the end.add(java.awt.Component)
,
add(java.awt.Component, int)
,
add(java.awt.Component, java.lang.Object)
,
LayoutManager
public void remove(int index)
index
,
from this container.index
- the index of the component to be removed.add(java.awt.Component)
public void remove(Component comp)
comp
- the component to be removedadd(java.awt.Component)
public void removeAll()
add(java.awt.Component)
,
remove(int)
public LayoutManager getLayout()
doLayout()
,
setLayout(java.awt.LayoutManager)
public void setLayout(LayoutManager mgr)
mgr
- the specified layout managerdoLayout()
,
getLayout()
public void doLayout()
validate
method instead.LayoutManager.layoutContainer(java.awt.Container)
,
setLayout(java.awt.LayoutManager)
,
validate()
public void layout()
public void invalidate()
validate()
,
layout()
,
LayoutManager
public void validate()
AWT uses validate
to cause a container to lay out
its subcomponents again after the components it contains
have been added to or modified.
validate()
,
Component.invalidate()
protected void validateTree()
validate
.public void setFont(Font f)
f
- The font to become this container's font.Component.getFont()
public Dimension getPreferredSize()
Dimension
that represents
the preferred size of this container.getMinimumSize()
,
getLayout()
,
LayoutManager.preferredLayoutSize(java.awt.Container)
,
Component.getPreferredSize()
public Dimension preferredSize()
getPreferredSize()
.
public Dimension getMinimumSize()
Dimension
that represents
the minimum size of this container.getPreferredSize()
,
getLayout()
,
LayoutManager.minimumLayoutSize(java.awt.Container)
,
Component.getMinimumSize()
public Dimension minimumSize()
getMinimumSize()
.
public Dimension getMaximumSize()
getPreferredSize()
public float getAlignmentX()
public float getAlignmentY()
public void paint(Graphics g)
g
- the specified Graphics windowComponent.update(java.awt.Graphics)
public void update(Graphics g)
g
- the specified Graphics windowComponent.update(java.awt.Graphics)
public void print(Graphics g)
g
- the specified Graphics windowComponent.update(java.awt.Graphics)
public void paintComponents(Graphics g)
g
- the graphics context.Component.paint(java.awt.Graphics)
,
Component.paintAll(java.awt.Graphics)
public void printComponents(Graphics g)
g
- the graphics context.Component.print(java.awt.Graphics)
,
Component.printAll(java.awt.Graphics)
public void addContainerListener(ContainerListener l)
l
- the container listenerpublic void removeContainerListener(ContainerListener l)
l
- the container listenerprotected void processEvent(AWTEvent e)
e
- the eventprotected void processContainerEvent(ContainerEvent e)
e
- the container eventComponent.enableEvents(long)
public void setCursor(Cursor cursor)
contains
method for
this component returns true for the current cursor location.
Setting the cursor of a Container
causes that cursor
to be displayed within all of the container's subcomponents,
except for those that have a non-null cursor.cursor
- One of the constants defined
by the Cursor
class.
If this parameter is null then this component will inherit
the cursor of its parent.Component.getCursor()
,
Component.contains(int, int)
,
Toolkit.createCustomCursor(java.awt.Image, java.awt.Point, java.lang.String)
,
Cursor
public void deliverEvent(Event e)
dispatchEvent(AWTEvent e)
public Component getComponentAt(int x, int y)
x
- the x coordinatey
- the y coordinateComponent.contains(int, int)
public Component locate(int x, int y)
getComponentAt(int, int)
.
public Component getComponentAt(Point p)
p
- the point.null
if the component does
not contain the point.Component.contains(int, int)
public Component findComponentAt(int x, int y)
The findComponentAt method is different from getComponentAt in that getComponentAt only searches the Container's immediate children; if the containing component is a Container, findComponentAt will search that child to find a nested component.
x
- the x coordinatey
- the y coordinateComponent.contains(int, int)
,
getComponentAt
public Component findComponentAt(Point p)
The findComponentAt method is different from getComponentAt in that getComponentAt only searches the Container's immediate children; if the containing component is a Container, findComponentAt will search that child to find a nested component.
p
- the point.Component.contains(int, int)
,
getComponentAt
public void addNotify()
Component.isDisplayable()
,
removeNotify()
public void removeNotify()
Component.isDisplayable()
,
addNotify()
public boolean isAncestorOf(Component c)
c
- the componenttrue
if it is an ancestor;
false
otherwise.protected String paramString()
public void list(PrintStream out, int indent)
out
- a print stream.indent
- the number of spaces to indent.Component.list(java.io.PrintStream, int)
public void list(PrintWriter out, int indent)
out
- The print writer to print to.indent
- The number of spaces to indent.PrintStream.println(java.lang.Object)
|
JavaTM 2 Platform Standard Edition |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |