Class JFrame
- All Implemented Interfaces:
ImageObserver
,MenuContainer
,Serializable
,Accessible
,RootPaneContainer
,WindowConstants
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
.
- Since:
- 1.2
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionprotected class
This class implements accessibility support for theJFrame
class.Nested classes/interfaces declared in class java.awt.Frame
Frame.AccessibleAWTFrame
Nested classes/interfaces declared in class java.awt.Window
Window.AccessibleAWTWindow, Window.Type
Nested classes/interfaces declared in class java.awt.Container
Container.AccessibleAWTContainer
Nested classes/interfaces declared in class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
Field Summary
Modifier and TypeFieldDescriptionprotected AccessibleContext
The accessible context property.protected JRootPane
TheJRootPane
instance that manages thecontentPane
and optionalmenuBar
for this frame, as well as theglassPane
.protected boolean
If true then calls toadd
andsetLayout
will be forwarded to thecontentPane
.Fields declared in class java.awt.Frame
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
Fields declared in class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Fields declared in interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Fields declared in interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
-
Constructor Summary
ConstructorDescriptionJFrame()
Constructs a new frame that is initially invisible.Creates aFrame
in the specifiedGraphicsConfiguration
of a screen device and a blank title.Creates a new, initially invisibleFrame
with the specified title.JFrame
(String title, GraphicsConfiguration gc) Creates aJFrame
with the specified title and the specifiedGraphicsConfiguration
of a screen device. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
Adds the specified childComponent
.protected JRootPane
Called by the constructor methods to create the defaultrootPane
.protected void
Called by the constructors to init theJFrame
properly.Gets the AccessibleContext associated with this JFrame.Returns thecontentPane
object for this frame.int
Returns the operation that occurs when the user initiates a "close" on this frame.Returns theglassPane
object for this frame.Creates a graphics context for this component.Returns the menubar set on this frame.Returns thelayeredPane
object for this frame.Returns therootPane
object for this frame.Gets thetransferHandler
property.static boolean
Returns true if newly createdJFrame
s should have their Window decorations provided by the current look and feel.protected boolean
Returns whether calls toadd
andsetLayout
are forwarded to thecontentPane
.protected String
Returns a string representation of thisJFrame
.protected void
Processes window events occurring on this component.void
Removes the specified component from the container.void
repaint
(long time, int x, int y, int width, int height) Repaints the specified rectangle of this component withintime
milliseconds.void
setContentPane
(Container contentPane) Sets thecontentPane
property.void
setDefaultCloseOperation
(int operation) Sets the operation that will happen by default when the user initiates a "close" on this frame.static void
setDefaultLookAndFeelDecorated
(boolean defaultLookAndFeelDecorated) Provides a hint as to whether or not newly createdJFrame
s should have their Window decorations (such as borders, widgets to close the window, title...) provided by the current look and feel.void
setGlassPane
(Component glassPane) Sets theglassPane
property.void
setJMenuBar
(JMenuBar menubar) Sets the menubar for this frame.void
setLayeredPane
(JLayeredPane layeredPane) Sets thelayeredPane
property.void
setLayout
(LayoutManager manager) Sets theLayoutManager
.protected void
setRootPane
(JRootPane root) Sets therootPane
property.protected void
setRootPaneCheckingEnabled
(boolean enabled) Sets whether calls toadd
andsetLayout
are forwarded to thecontentPane
.void
setTransferHandler
(TransferHandler newHandler) Sets thetransferHandler
property, which is a mechanism to support transfer of data into this component.void
Just callspaint(g)
.Methods declared in class java.awt.Frame
addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated
Methods declared in class java.awt.Window
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
Methods declared in class java.awt.Container
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
Methods declared in class java.awt.Component
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
Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods declared in interface java.awt.MenuContainer
getFont, postEvent
-
Field Details
-
rootPane
TheJRootPane
instance that manages thecontentPane
and optionalmenuBar
for this frame, as well as theglassPane
.- See Also:
-
rootPaneCheckingEnabled
protected boolean rootPaneCheckingEnabledIf true then calls toadd
andsetLayout
will be forwarded to thecontentPane
. This is initially false, but is set to true when theJFrame
is constructed.- See Also:
-
accessibleContext
The accessible context property.
-
-
Constructor Details
-
JFrame
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.- See Also:
-
JFrame
Creates aFrame
in the specifiedGraphicsConfiguration
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
- theGraphicsConfiguration
that is used to construct the newFrame
; ifgc
isnull
, the system defaultGraphicsConfiguration
is assumed- Throws:
IllegalArgumentException
- ifgc
is not from a screen device. This exception is always thrown when GraphicsEnvironment.isHeadless() returns true.- Since:
- 1.3
- See Also:
-
JFrame
Creates a new, initially invisibleFrame
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.- See Also:
-
JFrame
Creates aJFrame
with the specified title and the specifiedGraphicsConfiguration
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. Anull
value is treated as an empty string, "".gc
- theGraphicsConfiguration
that is used to construct the newJFrame
with; ifgc
isnull
, the system defaultGraphicsConfiguration
is assumed- Throws:
IllegalArgumentException
- ifgc
is not from a screen device. This exception is always thrown when GraphicsEnvironment.isHeadless() returns true.- Since:
- 1.3
- See Also:
-
-
Method Details
-
frameInit
protected void frameInit()Called by the constructors to init theJFrame
properly. -
createRootPane
Called by the constructor methods to create the defaultrootPane
.- Returns:
- a new
JRootPane
-
processWindowEvent
Processes window events occurring on this component. Hides the window or disposes of it, as specified by the setting of thedefaultCloseOperation
property.- Overrides:
processWindowEvent
in classWindow
- Parameters:
e
- the window event- See Also:
-
setDefaultCloseOperation
@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) 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 inWindowConstants
): Don't do anything; require the program to handle the operation in thewindowClosing
method of a registeredWindowListener
object.HIDE_ON_CLOSE
(defined inWindowConstants
): Automatically hide the frame after invoking any registeredWindowListener
objects.DISPOSE_ON_CLOSE
(defined inWindowConstants
): Automatically hide and dispose the frame after invoking any registeredWindowListener
objects.EXIT_ON_CLOSE
(defined inWindowConstants
): Exit the application using theSystem
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.
- Parameters:
operation
- the operation which should be performed when the user closes the frame- Throws:
IllegalArgumentException
- if defaultCloseOperation value isn't one of the above valid values- See Also:
-
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:
-
setTransferHandler
@BeanProperty(hidden=true, description="Mechanism for transfer of data into the component") public void setTransferHandler(TransferHandler newHandler) Sets thetransferHandler
property, which is a mechanism to support transfer of data into this component. Usenull
if the component does not support data transfer operations.If the system property
suppressSwingDropSupport
isfalse
(the default) and the current drop target on this component is eithernull
or not a user-set drop target, this method will change the drop target as follows: IfnewHandler
isnull
it will clear the drop target. If notnull
it will install a newDropTarget
.Note: When used with
JFrame
,TransferHandler
only provides data import capability, as the data export related methods are currently typed toJComponent
.Please see How to Use Drag and Drop and Data Transfer, a section in The Java Tutorial, for more information.
- Parameters:
newHandler
- the newTransferHandler
- Since:
- 1.6
- See Also:
-
getTransferHandler
Gets thetransferHandler
property.- Returns:
- the value of the
transferHandler
property - Since:
- 1.6
- See Also:
-
update
-
setJMenuBar
@BeanProperty(bound=false, hidden=true, description="The menubar for accessing pulldown menus from this frame.") public void setJMenuBar(JMenuBar menubar) Sets the menubar for this frame.- Parameters:
menubar
- the menubar being placed in the frame- See Also:
-
getJMenuBar
Returns the menubar set on this frame.- Returns:
- the menubar for this frame
- See Also:
-
isRootPaneCheckingEnabled
protected boolean isRootPaneCheckingEnabled()Returns whether calls toadd
andsetLayout
are forwarded to thecontentPane
.- Returns:
- true if
add
andsetLayout
are forwarded; false otherwise - See Also:
-
setRootPaneCheckingEnabled
@BeanProperty(hidden=true, description="Whether the add and setLayout methods are forwarded") protected void setRootPaneCheckingEnabled(boolean enabled) Sets whether calls toadd
andsetLayout
are forwarded to thecontentPane
.- Parameters:
enabled
- true ifadd
andsetLayout
are forwarded, false if they should operate directly on theJFrame
.- See Also:
-
addImpl
Adds the specified childComponent
. This method is overridden to conditionally forward calls to thecontentPane
. By default, children are added to thecontentPane
instead of the frame, refer toRootPaneContainer
for details.- Overrides:
addImpl
in classContainer
- Parameters:
comp
- the component to be enhancedconstraints
- the constraints to be respectedindex
- the index- Throws:
IllegalArgumentException
- ifindex
is invalidIllegalArgumentException
- if adding the container's parent to itselfIllegalArgumentException
- if adding a window to a container- See Also:
-
remove
Removes the specified component from the container. Ifcomp
is not therootPane
, this will forward the call to thecontentPane
. This will do nothing ifcomp
is not a child of theJFrame
orcontentPane
.- Overrides:
remove
in classContainer
- Parameters:
comp
- the component to be removed- Throws:
NullPointerException
- ifcomp
is null- See Also:
-
setLayout
Sets theLayoutManager
. Overridden to conditionally forward the call to thecontentPane
. Refer toRootPaneContainer
for more information. -
getRootPane
@BeanProperty(bound=false, hidden=true, description="the RootPane object for this frame.") public JRootPane getRootPane()Returns therootPane
object for this frame.- Specified by:
getRootPane
in interfaceRootPaneContainer
- Returns:
- the
rootPane
property - See Also:
-
setRootPane
Sets therootPane
property. This method is called by the constructor.- Parameters:
root
- therootPane
object for this frame- See Also:
-
getContentPane
Returns thecontentPane
object for this frame.- Specified by:
getContentPane
in interfaceRootPaneContainer
- Returns:
- the
contentPane
property - See Also:
-
setContentPane
@BeanProperty(bound=false, hidden=true, description="The client area of the frame where child components are normally inserted.") public void setContentPane(Container contentPane) Sets thecontentPane
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 opaqueJComponent
.- Specified by:
setContentPane
in interfaceRootPaneContainer
- Parameters:
contentPane
- thecontentPane
object for this frame- Throws:
IllegalComponentStateException
- (a runtime exception) if the content pane parameter isnull
- See Also:
-
getLayeredPane
Returns thelayeredPane
object for this frame.- Specified by:
getLayeredPane
in interfaceRootPaneContainer
- Returns:
- the
layeredPane
property - See Also:
-
setLayeredPane
@BeanProperty(bound=false, hidden=true, description="The pane that holds the various frame layers.") public void setLayeredPane(JLayeredPane layeredPane) Sets thelayeredPane
property. This method is called by the constructor.- Specified by:
setLayeredPane
in interfaceRootPaneContainer
- Parameters:
layeredPane
- thelayeredPane
object for this frame- Throws:
IllegalComponentStateException
- (a runtime exception) if the layered pane parameter isnull
- See Also:
-
getGlassPane
Returns theglassPane
object for this frame.- Specified by:
getGlassPane
in interfaceRootPaneContainer
- Returns:
- the
glassPane
property - See Also:
-
setGlassPane
@BeanProperty(bound=false, hidden=true, description="A transparent pane used for menu rendering.") public void setGlassPane(Component glassPane) Sets theglassPane
property. This method is called by the constructor.- Specified by:
setGlassPane
in interfaceRootPaneContainer
- Parameters:
glassPane
- theglassPane
object for this frame- See Also:
-
getGraphics
Creates a graphics context for this component. This method will returnnull
if this component is currently not displayable.- Overrides:
getGraphics
in classComponent
- Returns:
- a graphics context for this component, or
null
if it has none - Since:
- 1.6
- See Also:
-
repaint
public void repaint(long time, int x, int y, int width, int height) Repaints the specified rectangle of this component withintime
milliseconds. Refer toRepaintManager
for details on how the repaint is handled. -
setDefaultLookAndFeelDecorated
public static void setDefaultLookAndFeelDecorated(boolean defaultLookAndFeelDecorated) Provides a hint as to whether or not newly createdJFrame
s should have their Window decorations (such as borders, widgets to close the window, title...) provided by the current look and feel. IfdefaultLookAndFeelDecorated
is true, the currentLookAndFeel
supports providing window decorations, and the current window manager supports undecorated windows, then newly createdJFrame
s will have their Window decorations provided by the currentLookAndFeel
. Otherwise, newly createdJFrame
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);
- Parameters:
defaultLookAndFeelDecorated
- A hint as to whether or not current look and feel should provide window decorations- Since:
- 1.4
- See Also:
-
isDefaultLookAndFeelDecorated
public static boolean isDefaultLookAndFeelDecorated()Returns true if newly createdJFrame
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.- Returns:
- true if look and feel should provide Window decorations.
- Since:
- 1.4
-
paramString
Returns a string representation of thisJFrame
. 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 benull
.- Overrides:
paramString
in classFrame
- Returns:
- a string representation of this
JFrame
-
getAccessibleContext
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.- Specified by:
getAccessibleContext
in interfaceAccessible
- Overrides:
getAccessibleContext
in classFrame
- Returns:
- an AccessibleJFrame that serves as the AccessibleContext of this JFrame
-