ImageObserver
, MenuContainer
, Serializable
, Accessible
, RootPaneContainer
, WindowConstants
@JavaBean(defaultProperty="JMenuBar", description="A toplevel window which can be minimized to an icon.") public class JFrame extends Frame implements WindowConstants, Accessible, RootPaneContainer
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. As a convenience, the add
, remove
, and setLayout
methods of this class are overridden, so that they delegate calls to the corresponding methods of the ContentPane
. For example, you can add a child component to a frame as follows:
frame.add(child);And the child will be added to the contentPane. 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. Refer to
RootPaneContainer
for details on adding, removing and setting the LayoutManager
of a JFrame
. 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: 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 JavaBeans has been added to the java.beans
package. Please see XMLEncoder
.
Modifier and Type | Class | Description |
---|---|---|
protected class |
JFrame.AccessibleJFrame |
This class implements accessibility support for the JFrame class. |
Frame.AccessibleAWTFrame
Window.AccessibleAWTWindow, Window.Type
Container.AccessibleAWTContainer
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
Modifier and Type | Field | Description |
---|---|---|
protected AccessibleContext |
accessibleContext |
The accessible context property. |
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 be forwarded to the contentPane . |
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
Constructor | Description |
---|---|
JFrame() |
Constructs a new frame that is initially invisible. |
JFrame |
Creates a Frame in the specified GraphicsConfiguration of a screen device and a blank title. |
JFrame |
Creates a new, initially invisible Frame with the specified title. |
JFrame |
Creates a JFrame with the specified title and the specified GraphicsConfiguration of a screen device. |
Modifier and Type | Method | Description |
---|---|---|
protected void |
addImpl |
Adds the specified child Component . |
protected JRootPane |
createRootPane() |
Called by the constructor methods to create the default rootPane . |
protected void |
frameInit() |
Called by the constructors to init the JFrame properly. |
AccessibleContext |
getAccessibleContext() |
Gets the AccessibleContext associated with this JFrame. |
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. |
Component |
getGlassPane() |
Returns the glassPane object for this frame. |
Graphics |
getGraphics() |
Creates a graphics context for this component. |
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. |
TransferHandler |
getTransferHandler() |
Gets the transferHandler property. |
static boolean |
isDefaultLookAndFeelDecorated() |
Returns true if newly created JFrame s should have their Window decorations provided by the current look and feel. |
protected boolean |
isRootPaneCheckingEnabled() |
Returns whether calls to add and setLayout are forwarded to the contentPane . |
protected String |
paramString() |
Returns a string representation of this JFrame . |
protected void |
processWindowEvent |
Processes window events occurring on this component. |
void |
remove |
Removes the specified component from the container. |
void |
repaint |
Repaints the specified rectangle of this component within time milliseconds. |
void |
setContentPane |
Sets the contentPane property. |
void |
setDefaultCloseOperation |
Sets the operation that will happen by default when the user initiates a "close" on this frame. |
static void |
setDefaultLookAndFeelDecorated |
Provides a hint as to whether or not newly created JFrame s should have their Window decorations (such as borders, widgets to close the window, title...) provided by the current look and feel. |
void |
setGlassPane |
Sets the glassPane property. |
void |
setJMenuBar |
Sets the menubar for this frame. |
void |
setLayeredPane |
Sets the layeredPane property. |
void |
setLayout |
Sets the LayoutManager . |
protected void |
setRootPane |
Sets the rootPane property. |
protected void |
setRootPaneCheckingEnabled |
Sets whether calls to add and setLayout are forwarded to the contentPane . |
void |
setTransferHandler |
Sets the transferHandler property, which is a mechanism to support transfer of data into this component. |
void |
update |
Just calls paint(g) . |
addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBackground, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setOpacity, setShape, setSize, setSize, setType, setVisible, show, toBack, toFront
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getFont, postEvent
protected JRootPane rootPane
JRootPane
instance that manages the contentPane
and optional menuBar
for this frame, as well as the glassPane
.protected boolean rootPaneCheckingEnabled
add
and setLayout
will be forwarded to the contentPane
. This is initially false, but is set to true when the JFrame
is constructed.protected AccessibleContext accessibleContext
public JFrame() throws HeadlessException
This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale
.
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true.public JFrame(GraphicsConfiguration gc)
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
.
gc
- the GraphicsConfiguration
that is used to construct the new Frame
; if gc
is null
, the system default GraphicsConfiguration
is assumedIllegalArgumentException
- if gc
is not from a screen device. This exception is always thrown when GraphicsEnvironment.isHeadless() returns true.public JFrame(String title) throws HeadlessException
Frame
with the specified title. This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale
.
title
- the title for the frameHeadlessException
- if GraphicsEnvironment.isHeadless() returns true.public JFrame(String title, GraphicsConfiguration gc)
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
.
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 assumedIllegalArgumentException
- if gc
is not from a screen device. This exception is always thrown when GraphicsEnvironment.isHeadless() returns true.protected void frameInit()
JFrame
properly.protected JRootPane createRootPane()
rootPane
.JRootPane
protected void processWindowEvent(WindowEvent e)
defaultCloseOperation
property.processWindowEvent
in class Window
e
- the window event@BeanProperty(preferred=true, enumerationValues={"WindowConstants.DO_NOTHING_ON_CLOSE","WindowConstants.HIDE_ON_CLOSE","WindowConstants.DISPOSE_ON_CLOSE","WindowConstants.EXIT_ON_CLOSE"}, description="The frame\'s default close operation.") public void setDefaultCloseOperation(int operation)
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 WindowConstants
): 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.
operation
- the operation which should be performed when the user closes the frameIllegalArgumentException
- if defaultCloseOperation value isn't one of the above valid valuesSecurityException
- if EXIT_ON_CLOSE
has been specified and the SecurityManager
will not allow the caller to invoke System.exit
public int getDefaultCloseOperation()
@BeanProperty(hidden=true, description="Mechanism for transfer of data into the component") public void setTransferHandler(TransferHandler newHandler)
transferHandler
property, which is a mechanism to support transfer of data into this component. Use null
if the component does not support data transfer operations. If the system property suppressSwingDropSupport
is false
(the default) and the current drop target on this component is either null
or not a user-set drop target, this method will change the drop target as follows: If newHandler
is null
it will clear the drop target. If not null
it will install a new DropTarget
.
Note: When used with JFrame
, TransferHandler
only provides data import capability, as the data export related methods are currently typed to JComponent
.
Please see How to Use Drag and Drop and Data Transfer, a section in The Java Tutorial, for more information.
newHandler
- the new TransferHandler
public TransferHandler getTransferHandler()
transferHandler
property.transferHandler
propertypublic void update(Graphics g)
paint(g)
. This method was overridden to prevent an unnecessary call to clear the background.@BeanProperty(bound=false, hidden=true, description="The menubar for accessing pulldown menus from this frame.") public void setJMenuBar(JMenuBar menubar)
menubar
- the menubar being placed in the framepublic JMenuBar getJMenuBar()
protected boolean isRootPaneCheckingEnabled()
add
and setLayout
are forwarded to the contentPane
.add
and setLayout
are forwarded; false otherwise@BeanProperty(hidden=true, description="Whether the add and setLayout methods are forwarded") protected void setRootPaneCheckingEnabled(boolean enabled)
add
and setLayout
are forwarded to the contentPane
.enabled
- true if add
and setLayout
are forwarded, false if they should operate directly on the JFrame
.protected void addImpl(Component comp, Object constraints, int index)
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 RootPaneContainer
for details.addImpl
in class Container
comp
- the component to be enhancedconstraints
- the constraints to be respectedindex
- the indexIllegalArgumentException
- if index
is invalidIllegalArgumentException
- if adding the container's parent to itselfIllegalArgumentException
- if adding a window to a containerpublic void remove(Component comp)
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
.remove
in class Container
comp
- the component to be removedNullPointerException
- if comp
is nullpublic void setLayout(LayoutManager manager)
LayoutManager
. Overridden to conditionally forward the call to the contentPane
. Refer to RootPaneContainer
for more information.@BeanProperty(bound=false, hidden=true, description="the RootPane object for this frame.") public JRootPane getRootPane()
rootPane
object for this frame.getRootPane
in interface RootPaneContainer
rootPane
propertyprotected void setRootPane(JRootPane root)
rootPane
property. This method is called by the constructor.root
- the rootPane
object for this framepublic Container getContentPane()
contentPane
object for this frame.getContentPane
in interface RootPaneContainer
contentPane
property@BeanProperty(bound=false, hidden=true, description="The client area of the frame where child components are normally inserted.") public void setContentPane(Container contentPane)
contentPane
property. This method is called by the constructor. Swing's painting architecture requires an opaque JComponent
in the containment hierarchy. This is typically provided by the content pane. If you replace the content pane it is recommended you replace it with an opaque JComponent
.
setContentPane
in interface RootPaneContainer
contentPane
- the contentPane
object for this frameIllegalComponentStateException
- (a runtime exception) if the content pane parameter is null
public JLayeredPane getLayeredPane()
layeredPane
object for this frame.getLayeredPane
in interface RootPaneContainer
layeredPane
property@BeanProperty(bound=false, hidden=true, description="The pane that holds the various frame layers.") public void setLayeredPane(JLayeredPane layeredPane)
layeredPane
property. This method is called by the constructor.setLayeredPane
in interface RootPaneContainer
layeredPane
- the layeredPane
object for this frameIllegalComponentStateException
- (a runtime exception) if the layered pane parameter is null
public Component getGlassPane()
glassPane
object for this frame.getGlassPane
in interface RootPaneContainer
glassPane
property@BeanProperty(bound=false, hidden=true, description="A transparent pane used for menu rendering.") public void setGlassPane(Component glassPane)
glassPane
property. This method is called by the constructor.setGlassPane
in interface RootPaneContainer
glassPane
- the glassPane
object for this frame@BeanProperty(bound=false) public Graphics getGraphics()
null
if this component is currently not displayable.getGraphics
in class Component
null
if it has nonepublic void repaint(long time, int x, int y, int width, int height)
time
milliseconds. Refer to RepaintManager
for details on how the repaint is handled.public static void setDefaultLookAndFeelDecorated(boolean defaultLookAndFeelDecorated)
JFrame
s 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 JFrame
s will have their Window decorations provided by the current LookAndFeel
. Otherwise, newly created JFrame
s 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);
defaultLookAndFeelDecorated
- A hint as to whether or not current look and feel should provide window decorationspublic static boolean isDefaultLookAndFeelDecorated()
JFrame
s 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 String paramString()
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
.paramString
in class Frame
JFrame
public AccessibleContext getAccessibleContext()
getAccessibleContext
in interface Accessible
getAccessibleContext
in class Frame
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/JFrame.html