|
Java™ Platform Standard Ed. 6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface RootPaneContainer
This interface is implemented by components that have a single
JRootPane child: JDialog, JFrame, JWindow, JApplet, JInternalFrame.
The methods in this interface are just covers for the JRootPane
properties, e.g. getContentPane() is generally implemented
like this:
public Container getContentPane() {
return getRootPane().getContentPane();
}
This interface serves as a marker for Swing GUI builders
that need to treat components like JFrame, that contain a
single JRootPane, specially. For example in a GUI builder,
dropping a component on a RootPaneContainer would be interpreted
as frame.getContentPane().add(child).
For conveniance
JFrame, JDialog, JWindow,
JApplet and JInternalFrame, by default,
forward, by default, all calls to the add,
remove and setLayout methods, to the
contentPane. This means you can call:
rootPaneContainer.add(component);instead of:
rootPaneContainer.getContentPane().add(component);
The behavior of the add and
setLayout methods for
JFrame, JDialog, JWindow,
JApplet and JInternalFrame is controlled by
the rootPaneCheckingEnabled property. If this property is
true (the default), then calls to these methods are
forwarded to the contentPane; if false, these
methods operate directly on the RootPaneContainer. This
property is only intended for subclasses, and is therefore protected.
JRootPane,
JFrame,
JDialog,
JWindow,
JApplet,
JInternalFrame| Method Summary | |
|---|---|
Container |
getContentPane()
Returns the contentPane. |
Component |
getGlassPane()
Returns the glassPane. |
JLayeredPane |
getLayeredPane()
Returns the layeredPane. |
JRootPane |
getRootPane()
Return this component's single JRootPane child. |
void |
setContentPane(Container contentPane)
The "contentPane" is the primary container for application specific components. |
void |
setGlassPane(Component glassPane)
The glassPane is always the first child of the rootPane and the rootPanes layout manager ensures that it's always as big as the rootPane. |
void |
setLayeredPane(JLayeredPane layeredPane)
A Container that manages the contentPane and in some cases a menu bar. |
| Method Detail |
|---|
JRootPane getRootPane()
JRootPanevoid setContentPane(Container contentPane)
The contentPane may not be null.
Generally implemented with
getRootPane().setContentPane(contentPane);
contentPane - the Container to use for the contents of this
JRootPane
IllegalComponentStateException - (a runtime
exception) if the content pane parameter is nullJRootPane.getContentPane(),
getContentPane()Container getContentPane()
setContentPane(java.awt.Container)void setLayeredPane(JLayeredPane layeredPane)
The layeredPane may not be null.
Generally implemented with
getRootPane().setLayeredPane(layeredPane);
IllegalComponentStateException - (a runtime
exception) if the layered pane parameter is nullgetLayeredPane(),
JRootPane.getLayeredPane()JLayeredPane getLayeredPane()
setLayeredPane(javax.swing.JLayeredPane)void setGlassPane(Component glassPane)
The glassPane may not be null.
Generally implemented with
getRootPane().setGlassPane(glassPane);
getGlassPane(),
JRootPane.setGlassPane(java.awt.Component)Component getGlassPane()
setGlassPane(java.awt.Component)
|
Java™ Platform Standard Ed. 6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.