Interface RootPaneContainer
- All Known Implementing Classes:
-
JApplet
,JDialog
,JFrame
,JInternalFrame
,JWindow
public interface RootPaneContainer
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)
. As a convenience, the standard classes that implement this interface (such as JFrame
, JDialog
, JWindow
, JApplet
, and JInternalFrame
) have their add
, remove
, and setLayout
methods overridden, so that they delegate calls to the corresponding methods of the ContentPane
. For example, you can add a child component to a frame as follows:
frame.add(child);instead of:
frame.getContentPane().add(child);
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.
Method Summary
Modifier and Type | Method | Description |
---|---|---|
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 |
The "contentPane" is the primary container for application specific components. |
void |
setGlassPane |
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 |
A Container that manages the contentPane and in some cases a menu bar. |
Method Details
getRootPane
JRootPane getRootPane()
- Returns:
- this components single JRootPane child.
- See Also:
setContentPane
void setContentPane(Container contentPane)
The contentPane may not be null.
Generally implemented with getRootPane().setContentPane(contentPane);
- Parameters:
-
contentPane
- the Container to use for the contents of this JRootPane - Throws:
-
IllegalComponentStateException
- (a runtime exception) if the content pane parameter is null - See Also:
getContentPane
Container getContentPane()
- Returns:
- the value of the contentPane property.
- See Also:
setLayeredPane
void setLayeredPane(JLayeredPane layeredPane)
The layeredPane may not be null.
Generally implemented with
getRootPane().setLayeredPane(layeredPane);
- Parameters:
-
layeredPane
- the layered pane - Throws:
-
IllegalComponentStateException
- (a runtime exception) if the layered pane parameter is null - See Also:
getLayeredPane
JLayeredPane getLayeredPane()
- Returns:
- the value of the layeredPane property.
- See Also:
setGlassPane
void setGlassPane(Component glassPane)
The glassPane may not be null.
Generally implemented with getRootPane().setGlassPane(glassPane);
- Parameters:
-
glassPane
- the glass pane - See Also:
getGlassPane
Component getGlassPane()
- Returns:
- the value of the glassPane property.
- See Also:
© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/javax/swing/RootPaneContainer.html