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 JavaBeans^TM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}. 

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 JavaBeans^TM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}. 

since: 1.4 -

since: 1.4 -

since: 1.4 -

since: 1.4 -

since: 1.4 -

since: 1.4 -

since: 1.4 -

since: 1.4 -

since: 1.4 -

Also see:

defaultButton

Also see:

defaultButton

 public JRootPane() 
{
     
        LOG_DISABLE_TRUE_DOUBLE_BUFFERING =
            AccessController.doPrivileged(new GetBooleanAction(
                                   "swing.logDoubleBufferingDisable"));
        IGNORE_DISABLE_TRUE_DOUBLE_BUFFERING =
            AccessController.doPrivileged(new GetBooleanAction(
                                   "swing.ignoreDoubleBufferingDisable"));
        setGlassPane(createGlassPane());
        setLayeredPane(createLayeredPane());
        setContentPane(createContentPane());
        setLayout(createRootLayout());
        setDoubleBuffered(true);
        updateUI();
}

Creates a JRootPane, setting up its glassPane, layeredPane, and contentPane.

 protected  void addImpl(Component comp,
    Object constraints,
    int index) 
{
        super.addImpl(comp, constraints, index);
        /// We are making sure the glassPane is on top.
        if(glassPane != null
            && glassPane.getParent() == this
            && getComponent(0) != glassPane) {
            add(glassPane, 0);
        }
}

Overridden to enforce the position of the glass component as the zero child.

 public  void addNotify() 
{
        super.addNotify();
        enableEvents(AWTEvent.KEY_EVENT_MASK);
}

{@inheritDoc}

 protected Container createContentPane() 
{
        JComponent c = new JPanel();
        c.setName(this.getName()+".contentPane");
        c.setLayout(new BorderLayout() {
            /* This BorderLayout subclass maps a null constraint to CENTER.
             * Although the reference BorderLayout also does this, some VMs
             * throw an IllegalArgumentException.
             */
            public void addLayoutComponent(Component comp, Object constraints) {
                if (constraints == null) {
                    constraints = BorderLayout.CENTER;
                }
                super.addLayoutComponent(comp, constraints);
            }
        });
        return c;
}

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.

 protected Component createGlassPane() 
{
        JComponent c = new JPanel();
        c.setName(this.getName()+".glassPane");
        c.setVisible(false);
        ((JPanel)c).setOpaque(false);
        return c;
}

Called by the constructor methods to create the default glassPane. By default this method creates a new JComponent with visibility set to false.

 protected JLayeredPane createLayeredPane() 
{
        JLayeredPane p = new JLayeredPane();
        p.setName(this.getName()+".layeredPane");
        return p;
}

Called by the constructor methods to create the default layeredPane. Bt default it creates a new JLayeredPane.

 protected LayoutManager createRootLayout() 
{
        return new RootLayout();
}

Called by the constructor methods to create the default layoutManager.

 final  void disableTrueDoubleBuffering() 
{
        if (useTrueDoubleBuffering) {
            if (!IGNORE_DISABLE_TRUE_DOUBLE_BUFFERING) {
                if (LOG_DISABLE_TRUE_DOUBLE_BUFFERING) {
                    System.out.println("Disabling true double buffering for " +
                                       this);
                    Thread.dumpStack();
                }
                useTrueDoubleBuffering = false;
                RepaintManager.currentManager(this).
                        doubleBufferingChanged(this);
            }
        }
}

 public AccessibleContext getAccessibleContext() 
{
        if (accessibleContext == null) {
            accessibleContext = new AccessibleJRootPane();
        }
        return accessibleContext;
}

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.

 public Container getContentPane() 
{
 return contentPane;
}

Returns the content pane -- the container that holds the components parented by the root pane.

 public JButton getDefaultButton() 
{
        return defaultButton;
}

Returns the value of the defaultButton property.

 public Component getGlassPane() 
{
        return glassPane;
}

Returns the current glass pane for this JRootPane.

 public JMenuBar getJMenuBar() 
{
 return menuBar;
}

Returns the menu bar from the layered pane.

 public JLayeredPane getLayeredPane() 
{
 return layeredPane;
}

Gets the layered pane used by the root pane. The layered pane typically holds a content pane and an optional JMenuBar.

 public JMenuBar getMenuBar() 
{
 return menuBar;
}

Returns the menu bar value.

 public RootPaneUI getUI() 
{
        return (RootPaneUI)ui;
}

Returns the L&F object that renders this component.

 public String getUIClassID() 
{
        return uiClassID;
}

Returns a string that specifies the name of the L&F class that renders this component.

 final boolean getUseTrueDoubleBuffering() 
{
        return useTrueDoubleBuffering;
}

 public int getWindowDecorationStyle() 
{
        return windowDecorationStyle;
}

Returns a constant identifying the type of Window decorations the JRootPane is providing.

 public boolean isOptimizedDrawingEnabled() 
{
        return !glassPane.isVisible();
}

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.

 public boolean isValidateRoot() 
{
        return true;
}

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.

 protected String paramString() 
{
        return super.paramString();
}

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.

 public  void removeNotify() 
{
        super.removeNotify();
}

{@inheritDoc}

 public  void setContentPane(Container content) 
{
        if(content == null)
            throw new IllegalComponentStateException("contentPane cannot be set to null.");
        if(contentPane != null && contentPane.getParent() == layeredPane)
            layeredPane.remove(contentPane);
        contentPane = content;
        layeredPane.add(contentPane, JLayeredPane.FRAME_CONTENT_LAYER);
}

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.

 public  void setDefaultButton(JButton defaultButton) 
{
        JButton oldDefault = this.defaultButton;
        if (oldDefault != defaultButton) {
            this.defaultButton = defaultButton;
            if (oldDefault != null) {
                oldDefault.repaint();
            }
            if (defaultButton != null) {
                defaultButton.repaint();
            }
        }
        firePropertyChange("defaultButton", oldDefault, defaultButton);
}

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.

 public  void setDoubleBuffered(boolean aFlag) 
{
        if (isDoubleBuffered() != aFlag) {
            super.setDoubleBuffered(aFlag);
            RepaintManager.currentManager(this).doubleBufferingChanged(this);
        }
}

{@inheritDoc}

 public  void setGlassPane(Component glass) 
{
        if (glass == null) {
            throw new NullPointerException("glassPane cannot be set to null.");
        }
        boolean visible = false;
        if (glassPane != null && glassPane.getParent() == this) {
            this.remove(glassPane);
            visible = glassPane.isVisible();
        }
        glass.setVisible(visible);
        glassPane = glass;
        this.add(glassPane, 0);
        if (visible) {
            repaint();
        }
}

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);

 public  void setJMenuBar(JMenuBar menu) 
{
        if(menuBar != null && menuBar.getParent() == layeredPane)
            layeredPane.remove(menuBar);
        menuBar = menu;
        if(menuBar != null)
            layeredPane.add(menuBar, JLayeredPane.FRAME_CONTENT_LAYER);
}

Adds or changes the menu bar used in the layered pane.

 public  void setLayeredPane(JLayeredPane layered) 
{
        if(layered == null)
            throw new IllegalComponentStateException("layeredPane cannot be set to null.");
        if(layeredPane != null && layeredPane.getParent() == this)
            this.remove(layeredPane);
        layeredPane = layered;
        this.add(layeredPane, -1);
}

Sets the layered pane for the root pane. The layered pane typically holds a content pane and an optional JMenuBar.

 public  void setMenuBar(JMenuBar menu) 
{
        if(menuBar != null && menuBar.getParent() == layeredPane)
            layeredPane.remove(menuBar);
        menuBar = menu;
        if(menuBar != null)
            layeredPane.add(menuBar, JLayeredPane.FRAME_CONTENT_LAYER);
}

Specifies the menu bar value.

 public  void setUI(RootPaneUI ui) 
{
        super.setUI(ui);
}

Sets the L&F object that renders this component.

 final  void setUseTrueDoubleBuffering(boolean useTrueDoubleBuffering) 
{
        this.useTrueDoubleBuffering = useTrueDoubleBuffering;
}

 public  void setWindowDecorationStyle(int windowDecorationStyle) 
{
        if (windowDecorationStyle <  0 ||
                  windowDecorationStyle  > WARNING_DIALOG) {
            throw new IllegalArgumentException("Invalid decoration style");
        }
        int oldWindowDecorationStyle = getWindowDecorationStyle();
        this.windowDecorationStyle = windowDecorationStyle;
        firePropertyChange("windowDecorationStyle",
                            oldWindowDecorationStyle,
                            windowDecorationStyle);
}

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.

 public  void updateUI() 
{
        setUI((RootPaneUI)UIManager.getUI(this));
}

Resets the UI property to a value from the current look and feel.