Where Am I? Class Hierarchy (JFC) All Classes (JFC)

Interface com.sun.java.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).

See Also:
JRootPane, JFrame, JDialog, JWindow, JApplet, JInternalFrame

Method Index

getContentPane()
getGlassPane()
getLayeredPane()
getRootPane()
Return this components single JRootPane child.
setContentPane(Container)
The "contentPane" is the primary container for application specific components.
setGlassPane(Component)
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.
setLayeredPane(JLayeredPane)
A Container that manages the contentPane and in some cases a menu bar.

Methods

getRootPane
 public abstract JRootPane getRootPane()
Return this components 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.

Returns:
this components single JRootPane child.
See Also:
JRootPane
setContentPane
 public abstract void setContentPane(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 my not be null.

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

See Also:
getContentPane, getContentPane
getContentPane
 public abstract Container getContentPane()
Returns:
the value of the contentPane property.
See Also:
setContentPane
setLayeredPane
 public abstract void setLayeredPane(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);

See Also:
getLayeredPane, getLayeredPane
getLayeredPane
 public abstract JLayeredPane getLayeredPane()
Returns:
the value of the layeredPane property.
See Also:
setLayeredPane
setGlassPane
 public abstract 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. 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 Also:
getGlassPane, setGlassPane
getGlassPane
 public abstract Component getGlassPane()
Returns:
the value of the glassPane property.
See Also:
setGlassPane

Where Am I? Class Hierarchy (JFC) All Classes (JFC)