| java.lang.Object | ||||
| ↳ | java.awt.Component | |||
| ↳ | java.awt.Container | |||
| ↳ | javax.swing.JComponent | |||
| ↳ | javax.swing.JRootPane | |||
A lightweight container used behind the scenes by
 JFrame, JDialog, JWindow,
 JApplet, and JInternalFrame.
 For task-oriented information on functionality provided by root panes
 see How to Use Root Panes,
 a section in The Java Tutorial.
 
The following image shows the relationships between the classes that use root panes.

JFrame, JDialog,
 JWindow, and JApplet) are
 shown in relation to the AWT classes they extend.
 These four components are the
 only heavyweight containers in the Swing library. The lightweight container
 JInternalFrame is also shown.
 All five of these JFC/Swing containers implement the
 RootPaneContainer interface,
 and they all delegate their operations to a
 JRootPane (shown with a little "handle" on top).
 Note: TheJComponentmethodgetRootPanecan be used to obtain theJRootPanethat contains a given component.
|   | 
JRootPane.
 A JRootpane is made up of a glassPane,
 an optional menuBar, and a contentPane.
 (The JLayeredPane manages the menuBar
 and the contentPane.)
 The glassPane sits over the top of everything,
 where it is in a position to intercept mouse movements.
 Since the glassPane (like the contentPane)
 can be an arbitrary component, it is also possible to set up the
 glassPane for drawing. Lines and images on the
 glassPane can then range
 over the frames underneath without being limited by their boundaries.
 
 Although the menuBar component is optional,
 the layeredPane, contentPane,
 and glassPane always exist.
 Attempting to set them to null generates an exception.
 
 To add components to the JRootPane (other than the
 optional menu bar), you add the object to the contentPane
 of the JRootPane, like this:
 
       rootPane.getContentPane().add(child);
 
 The same principle holds true for setting layout managers, removing
 components, listing children, etc. All these methods are invoked on
 the contentPane instead of on the JRootPane.
 Note: The default layout manager for theIf acontentPaneis aBorderLayoutmanager. However, theJRootPaneuses a customLayoutManager. So, when you want to change the layout manager for the components you added to aJRootPane, be sure to use code like this:rootPane.getContentPane().setLayout(new BoxLayout());
JMenuBar component is set on the JRootPane,
 it is positioned along the upper edge of the frame.
 The contentPane is adjusted in location and size to
 fill the remaining area.
 (The JMenuBar and the contentPane are added to the
 layeredPane component at the
 JLayeredPane.FRAME_CONTENT_LAYER layer.)
 
 The layeredPane is the parent of all children in the
 JRootPane -- both as the direct parent of the menu and
 the grandparent of all components added to the contentPane.
 It is an instance of JLayeredPane,
 which provides the ability to add components at several layers.
 This capability is very useful when working with menu popups,
 dialog boxes, and dragging -- situations in which you need to place
 a component on top of all other components in the pane.
 
 The glassPane sits on top of all other components in the
 JRootPane.
 That provides a convenient place to draw above all other components,
 and makes it possible to intercept mouse events,
 which is useful both for dragging and for drawing.
 Developers can use setVisible on the glassPane
 to control when the glassPane displays over the other children.
 By default the glassPane is not visible.
 
 The custom LayoutManager used by JRootPane
 ensures that:
 
glassPane fills the entire viewable
     area of the JRootPane (bounds - insets).
 layeredPane fills the entire viewable area of the
     JRootPane. (bounds - insets)
 menuBar is positioned at the upper edge of the
     layeredPane.
 contentPane fills the entire viewable area,
     minus the menuBar, if present.
 JRootPane view hierarchy are ignored.
 
 If you replace the LayoutManager of the JRootPane,
 you are responsible for managing all of these views.
 So ordinarily you will want to be sure that you
 change the layout manager for the contentPane rather than
 for the JRootPane itself!
 
 The painting architecture of Swing requires an opaque
 JComponent
 to exist in the containment hieararchy above all other components. This is
 typically provided by way of the content pane. If you replace the content
 pane, it is recommended that you make the content pane opaque
 by way of setOpaque(true). Additionally, if the content pane
 overrides paintComponent, it
 will need to completely fill in the background in an opaque color in
 paintComponent.
 
Warning: Swing is not thread safe. For more information see Swing's Threading Policy.
 Warning:
 Serialized objects of this class will not be compatible with
 future Swing releases. The current serialization support is
 appropriate for short term storage or RMI between applications running
 the same version of Swing.  As of 1.4, support for long term storage
 of all JavaBeansTM
 has been added to the java.beans package.
 Please see XMLEncoder.
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| JRootPane.AccessibleJRootPane | This class implements accessibility support for the JRootPaneclass. | ||||||||||
| JRootPane.RootLayout | A custom layout manager that is responsible for the layout of layeredPane, glassPane, and menuBar. | ||||||||||
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | COLOR_CHOOSER_DIALOG | Constant used for the windowDecorationStyle property. | |||||||||
| int | ERROR_DIALOG | Constant used for the windowDecorationStyle property. | |||||||||
| int | FILE_CHOOSER_DIALOG | Constant used for the windowDecorationStyle property. | |||||||||
| int | FRAME | Constant used for the windowDecorationStyle property. | |||||||||
| int | INFORMATION_DIALOG | Constant used for the windowDecorationStyle property. | |||||||||
| int | NONE | Constant used for the windowDecorationStyle property. | |||||||||
| int | PLAIN_DIALOG | Constant used for the windowDecorationStyle property. | |||||||||
| int | QUESTION_DIALOG | Constant used for the windowDecorationStyle property. | |||||||||
| int | WARNING_DIALOG | Constant used for the windowDecorationStyle property. | |||||||||
| [Expand] Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|  From class
javax.swing.JComponent | |||||||||||
|  From class
java.awt.Component | |||||||||||
|  From interface
java.awt.image.ImageObserver | |||||||||||
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| contentPane | The content pane. | ||||||||||
| defaultButton | The button that gets activated when the pane has the focus and a UI-specific action like pressing the Enter key occurs. | ||||||||||
| defaultPressAction | This field is deprecated. As of Java 2 platform v1.3. | ||||||||||
| defaultReleaseAction | This field is deprecated. As of Java 2 platform v1.3. | ||||||||||
| glassPane | The glass pane that overlays the menu bar and content pane, so it can intercept mouse movements and such. | ||||||||||
| layeredPane | The layered pane that manages the menu bar and content pane. | ||||||||||
| menuBar | The menu bar. | ||||||||||
| [Expand] Inherited Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|  From class
javax.swing.JComponent | |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Creates a  JRootPane, setting up itsglassPane,layeredPane,
 andcontentPane. | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Notifies this component that it now has a parent component.
 | |||||||||||
| Gets the  AccessibleContextassociated with thisJRootPane. | |||||||||||
| Returns the content pane -- the container that holds the components
 parented by the root pane. | |||||||||||
| Returns the value of the  defaultButtonproperty. | |||||||||||
| Returns the current glass pane for this  JRootPane. | |||||||||||
| Returns the menu bar from the layered pane. | |||||||||||
| Gets the layered pane used by the root pane. | |||||||||||
| 
      
  This method is deprecated.
      As of Swing version 1.0.3
  replaced by  getJMenuBar(). | |||||||||||
| Returns the L&F object that renders this component. | |||||||||||
| Returns a string that specifies the name of the L&F class
 that renders this component. | |||||||||||
| Returns a constant identifying the type of Window decorations the
  JRootPaneis providing. | |||||||||||
| The  glassPaneandcontentPanehave the same bounds, which meansJRootPanedoes not tiles its children and this should return false. | |||||||||||
| If a descendant of this  JRootPanecallsrevalidate, validate from here on down. | |||||||||||
| Notifies this component that it no longer has a parent component.
 | |||||||||||
| Sets the content pane -- the container that holds the components
 parented by the root pane. | |||||||||||
| Sets the  defaultButtonproperty,
 which determines the current default button for thisJRootPane. | |||||||||||
| Sets whether this component should use a buffer to paint. | |||||||||||
| Sets a specified  Componentto be the glass pane for this
 root pane. | |||||||||||
| Adds or changes the menu bar used in the layered pane. | |||||||||||
| Sets the layered pane for the root pane. | |||||||||||
| 
      
  This method is deprecated.
      As of Swing version 1.0.3
  replaced by  setJMenuBar(JMenuBar menu). | |||||||||||
| Sets the L&F object that renders this component. | |||||||||||
| Sets the type of Window decorations (such as borders, widgets for
 closing a Window, title ...) the  JRootPaneshould
 provide. | |||||||||||
| Resets the UI property to a value from the current look and feel. | |||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Overridden to enforce the position of the glass component as
 the zero child. | |||||||||||
| Called by the constructor methods to create the default
  contentPane. | |||||||||||
| Called by the constructor methods to create the default
  glassPane. | |||||||||||
| Called by the constructor methods to create the default
  layeredPane. | |||||||||||
| Called by the constructor methods to create the default
  layoutManager. | |||||||||||
| Returns a string representation of this  JRootPane. | |||||||||||
| [Expand] Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|  From class
  javax.swing.JComponent | |||||||||||
|  From class
  java.awt.Container | |||||||||||
|  From class
  java.awt.Component | |||||||||||
|  From class
  java.lang.Object | |||||||||||
|  From interface
  java.awt.MenuContainer | |||||||||||
|  From interface
  java.awt.image.ImageObserver | |||||||||||
|  From interface
  javax.accessibility.Accessible | |||||||||||
Constant used for the windowDecorationStyle property. Indicates that
 the JRootPane should provide decorations appropriate for
 a Dialog used to display a JColorChooser.
Constant used for the windowDecorationStyle property. Indicates that
 the JRootPane should provide decorations appropriate for
 a Dialog used to display an error message.
Constant used for the windowDecorationStyle property. Indicates that
 the JRootPane should provide decorations appropriate for
 a Dialog used to display a JFileChooser.
Constant used for the windowDecorationStyle property. Indicates that
 the JRootPane should provide decorations appropriate for
 a Frame.
Constant used for the windowDecorationStyle property. Indicates that
 the JRootPane should provide decorations appropriate for
 a Dialog used to display an informational message.
Constant used for the windowDecorationStyle property. Indicates that
 the JRootPane should not provide any sort of
 Window decorations.
Constant used for the windowDecorationStyle property. Indicates that
 the JRootPane should provide decorations appropriate for
 a Dialog.
Constant used for the windowDecorationStyle property. Indicates that
 the JRootPane should provide decorations appropriate for
 a Dialog used to present a question to the user.
Constant used for the windowDecorationStyle property. Indicates that
 the JRootPane should provide decorations appropriate for
 a Dialog used to display a warning message.
The button that gets activated when the pane has the focus and a UI-specific action like pressing the Enter key occurs.
      
  This field is deprecated.
 As of Java 2 platform v1.3.
  
As of Java 2 platform v1.3 this unusable field is no longer used.
 To override the default button you should replace the Action
 in the JRootPane's ActionMap. Please refer to
 the key bindings specification for further details.
      
  This field is deprecated.
 As of Java 2 platform v1.3.
  
As of Java 2 platform v1.3 this unusable field is no longer used.
 To override the default button you should replace the Action
 in the JRootPane's ActionMap. Please refer to
 the key bindings specification for further details.
The glass pane that overlays the menu bar and content pane, so it can intercept mouse movements and such.
Creates a JRootPane, setting up its
 glassPane, layeredPane,
 and contentPane.
Notifies this component that it now has a parent component.
 When this method is invoked, the chain of parent components is
 set up with KeyboardAction event listeners.
Gets the AccessibleContext associated with this
 JRootPane. For root panes, the
 AccessibleContext takes the form of an
 AccessibleJRootPane.
 A new AccessibleJRootPane instance is created if necessary.
AccessibleJRootPane that serves as the
         AccessibleContext of this JRootPane
Returns the content pane -- the container that holds the components parented by the root pane.
Container that holds the component-contents
Returns the value of the defaultButton property.
JButton which is currently the default buttonReturns the current glass pane for this JRootPane.
Returns the menu bar from the layered pane.
JMenuBar used in the pane
Gets the layered pane used by the root pane. The layered pane
 typically holds a content pane and an optional JMenuBar.
JLayeredPane currently in use
      
  This method is deprecated.
 As of Swing version 1.0.3
  replaced by getJMenuBar().
  
Returns the menu bar value.
JMenuBar used in the pane
Returns the L&F object that renders this component.
LabelUI objectReturns a string that specifies the name of the L&F class that renders this component.
Returns a constant identifying the type of Window decorations the
 JRootPane is providing.
NONE, FRAME,
        PLAIN_DIALOG, INFORMATION_DIALOG,
        ERROR_DIALOG, COLOR_CHOOSER_DIALOG,
        FILE_CHOOSER_DIALOG, QUESTION_DIALOG or
        WARNING_DIALOG.The glassPane and contentPane
 have the same bounds, which means JRootPane
 does not tiles its children and this should return false.
 On the other hand, the glassPane
 is normally not visible, and so this can return true if the
 glassPane isn't visible. Therefore, the
 return value here depends upon the visiblity of the
 glassPane.
If a descendant of this JRootPane calls
 revalidate, validate from here on down.
 Deferred requests to layout a component and its descendents again.
 For example, calls to revalidate, are pushed upwards to
 either a JRootPane or a JScrollPane
 because both classes override isValidateRoot to return true.
Notifies this component that it no longer has a parent component.
 When this method is invoked, any KeyboardActions
 set up in the the chain of parent components are removed.
Sets the content pane -- the container that holds the components parented by the root pane.
 Swing's painting architecture requires an opaque JComponent
 in the containment hiearchy. This is typically provided by the
 content pane. If you replace the content pane it is recommended you
 replace it with an opaque JComponent.
| content | the Containerto use for component-contents | 
|---|
| IllegalComponentStateException | (a runtime
            exception) if the content pane parameter is null | 
|---|
Sets the defaultButton property,
 which determines the current default button for this JRootPane.
 The default button is the button which will be activated
 when a UI-defined activation event (typically the Enter key)
 occurs in the root pane regardless of whether or not the button
 has keyboard focus (unless there is another component within
 the root pane which consumes the activation event,
 such as a JTextPane).
 For default activation to work, the button must be an enabled
 descendent of the root pane when activation occurs.
 To remove a default button from this root pane, set this
 property to null.
| defaultButton | the JButtonwhich is to be the default button | 
|---|
Sets whether this component should use a buffer to paint.
  If set to true, all the drawing from this component will be done
  in an offscreen painting buffer. The offscreen painting buffer will
  the be copied onto the screen.
  If a Component is buffered and one of its ancestor
  is also buffered, the ancestor buffer will be used.
| aFlag | if true, set this component to be double buffered | 
|---|
Sets a specified Component to be the glass pane for this
 root pane.  The glass pane should normally be a lightweight,
 transparent component, because it will be made visible when
 ever the root pane needs to grab input events.
 
The new glass pane's visibility is changed to match that of the current glass pane. An implication of this is that care must be taken when you want to replace the glass pane and make it visible. Either of the following will work:
root.setGlassPane(newGlassPane); newGlassPane.setVisible(true);or:
root.getGlassPane().setVisible(true); root.setGlassPane(newGlassPane);
| glass | the Componentto use as the glass pane
              for thisJRootPane | 
|---|
| NullPointerException | if the glassparameter isnull | 
|---|
Adds or changes the menu bar used in the layered pane.
| menu | the JMenuBarto add | 
|---|
Sets the layered pane for the root pane. The layered pane
 typically holds a content pane and an optional JMenuBar.
| layered | the JLayeredPaneto use | 
|---|
| IllegalComponentStateException | (a runtime
            exception) if the layered pane parameter is null | 
|---|
      
  This method is deprecated.
 As of Swing version 1.0.3
  replaced by setJMenuBar(JMenuBar menu).
  
Specifies the menu bar value.
| menu | the JMenuBarto add. | 
|---|
Sets the L&F object that renders this component.
| ui | the LabelUIL&F object | 
|---|
Sets the type of Window decorations (such as borders, widgets for
 closing a Window, title ...) the JRootPane should
 provide. The default is to provide no Window decorations
 (NONE).
 
This is only a hint, and some look and feels may not support this. This is a bound property.
| windowDecorationStyle | Constant identifying Window decorations to provide. | 
|---|
| IllegalArgumentException | if styleis
        not one of:NONE,FRAME,PLAIN_DIALOG,INFORMATION_DIALOG,ERROR_DIALOG,COLOR_CHOOSER_DIALOG,FILE_CHOOSER_DIALOG,QUESTION_DIALOG, orWARNING_DIALOG. | 
|---|
Resets the UI property to a value from the current look and feel.
Overridden to enforce the position of the glass component as the zero child.
| comp | the component to be enhanced | 
|---|---|
| constraints | the constraints to be respected | 
| index | the index | 
Called by the constructor methods to create the default
 contentPane.
 By default this method creates a new JComponent add sets a
 BorderLayout as its LayoutManager.
contentPane
Called by the constructor methods to create the default
 glassPane.
 By default this method creates a new JComponent
 with visibility set to false.
glassPane
Called by the constructor methods to create the default
 layeredPane.
 Bt default it creates a new JLayeredPane.
layeredPane
Called by the constructor methods to create the default
 layoutManager.
layoutManager.
Returns a string representation of this JRootPane.
 This method is intended to be used only for debugging purposes,
 and the content and format of the returned string may vary between
 implementations. The returned string may be empty but may not
 be null.
JRootPane.