FileDocCategorySizeDatePackage
RootPaneContainer.javaAPI DocJava SE 6 API5261Tue Jun 10 00:26:40 BST 2008javax.swing

RootPaneContainer

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.

see
JRootPane
see
JFrame
see
JDialog
see
JWindow
see
JApplet
see
JInternalFrame
version
1.17 03/22/06
author
Hans Muller

Fields Summary
Constructors Summary
Methods Summary
public java.awt.ContainergetContentPane()
Returns the contentPane.

return
the value of the contentPane property.
see
#setContentPane

public java.awt.ComponentgetGlassPane()
Returns the glassPane.

return
the value of the glassPane property.
see
#setGlassPane

public javax.swing.JLayeredPanegetLayeredPane()
Returns the layeredPane.

return
the value of the layeredPane property.
see
#setLayeredPane

public javax.swing.JRootPanegetRootPane()
Return this component's single JRootPane child. A conventional implementation of this interface will have all of the other methods indirect through this one. The rootPane has two children: the glassPane and the layeredPane.

return
this components single JRootPane child.
see
JRootPane

public voidsetContentPane(java.awt.Container contentPane)
The "contentPane" is the primary container for application specific components. Applications should add children to the contentPane, set its layout manager, and so on.

The contentPane may not be null.

Generally implemented with getRootPane().setContentPane(contentPane);

exception
java.awt.IllegalComponentStateException (a runtime exception) if the content pane parameter is null
param
contentPane the Container to use for the contents of this JRootPane
see
JRootPane#getContentPane
see
#getContentPane

public voidsetGlassPane(java.awt.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. By default it's transparent and not visible. It can be used to temporarily grab all keyboard and mouse input by adding listeners and then making it visible. by default it's not visible.

The glassPane may not be null.

Generally implemented with getRootPane().setGlassPane(glassPane);

see
#getGlassPane
see
JRootPane#setGlassPane

public voidsetLayeredPane(javax.swing.JLayeredPane layeredPane)
A Container that manages the contentPane and in some cases a menu bar. The layeredPane can be used by descendants that want to add a child to the RootPaneContainer that isn't layout managed. For example an internal dialog or a drag and drop effect component.

The layeredPane may not be null.

Generally implemented with

getRootPane().setLayeredPane(layeredPane);

exception
java.awt.IllegalComponentStateException (a runtime exception) if the layered pane parameter is null
see
#getLayeredPane
see
JRootPane#getLayeredPane