since: 1.3 -

Also see:

JRootPane
RootPaneContainer

Also see:

isRootPaneCheckingEnabled
setRootPaneCheckingEnabled
javax.swing.RootPaneContainer

 public JFrame() throws HeadlessException 
{
                                             
        super();
        frameInit();
}

Constructs a new frame that is initially invisible.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

Also see:

java.awt.GraphicsEnvironment#isHeadless
Component#setSize
Component#setVisible
JComponent#getDefaultLocale
exception: HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

 public JFrame(GraphicsConfiguration gc) 
{
        super(gc);
        frameInit();
}

Creates a Frame in the specified GraphicsConfiguration of a screen device and a blank title.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

gc - the GraphicsConfiguration that is used to construct the new Frame; if gc is null, the system default GraphicsConfiguration is assumed

Throws:

IllegalArgumentException - if gc is not from a screen device. This exception is always thrown when GraphicsEnvironment.isHeadless() returns true.

Also see:

java.awt.GraphicsEnvironment#isHeadless
JComponent#getDefaultLocale
exception: IllegalArgumentException - if gc is not from a screen device. This exception is always thrown when GraphicsEnvironment.isHeadless() returns true.

since: 1.3 -

 public JFrame(String title) throws HeadlessException 
{
        super(title);
        frameInit();
}

Creates a new, initially invisible Frame with the specified title.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

title - the title for the frame

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

Also see:

java.awt.GraphicsEnvironment#isHeadless
Component#setSize
Component#setVisible
JComponent#getDefaultLocale
exception: HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

 public JFrame(String title,
    GraphicsConfiguration gc) 
{
        super(title, gc);
        frameInit();
}

Creates a JFrame with the specified title and the specified GraphicsConfiguration of a screen device.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

title - the title to be displayed in the frame's border. A null value is treated as an empty string, "".

gc - the GraphicsConfiguration that is used to construct the new JFrame with; if gc is null, the system default GraphicsConfiguration is assumed

Throws:

IllegalArgumentException - if gc is not from a screen device. This exception is always thrown when GraphicsEnvironment.isHeadless() returns true.

Also see:

java.awt.GraphicsEnvironment#isHeadless
JComponent#getDefaultLocale
exception: IllegalArgumentException - if gc is not from a screen device. This exception is always thrown when GraphicsEnvironment.isHeadless() returns true.

since: 1.3 -

 protected  void addImpl(Component comp,
    Object constraints,
    int index) 
{
        if(isRootPaneCheckingEnabled()) {
            getContentPane().add(comp, constraints, index);
        }
        else {
            super.addImpl(comp, constraints, index);
        }
}

Adds the specified child Component. This method is overridden to conditionally forward calls to the contentPane. By default, children are added to the contentPane instead of the frame, refer to javax.swing.RootPaneContainer for details.

 protected JRootPane createRootPane() 
{
        JRootPane rp = new JRootPane();
        // NOTE: this uses setOpaque vs LookAndFeel.installProperty as there
        // is NO reason for the RootPane not to be opaque. For painting to
        // work the contentPane must be opaque, therefor the RootPane can
        // also be opaque.
        rp.setOpaque(true);
        return rp;
}

Called by the constructor methods to create the default rootPane.

 protected  void frameInit() 
{
        enableEvents(AWTEvent.KEY_EVENT_MASK | AWTEvent.WINDOW_EVENT_MASK);
        setLocale( JComponent.getDefaultLocale() );
        setRootPane(createRootPane());
        setBackground(UIManager.getColor("control"));
        setRootPaneCheckingEnabled(true);
        if (JFrame.isDefaultLookAndFeelDecorated()) {
            boolean supportsWindowDecorations =
            UIManager.getLookAndFeel().getSupportsWindowDecorations();
            if (supportsWindowDecorations) {
                setUndecorated(true);
                getRootPane().setWindowDecorationStyle(JRootPane.FRAME);
            }
        }
        sun.awt.SunToolkit.checkAndSetPolicy(this, true);
}

Called by the constructors to init the JFrame properly.

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

Gets the AccessibleContext associated with this JFrame. For JFrames, the AccessibleContext takes the form of an AccessibleJFrame. A new AccessibleJFrame instance is created if necessary.

 public Container getContentPane() 
{
        return getRootPane().getContentPane();
}

Returns the contentPane object for this frame.

 public int getDefaultCloseOperation() 
{
        return defaultCloseOperation;
}

Returns the operation that occurs when the user initiates a "close" on this frame.

 public Component getGlassPane() 
{
        return getRootPane().getGlassPane();
}

Returns the glassPane object for this frame.

 public Graphics getGraphics() 
{
        JComponent.getGraphicsInvoked(this);
        return super.getGraphics();
}

{@inheritDoc}

 public JMenuBar getJMenuBar() 
{
        return getRootPane().getMenuBar();
}

Returns the menubar set on this frame.

 public JLayeredPane getLayeredPane() 
{
        return getRootPane().getLayeredPane();
}

Returns the layeredPane object for this frame.

 public JRootPane getRootPane() 
{
        return rootPane;
}

Returns the rootPane object for this frame.

 public TransferHandler getTransferHandler() 
{
        return transferHandler;
}

Gets the transferHandler property.

 public static boolean isDefaultLookAndFeelDecorated() 
{
        Boolean defaultLookAndFeelDecorated =
            (Boolean) SwingUtilities.appContextGet(defaultLookAndFeelDecoratedKey);
        if (defaultLookAndFeelDecorated == null) {
            defaultLookAndFeelDecorated = Boolean.FALSE;
        }
        return defaultLookAndFeelDecorated.booleanValue();
}

Returns true if newly created JFrames should have their Window decorations provided by the current look and feel. This is only a hint, as certain look and feels may not support this feature.

 protected boolean isRootPaneCheckingEnabled() 
{
        return rootPaneCheckingEnabled;
}

Returns whether calls to add and setLayout are forwarded to the contentPane.

 protected String paramString() 
{
        String defaultCloseOperationString;
        if (defaultCloseOperation == HIDE_ON_CLOSE) {
            defaultCloseOperationString = "HIDE_ON_CLOSE";
        } else if (defaultCloseOperation == DISPOSE_ON_CLOSE) {
            defaultCloseOperationString = "DISPOSE_ON_CLOSE";
        } else if (defaultCloseOperation == DO_NOTHING_ON_CLOSE) {
            defaultCloseOperationString = "DO_NOTHING_ON_CLOSE";
        } else if (defaultCloseOperation == 3) {
            defaultCloseOperationString = "EXIT_ON_CLOSE";
        } else defaultCloseOperationString = "";
        String rootPaneString = (rootPane != null ?
                                 rootPane.toString() : "");
        String rootPaneCheckingEnabledString = (rootPaneCheckingEnabled ?
                                                "true" : "false");
        return super.paramString() +
        ",defaultCloseOperation=" + defaultCloseOperationString +
        ",rootPane=" + rootPaneString +
        ",rootPaneCheckingEnabled=" + rootPaneCheckingEnabledString;
}

Returns a string representation of this JFrame. 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.

 protected  void processWindowEvent(WindowEvent e) 
{
        super.processWindowEvent(e);
        if (e.getID() == WindowEvent.WINDOW_CLOSING) {
            switch(defaultCloseOperation) {
              case HIDE_ON_CLOSE:
                 setVisible(false);
                 break;
              case DISPOSE_ON_CLOSE:
                 dispose();
                 break;
              case DO_NOTHING_ON_CLOSE:
                 default:
                 break;
              case EXIT_ON_CLOSE:
                  // This needs to match the checkExit call in
                  // setDefaultCloseOperation
                System.exit(0);
                break;
            }
        }
}

Processes window events occurring on this component. Hides the window or disposes of it, as specified by the setting of the defaultCloseOperation property.

 public  void remove(Component comp) 
{
        if (comp == rootPane) {
            super.remove(comp);
        } else {
            getContentPane().remove(comp);
        }
}

Removes the specified component from the container. If comp is not the rootPane, this will forward the call to the contentPane. This will do nothing if comp is not a child of the JFrame or contentPane.

 public  void repaint(long time,
    int x,
    int y,
    int width,
    int height) 
{
        if (RepaintManager.HANDLE_TOP_LEVEL_PAINT) {
            RepaintManager.currentManager(this).addDirtyRegion(
                              this, x, y, width, height);
        }
        else {
            super.repaint(time, x, y, width, height);
        }
}

Repaints the specified rectangle of this component within time milliseconds. Refer to RepaintManager for details on how the repaint is handled.

 public  void setContentPane(Container contentPane) 
{
        getRootPane().setContentPane(contentPane);
}

Sets the contentPane property. This method is called by the constructor.

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 setDefaultCloseOperation(int operation) 
{
        if (operation != DO_NOTHING_ON_CLOSE &&
            operation != HIDE_ON_CLOSE &&
            operation != DISPOSE_ON_CLOSE &&
            operation != EXIT_ON_CLOSE) {
            throw new IllegalArgumentException("defaultCloseOperation must be one of: DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE, DISPOSE_ON_CLOSE, or EXIT_ON_CLOSE");
        }
        if (this.defaultCloseOperation != operation) {
            if (operation == EXIT_ON_CLOSE) {
                SecurityManager security = System.getSecurityManager();
                if (security != null) {
                    security.checkExit(0);
                }
            }
            int oldValue = this.defaultCloseOperation;
            this.defaultCloseOperation = operation;
            firePropertyChange("defaultCloseOperation", oldValue, operation);
        }
}

Sets the operation that will happen by default when the user initiates a "close" on this frame. You must specify one of the following choices:
• DO_NOTHING_ON_CLOSE (defined in WindowConstants): Don't do anything; require the program to handle the operation in the windowClosing method of a registered WindowListener object.
• HIDE_ON_CLOSE (defined in WindowConstants): Automatically hide the frame after invoking any registered WindowListener objects.
• DISPOSE_ON_CLOSE (defined in WindowConstants): Automatically hide and dispose the frame after invoking any registered WindowListener objects.
• EXIT_ON_CLOSE (defined in JFrame): Exit the application using the System exit method. Use this only in applications.

The value is set to HIDE_ON_CLOSE by default. Changes to the value of this property cause the firing of a property change event, with property name "defaultCloseOperation".

Note: When the last displayable window within the Java virtual machine (VM) is disposed of, the VM may terminate. See AWT Threading Issues for more information.

 public static  void setDefaultLookAndFeelDecorated(boolean defaultLookAndFeelDecorated) 
{
        if (defaultLookAndFeelDecorated) {
            SwingUtilities.appContextPut(defaultLookAndFeelDecoratedKey, Boolean.TRUE);
        } else {
            SwingUtilities.appContextPut(defaultLookAndFeelDecoratedKey, Boolean.FALSE);
        }
}

Provides a hint as to whether or not newly created JFrames should have their Window decorations (such as borders, widgets to close the window, title...) provided by the current look and feel. If defaultLookAndFeelDecorated is true, the current LookAndFeel supports providing window decorations, and the current window manager supports undecorated windows, then newly created JFrames will have their Window decorations provided by the current LookAndFeel. Otherwise, newly created JFrames will have their Window decorations provided by the current window manager.

You can get the same effect on a single JFrame by doing the following:

JFrame frame = new JFrame();
frame.setUndecorated(true);
frame.getRootPane().setWindowDecorationStyle(JRootPane.FRAME);

 public  void setGlassPane(Component glassPane) 
{
        getRootPane().setGlassPane(glassPane);
}

Sets the glassPane property. This method is called by the constructor.

 public  void setIconImage(Image image) 
{
        super.setIconImage(image);
}

{@inheritDoc}

 public  void setJMenuBar(JMenuBar menubar) 
{
        getRootPane().setMenuBar(menubar);
}

Sets the menubar for this frame.

 public  void setLayeredPane(JLayeredPane layeredPane) 
{
        getRootPane().setLayeredPane(layeredPane);
}

Sets the layeredPane property. This method is called by the constructor.

 public  void setLayout(LayoutManager manager) 
{
        if(isRootPaneCheckingEnabled()) {
            getContentPane().setLayout(manager);
        }
        else {
            super.setLayout(manager);
        }
}

Sets the LayoutManager. Overridden to conditionally forward the call to the contentPane. Refer to javax.swing.RootPaneContainer for more information.

 protected  void setRootPane(JRootPane root) 
{
        if(rootPane != null) {
            remove(rootPane);
        }
        rootPane = root;
        if(rootPane != null) {
            boolean checkingEnabled = isRootPaneCheckingEnabled();
            try {
                setRootPaneCheckingEnabled(false);
                add(rootPane, BorderLayout.CENTER);
            }
            finally {
                setRootPaneCheckingEnabled(checkingEnabled);
            }
        }
}

Sets the rootPane property. This method is called by the constructor.

 protected  void setRootPaneCheckingEnabled(boolean enabled) 
{
        rootPaneCheckingEnabled = enabled;
}

Sets whether calls to add and setLayout are forwarded to the contentPane.

 public  void setTransferHandler(TransferHandler newHandler) 
{
        TransferHandler oldHandler = transferHandler;
        transferHandler = newHandler;
        SwingUtilities.installSwingDropTargetAsNecessary(this, transferHandler);
        firePropertyChange("transferHandler", oldHandler, newHandler);
}

Sets the {@code transferHandler} property, which is a mechanism to support transfer of data into this component. Use {@code null} if the component does not support data transfer operations.

If the system property {@code suppressSwingDropSupport} is {@code false} (the default) and the current drop target on this component is either {@code null} or not a user-set drop target, this method will change the drop target as follows: If {@code newHandler} is {@code null} it will clear the drop target. If not {@code null} it will install a new {@code DropTarget}.

Note: When used with {@code JFrame}, {@code TransferHandler} only provides data import capability, as the data export related methods are currently typed to {@code JComponent}.

Please see How to Use Drag and Drop and Data Transfer, a section in The Java Tutorial, for more information.

 public  void update(Graphics g) 
{
        paint(g);
}

Just calls paint(g). This method was overridden to prevent an unnecessary call to clear the background.