javax.swing
Class JFrame

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame

All Implemented Interfaces:

java.awt.image.ImageObserver, RootPaneContainer, java.io.Serializable, WindowConstants

public class JFrame

extends java.awt.Frame

implements WindowConstants, RootPaneContainer

An extended version of java.awt.Frame that adds support for the JFC/Swing component architecture. You can find task-oriented documentation about using JFrame in The Java Tutorial, in the section How to Make Frames.

The JFrame class is slightly incompatible with Frame. Like all other JFC/Swing top-level containers, a JFrame contains a JRootPane as its only child. The content pane provided by the root pane should, as a rule, contain all the non-menu components displayed by the JFrame. This is different from the AWT Frame case. For example, to add a child to an AWT frame you'd write:

       frame.add(child);
 

However using JFrame you need to add the child to the JFrame's content pane instead:

       frame.getContentPane().add(child);
 

The same is true for setting layout managers, removing components, listing children, and so on. All these methods should normally be sent to the content pane instead of the JFrame itself. The content pane will always be non-null. Attempting to set it to null will cause the JFrame to throw an exception. The default content pane will have a BorderLayout manager set on it.

Unlike a Frame, a JFrame has some notion of how to respond when the user attempts to close the window. The default behavior is to simply hide the JFrame when the user closes the window. To change the default behavior, you invoke the method setDefaultCloseOperation(int). To make the JFrame behave the same as a Frame instance, use setDefaultCloseOperation(WindowConstants.DO_NOTHING_ON_CLOSE).

For more information on content panes and other features that root panes provide, see Using Top-Level Containers in The Java Tutorial.

In a multi-screen environment, you can create a JFrame on a different screen device. See Frame for more information.

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 java.beans.XMLEncoder.

Restrictions

Personal Basis Profile restricts the constructors of java.awt.Frame to disallow multiple instances of Frame on a single GraphicsDevice. As a subclass of Frame, JFrame is subject to these restrictions when AGUI is implemented in conjunction with Personal Basis Profile. In such a case, only a single instance of JFrame is permitted per GraphicsDevice. Attempts to construct a second JFrame will cause the constructor to throw java.lang.UnsupportedOperationException. See:

• JFrame()
• JFrame(GraphicsConfiguration)
• JFrame(String)
• JFrame(String, GraphicsConfiguration)

See Also:

JRootPane, setDefaultCloseOperation(int), WindowListener.windowClosing(java.awt.event.WindowEvent)

Field Summary

static int	EXIT_ON_CLOSE The exit application default window close operation.
protected JRootPane	rootPane The JRootPane instance that manages the contentPane and optional menuBar for this frame, as well as the glassPane.
protected boolean	rootPaneCheckingEnabled If true then calls to add and setLayout will cause an exception to be thrown.

Fields inherited from class java.awt.Frame

ICONIFIED, NORMAL

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

JFrame()
Constructs a new frame that is initially invisible.

JFrame(GraphicsConfiguration gc)
Creates a Frame in the specified GraphicsConfiguration of a screen device and a blank title.

JFrame(java.lang.String title)
Creates a new, initially invisible Frame with the specified title.

JFrame(java.lang.String title, GraphicsConfiguration gc)
Creates a JFrame with the specified title and the specified GraphicsConfiguration of a screen device.

Method Summary

protected void	addImpl(java.awt.Component comp, java.lang.Object constraints, int index) By default, children may not be added directly to this component, they must be added to its contentPane instead.
protected JRootPane	createRootPane() Called by the constructor methods to create the default rootPane.
java.awt.Container	getContentPane() Returns the contentPane object for this frame.
int	getDefaultCloseOperation() Returns the operation that occurs when the user initiates a "close" on this frame.
java.awt.Component	getGlassPane() Returns the glassPane object for this frame.
JMenuBar	getJMenuBar() Returns the menubar set on this frame.
JLayeredPane	getLayeredPane() Returns the layeredPane object for this frame.
JRootPane	getRootPane() Returns the rootPane object for this frame.
protected boolean	isRootPaneCheckingEnabled() Returns whether calls to add and setLayout cause an exception to be thrown.
protected java.lang.String	paramString() Returns a string representation of this JFrame.
protected void	processWindowEvent(java.awt.event.WindowEvent e) Processes window events occurring on this component.
void	remove(java.awt.Component comp) Removes the specified component from this container.
void	setContentPane(java.awt.Container contentPane) Sets the contentPane property.
void	setDefaultCloseOperation(int operation) Sets the operation that will happen by default when the user initiates a "close" on this frame.
void	setGlassPane(java.awt.Component glassPane) Sets the glassPane property.
void	setJMenuBar(JMenuBar menubar) Sets the menubar for this frame.
void	setLayeredPane(JLayeredPane layeredPane) Sets the layeredPane property.
void	setLayout(java.awt.LayoutManager manager) By default the layout of this component may not be set, the layout of its contentPane should be set instead.
protected void	setRootPane(JRootPane root) Sets the rootPane property.
protected void	setRootPaneCheckingEnabled(boolean enabled) Determines whether calls to add and setLayout will cause an exception to be thrown.
void	update(java.awt.Graphics g) Just calls paint(g).

Methods inherited from class java.awt.Frame

getIconImage, getState, getTitle, isResizable, isUndecorated, setIconImage, setResizable, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addWindowFocusListener, addWindowListener, dispose, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getLocale, getMostRecentFocusOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, processEvent, processWindowFocusEvent, removeWindowFocusListener, removeWindowListener, setCursor, setFocusableWindowState, setFocusCycleRoot, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, areFocusTraversalKeysSet, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, list, list, paint, paintComponents, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addNotify, addPropertyChangeListener, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enableEvents, enableInputMethods, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getCursor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, hasFocus, imageUpdate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isValid, isVisible, list, list, list, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, setBackground, setBounds, setBounds, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EXIT_ON_CLOSE

public static final int EXIT_ON_CLOSE

The exit application default window close operation. If a window has this set as the close operation and is closed in an applet, a SecurityException may be thrown. It is recommended you only use this in an application.

Since:

1.3

See Also:

Constant Field Values

rootPane

protected JRootPane rootPane

The JRootPane instance that manages the contentPane and optional menuBar for this frame, as well as the glassPane.

See Also:

JRootPane, RootPaneContainer

rootPaneCheckingEnabled

protected boolean rootPaneCheckingEnabled

If true then calls to add and setLayout will cause an exception to be thrown. The default is false.

See Also:

isRootPaneCheckingEnabled(), setRootPaneCheckingEnabled(boolean)

Constructor Detail

JFrame

public JFrame()
       throws java.awt.HeadlessException

Constructs a new frame that is initially invisible.

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

Note: This operation is subject to restriction when AGUI is implemented in conjunction with Personal Basis Profile.

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless(), Component.setSize(int, int), Component.setVisible(boolean), JComponent.getDefaultLocale()

JFrame

public JFrame(GraphicsConfiguration gc)

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.

Note: This operation is subject to restriction when AGUI is implemented in conjunction with Personal Basis Profile.

Parameters:

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

Throws:

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

Since:

1.3

See Also:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

JFrame

public JFrame(java.lang.String title)
       throws java.awt.HeadlessException

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.

Note: This operation is subject to restriction when AGUI is implemented in conjunction with Personal Basis Profile.

Parameters:

title - the title for the frame

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless(), Component.setSize(int, int), Component.setVisible(boolean), JComponent.getDefaultLocale()

JFrame

public JFrame(java.lang.String title,
              GraphicsConfiguration gc)

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.

Note: This operation is subject to restriction when AGUI is implemented in conjunction with Personal Basis Profile.

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:

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

Since:

1.3

See Also:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

Method Detail

createRootPane

protected JRootPane createRootPane()

Called by the constructor methods to create the default rootPane.

processWindowEvent

protected void processWindowEvent(java.awt.event.WindowEvent e)

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

Parameters:

e - the window event

See Also:

setDefaultCloseOperation(int), Window.processWindowEvent(java.awt.event.WindowEvent)

setDefaultCloseOperation

public void setDefaultCloseOperation(int 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.

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.

Parameters:

operation - the operation which should be performed when the user closes the frame

Throws:

java.lang.IllegalArgumentException - if defaultCloseOperation value isn't one of the above valid values

java.lang.SecurityException - if EXIT_ON_CLOSE has been specified and the SecurityManager will not allow the caller to invoke System.exit

See Also:

Window.addWindowListener(java.awt.event.WindowListener), getDefaultCloseOperation(), WindowConstants, Runtime.exit(int)

getDefaultCloseOperation

public int getDefaultCloseOperation()

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

Returns:

an integer indicating the window-close operation

See Also:

setDefaultCloseOperation(int)

update

public void update(java.awt.Graphics g)

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

Parameters:

g - the Graphics context in which to paint

setJMenuBar

public void setJMenuBar(JMenuBar menubar)

Sets the menubar for this frame.

Parameters:

menubar - the menubar being placed in the frame

See Also:

getJMenuBar()

getJMenuBar

public JMenuBar getJMenuBar()

Returns the menubar set on this frame.

Returns:

the menubar for this frame

See Also:

setJMenuBar(javax.swing.JMenuBar)

isRootPaneCheckingEnabled

protected boolean isRootPaneCheckingEnabled()

Returns whether calls to add and setLayout cause an exception to be thrown.

Returns:

true if add and setLayout are checked; false otherwise

See Also:

addImpl(java.awt.Component, java.lang.Object, int), setLayout(java.awt.LayoutManager), setRootPaneCheckingEnabled(boolean)

setRootPaneCheckingEnabled

protected void setRootPaneCheckingEnabled(boolean enabled)

Determines whether calls to add and setLayout will cause an exception to be thrown.

Parameters:

enabled - true if checking is to be enabled, which causes the exceptions to be thrown

See Also:

addImpl(java.awt.Component, java.lang.Object, int), setLayout(java.awt.LayoutManager), isRootPaneCheckingEnabled()

addImpl

protected void addImpl(java.awt.Component comp,
                       java.lang.Object constraints,
                       int index)

By default, children may not be added directly to this component, they must be added to its contentPane instead. For example:

 thisComponent.getContentPane().add(child)
 

An attempt to add to directly to this component will cause an runtime exception to be thrown. Subclasses can disable this behavior.

Parameters:

comp - the component to be enhanced

constraints - the constraints to be respected

index - the index

Throws:

java.lang.Error - if called with rootPaneChecking true

See Also:

setRootPaneCheckingEnabled(boolean)

remove

public void remove(java.awt.Component comp)

Removes the specified component from this container.

Parameters:

comp - the component to be removed

See Also:

Container.add(java.awt.Component)

setLayout

public void setLayout(java.awt.LayoutManager manager)

By default the layout of this component may not be set, the layout of its contentPane should be set instead. For example:

 thisComponent.getContentPane().setLayout(new GridLayout(1, 2))
 

An attempt to set the layout of this component will cause an runtime exception to be thrown. Subclasses can disable this behavior.

Parameters:

manager - the LayoutManager

Throws:

java.lang.Error - if called with rootPaneChecking true

See Also:

setRootPaneCheckingEnabled(boolean)

getRootPane

public JRootPane getRootPane()

Returns the rootPane object for this frame.

Specified by:

getRootPane in interface RootPaneContainer

Returns:

the rootPane property

See Also:

setRootPane(javax.swing.JRootPane), RootPaneContainer.getRootPane()

setRootPane

protected void setRootPane(JRootPane root)

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

Parameters:

root - the rootPane object for this frame

See Also:

getRootPane()

getContentPane

public java.awt.Container getContentPane()

Returns the contentPane object for this frame.

Specified by:

getContentPane in interface RootPaneContainer

Returns:

the contentPane property

See Also:

setContentPane(java.awt.Container), RootPaneContainer.getContentPane()

setContentPane

public void setContentPane(java.awt.Container 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.

Specified by:

setContentPane in interface RootPaneContainer

Parameters:

contentPane - the contentPane object for this frame

Throws:

java.awt.IllegalComponentStateException - (a runtime exception) if the content pane parameter is null

See Also:

getContentPane(), RootPaneContainer.setContentPane(java.awt.Container), JRootPane

getLayeredPane

public JLayeredPane getLayeredPane()

Returns the layeredPane object for this frame.

Specified by:

getLayeredPane in interface RootPaneContainer

Returns:

the layeredPane property

See Also:

setLayeredPane(javax.swing.JLayeredPane), RootPaneContainer.getLayeredPane()

setLayeredPane

public void setLayeredPane(JLayeredPane layeredPane)

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

Specified by:

setLayeredPane in interface RootPaneContainer

Parameters:

layeredPane - the layeredPane object for this frame

Throws:

java.awt.IllegalComponentStateException - (a runtime exception) if the layered pane parameter is null

See Also:

getLayeredPane(), RootPaneContainer.setLayeredPane(javax.swing.JLayeredPane)

getGlassPane

public java.awt.Component getGlassPane()

Returns the glassPane object for this frame.

Specified by:

getGlassPane in interface RootPaneContainer

Returns:

the glassPane property

See Also:

setGlassPane(java.awt.Component), RootPaneContainer.getGlassPane()

setGlassPane

public void setGlassPane(java.awt.Component glassPane)

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

Specified by:

setGlassPane in interface RootPaneContainer

Parameters:

glassPane - the glassPane object for this frame

See Also:

getGlassPane(), RootPaneContainer.setGlassPane(java.awt.Component)

paramString

protected java.lang.String paramString()

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.

Returns:

a string representation of this JFrame