javax.swing
Interface RootPaneContainer

All Known Implementing Classes:
JApplet sample code for javax.swing.JApplet definition code for javax.swing.JApplet , JDialog sample code for javax.swing.JDialog definition code for javax.swing.JDialog , JFrame sample code for javax.swing.JFrame definition code for javax.swing.JFrame , JInternalFrame sample code for javax.swing.JInternalFrame definition code for javax.swing.JInternalFrame , JWindow sample code for javax.swing.JWindow definition code for javax.swing.JWindow

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 Also:
JRootPane sample code for javax.swing.JRootPane definition code for javax.swing.JRootPane , JFrame sample code for javax.swing.JFrame definition code for javax.swing.JFrame , JDialog sample code for javax.swing.JDialog definition code for javax.swing.JDialog , JWindow sample code for javax.swing.JWindow definition code for javax.swing.JWindow , JApplet sample code for javax.swing.JApplet definition code for javax.swing.JApplet , JInternalFrame sample code for javax.swing.JInternalFrame definition code for javax.swing.JInternalFrame

Method Summary
 Container sample code for java.awt.Container definition code for java.awt.Container getContentPane sample code for javax.swing.RootPaneContainer.getContentPane() definition code for javax.swing.RootPaneContainer.getContentPane() ()
          Returns the contentPane.
 Component sample code for java.awt.Component definition code for java.awt.Component getGlassPane sample code for javax.swing.RootPaneContainer.getGlassPane() definition code for javax.swing.RootPaneContainer.getGlassPane() ()
          Returns the glassPane.
 JLayeredPane sample code for javax.swing.JLayeredPane definition code for javax.swing.JLayeredPane getLayeredPane sample code for javax.swing.RootPaneContainer.getLayeredPane() definition code for javax.swing.RootPaneContainer.getLayeredPane() ()
          Returns the layeredPane.
 JRootPane sample code for javax.swing.JRootPane definition code for javax.swing.JRootPane getRootPane sample code for javax.swing.RootPaneContainer.getRootPane() definition code for javax.swing.RootPaneContainer.getRootPane() ()
          Return this component's single JRootPane child.
 void setContentPane sample code for javax.swing.RootPaneContainer.setContentPane(java.awt.Container) definition code for javax.swing.RootPaneContainer.setContentPane(java.awt.Container) (Container sample code for java.awt.Container definition code for java.awt.Container  contentPane)
          The "contentPane" is the primary container for application specific components.
 void setGlassPane sample code for javax.swing.RootPaneContainer.setGlassPane(java.awt.Component) definition code for javax.swing.RootPaneContainer.setGlassPane(java.awt.Component) (Component sample code for java.awt.Component definition code for 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.
 void setLayeredPane sample code for javax.swing.RootPaneContainer.setLayeredPane(javax.swing.JLayeredPane) definition code for javax.swing.RootPaneContainer.setLayeredPane(javax.swing.JLayeredPane) (JLayeredPane sample code for javax.swing.JLayeredPane definition code for javax.swing.JLayeredPane  layeredPane)
          A Container that manages the contentPane and in some cases a menu bar.
 

Method Detail

getRootPane sample code for javax.swing.RootPaneContainer.getRootPane() definition code for javax.swing.RootPaneContainer.getRootPane()

JRootPane sample code for javax.swing.JRootPane definition code for javax.swing.JRootPane  getRootPane()
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.

Returns:
this components single JRootPane child.
See Also:
JRootPane sample code for javax.swing.JRootPane definition code for javax.swing.JRootPane

setContentPane sample code for javax.swing.RootPaneContainer.setContentPane(java.awt.Container) definition code for javax.swing.RootPaneContainer.setContentPane(java.awt.Container)

void setContentPane(Container sample code for java.awt.Container definition code for 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 my not be null.

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

Parameters:
contentPane - the Container to use for the contents of this JRootPane
Throws:
IllegalComponentStateException sample code for java.awt.IllegalComponentStateException definition code for java.awt.IllegalComponentStateException - (a runtime exception) if the content pane parameter is null
See Also:
JRootPane.getContentPane() sample code for javax.swing.JRootPane.getContentPane() definition code for javax.swing.JRootPane.getContentPane() , getContentPane() sample code for javax.swing.RootPaneContainer.getContentPane() definition code for javax.swing.RootPaneContainer.getContentPane()

getContentPane sample code for javax.swing.RootPaneContainer.getContentPane() definition code for javax.swing.RootPaneContainer.getContentPane()

Container sample code for java.awt.Container definition code for java.awt.Container  getContentPane()
Returns the contentPane.

Returns:
the value of the contentPane property.
See Also:
setContentPane(java.awt.Container) sample code for javax.swing.RootPaneContainer.setContentPane(java.awt.Container) definition code for javax.swing.RootPaneContainer.setContentPane(java.awt.Container)

setLayeredPane sample code for javax.swing.RootPaneContainer.setLayeredPane(javax.swing.JLayeredPane) definition code for javax.swing.RootPaneContainer.setLayeredPane(javax.swing.JLayeredPane)

void setLayeredPane(JLayeredPane sample code for javax.swing.JLayeredPane definition code for 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);

Throws:
IllegalComponentStateException sample code for java.awt.IllegalComponentStateException definition code for java.awt.IllegalComponentStateException - (a runtime exception) if the layered pane parameter is null
See Also:
getLayeredPane() sample code for javax.swing.RootPaneContainer.getLayeredPane() definition code for javax.swing.RootPaneContainer.getLayeredPane() , JRootPane.getLayeredPane() sample code for javax.swing.JRootPane.getLayeredPane() definition code for javax.swing.JRootPane.getLayeredPane()

getLayeredPane sample code for javax.swing.RootPaneContainer.getLayeredPane() definition code for javax.swing.RootPaneContainer.getLayeredPane()

JLayeredPane sample code for javax.swing.JLayeredPane definition code for javax.swing.JLayeredPane  getLayeredPane()
Returns the layeredPane.

Returns:
the value of the layeredPane property.
See Also:
setLayeredPane(javax.swing.JLayeredPane) sample code for javax.swing.RootPaneContainer.setLayeredPane(javax.swing.JLayeredPane) definition code for javax.swing.RootPaneContainer.setLayeredPane(javax.swing.JLayeredPane)

setGlassPane sample code for javax.swing.RootPaneContainer.setGlassPane(java.awt.Component) definition code for javax.swing.RootPaneContainer.setGlassPane(java.awt.Component)

void setGlassPane(Component sample code for java.awt.Component definition code for 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 Also:
getGlassPane() sample code for javax.swing.RootPaneContainer.getGlassPane() definition code for javax.swing.RootPaneContainer.getGlassPane() , JRootPane.setGlassPane(java.awt.Component) sample code for javax.swing.JRootPane.setGlassPane(java.awt.Component) definition code for javax.swing.JRootPane.setGlassPane(java.awt.Component)

getGlassPane sample code for javax.swing.RootPaneContainer.getGlassPane() definition code for javax.swing.RootPaneContainer.getGlassPane()

Component sample code for java.awt.Component definition code for java.awt.Component  getGlassPane()
Returns the glassPane.

Returns:
the value of the glassPane property.
See Also:
setGlassPane(java.awt.Component) sample code for javax.swing.RootPaneContainer.setGlassPane(java.awt.Component) definition code for javax.swing.RootPaneContainer.setGlassPane(java.awt.Component)