|
Java™ Platform Standard Ed. 6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjava.awt.Component
java.awt.Container
java.awt.Window
java.awt.Frame
javax.swing.JFrame
public class JFrame
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.
As a conveniance add and its variants, remove and
setLayout have been overridden to forward to the
contentPane as necessary. This means you can write:
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 JavaBeansTM
has been added to the java.beans package.
Please see XMLEncoder.
JRootPane,
setDefaultCloseOperation(int),
WindowListener.windowClosing(java.awt.event.WindowEvent),
RootPaneContainer| Nested Class Summary | |
|---|---|
protected class |
JFrame.AccessibleJFrame
This class implements accessibility support for the JFrame class. |
| Nested classes/interfaces inherited from class java.awt.Frame |
|---|
Frame.AccessibleAWTFrame |
| Nested classes/interfaces inherited from class java.awt.Window |
|---|
Window.AccessibleAWTWindow |
| Nested classes/interfaces inherited from class java.awt.Container |
|---|
Container.AccessibleAWTContainer |
| Nested classes/interfaces inherited from class java.awt.Component |
|---|
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy |
| Field Summary | |
|---|---|
protected AccessibleContext |
accessibleContext
The accessible context property. |
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 be forwarded to the contentPane. |
| Fields inherited from 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 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(String title)
Creates a new, initially invisible Frame with the
specified title. |
|
JFrame(String title,
GraphicsConfiguration gc)
Creates a JFrame with the specified title and the
specified GraphicsConfiguration of a screen device. |
|
| Method Summary | |
|---|---|
protected void |
addImpl(Component comp,
Object constraints,
int index)
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 JFrames 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(WindowEvent e)
Processes window events occurring on this component. |
void |
remove(Component comp)
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 within time milliseconds. |
void |
setContentPane(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. |
static void |
setDefaultLookAndFeelDecorated(boolean defaultLookAndFeelDecorated)
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. |
void |
setGlassPane(Component glassPane)
Sets the glassPane property. |
void |
setIconImage(Image image)
Sets the image to be displayed as the icon for this window. |
void |
setJMenuBar(JMenuBar menubar)
Sets the menubar for this frame. |
void |
setLayeredPane(JLayeredPane layeredPane)
Sets the layeredPane property. |
void |
setLayout(LayoutManager manager)
Sets the LayoutManager. |
protected void |
setRootPane(JRootPane root)
Sets the rootPane property. |
protected void |
setRootPaneCheckingEnabled(boolean enabled)
Sets whether calls to add and
setLayout are forwarded to the contentPane. |
void |
setTransferHandler(TransferHandler newHandler)
Sets the transferHandler property, which is a mechanism to
support transfer of data into this component. |
void |
update(Graphics g)
Just calls paint(g). |
| Methods inherited from 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 inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface java.awt.MenuContainer |
|---|
getFont, postEvent |
| Field Detail |
|---|
public static final int EXIT_ON_CLOSE
SecurityException may be thrown.
It is recommended you only use this in an application.
protected JRootPane rootPane
JRootPane instance that manages the
contentPane
and optional menuBar for this frame, as well as the
glassPane.
JRootPane,
RootPaneContainerprotected 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.
isRootPaneCheckingEnabled(),
setRootPaneCheckingEnabled(boolean),
RootPaneContainerprotected AccessibleContext accessibleContext
| Constructor Detail |
|---|
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.GraphicsEnvironment.isHeadless(),
Component.setSize(int, int),
Component.setVisible(boolean),
JComponent.getDefaultLocale()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 assumed
IllegalArgumentException - if gc is not from
a screen device. This exception is always thrown when
GraphicsEnvironment.isHeadless() returns true.GraphicsEnvironment.isHeadless(),
JComponent.getDefaultLocale()
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 frame
HeadlessException - if GraphicsEnvironment.isHeadless()
returns true.GraphicsEnvironment.isHeadless(),
Component.setSize(int, int),
Component.setVisible(boolean),
JComponent.getDefaultLocale()
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 assumed
IllegalArgumentException - if gc is not from
a screen device. This exception is always thrown when
GraphicsEnvironment.isHeadless() returns true.GraphicsEnvironment.isHeadless(),
JComponent.getDefaultLocale()| Method Detail |
|---|
protected void frameInit()
JFrame properly.
protected JRootPane createRootPane()
rootPane.
protected void processWindowEvent(WindowEvent e)
defaultCloseOperation property.
processWindowEvent in class Windowe - the window eventsetDefaultCloseOperation(int),
Window.processWindowEvent(java.awt.event.WindowEvent)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 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.
operation - the operation which should be performed when the
user closes the frame
IllegalArgumentException - if defaultCloseOperation value
isn't one of the above valid values
SecurityException - if EXIT_ON_CLOSE has been specified and the
SecurityManager will
not allow the caller to invoke System.exitWindow.addWindowListener(java.awt.event.WindowListener),
getDefaultCloseOperation(),
WindowConstants,
Runtime.exit(int)public int getDefaultCloseOperation()
setDefaultCloseOperation(int)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 TransferHandlerTransferHandler,
getTransferHandler(),
Component.setDropTarget(java.awt.dnd.DropTarget)public TransferHandler getTransferHandler()
transferHandler property.
transferHandler propertyTransferHandler,
setTransferHandler(javax.swing.TransferHandler)public void update(Graphics g)
paint(g). This method was overridden to
prevent an unnecessary call to clear the background.
update in class Containerg - the Graphics context in which to paintComponent.update(Graphics)public void setJMenuBar(JMenuBar menubar)
menubar - the menubar being placed in the framegetJMenuBar()public JMenuBar getJMenuBar()
setJMenuBar(javax.swing.JMenuBar)protected boolean isRootPaneCheckingEnabled()
add and
setLayout are forwarded to the contentPane.
add and setLayout
are fowarded; false otherwiseaddImpl(java.awt.Component, java.lang.Object, int),
setLayout(java.awt.LayoutManager),
setRootPaneCheckingEnabled(boolean),
RootPaneContainerprotected 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.addImpl(java.awt.Component, java.lang.Object, int),
setLayout(java.awt.LayoutManager),
isRootPaneCheckingEnabled(),
RootPaneContainer
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 Containercomp - the component to be enhancedconstraints - the constraints to be respectedindex - the index
IllegalArgumentException - if index is invalid
IllegalArgumentException - if adding the container's parent
to itself
IllegalArgumentException - if adding a window to a containersetRootPaneCheckingEnabled(boolean),
RootPaneContainerpublic 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 Containercomp - the component to be removed
NullPointerException - if comp is nullContainer.add(java.awt.Component),
RootPaneContainerpublic void setLayout(LayoutManager manager)
LayoutManager.
Overridden to conditionally forward the call to the
contentPane.
Refer to RootPaneContainer for
more information.
setLayout in class Containermanager - the LayoutManagersetRootPaneCheckingEnabled(boolean),
RootPaneContainerpublic JRootPane getRootPane()
rootPane object for this frame.
getRootPane in interface RootPaneContainerrootPane propertysetRootPane(javax.swing.JRootPane),
RootPaneContainer.getRootPane()protected void setRootPane(JRootPane root)
rootPane property.
This method is called by the constructor.
root - the rootPane object for this framegetRootPane()public void setIconImage(Image image)
This method can be used instead of setIconImages()
to specify a single image as a window's icon.
The following statement:
setIconImage(image);
is equivalent to:
ArrayList imageList = new ArrayList();
imageList.add(image);
setIconImages(imageList);
Note : Native windowing systems may use different images of differing dimensions to represent a window, depending on the context (e.g. window decoration, window list, taskbar, etc.). They could also use just a single image for all contexts or no image at all.
setIconImage in class Frameimage - the icon image to be displayed.Window.setIconImages(java.util.List extends java.awt.Image>),
Window.getIconImages()public Container getContentPane()
contentPane object for this frame.
getContentPane in interface RootPaneContainercontentPane propertysetContentPane(java.awt.Container),
RootPaneContainer.getContentPane()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 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.
setContentPane in interface RootPaneContainercontentPane - the contentPane object for this frame
IllegalComponentStateException - (a runtime
exception) if the content pane parameter is nullgetContentPane(),
RootPaneContainer.setContentPane(java.awt.Container),
JRootPanepublic JLayeredPane getLayeredPane()
layeredPane object for this frame.
getLayeredPane in interface RootPaneContainerlayeredPane propertysetLayeredPane(javax.swing.JLayeredPane),
RootPaneContainer.getLayeredPane()public void setLayeredPane(JLayeredPane layeredPane)
layeredPane property.
This method is called by the constructor.
setLayeredPane in interface RootPaneContainerlayeredPane - the layeredPane object for this frame
IllegalComponentStateException - (a runtime
exception) if the layered pane parameter is nullgetLayeredPane(),
RootPaneContainer.setLayeredPane(javax.swing.JLayeredPane)public Component getGlassPane()
glassPane object for this frame.
getGlassPane in interface RootPaneContainerglassPane propertysetGlassPane(java.awt.Component),
RootPaneContainer.getGlassPane()public void setGlassPane(Component glassPane)
glassPane property.
This method is called by the constructor.
setGlassPane in interface RootPaneContainerglassPane - the glassPane object for this framegetGlassPane(),
RootPaneContainer.setGlassPane(java.awt.Component)public Graphics getGraphics()
null if this component is currently not
displayable.
getGraphics in class Componentnull
if it has noneComponent.paint(java.awt.Graphics)
public 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.
repaint in class Componenttime - maximum time in milliseconds before updatex - the x coordinatey - the y coordinatewidth - the widthheight - the heightRepaintManagerpublic static void setDefaultLookAndFeelDecorated(boolean defaultLookAndFeelDecorated)
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);
defaultLookAndFeelDecorated - A hint as to whether or not current
look and feel should provide window decorationsLookAndFeel.getSupportsWindowDecorations()public static boolean isDefaultLookAndFeelDecorated()
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 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 FrameJFramepublic AccessibleContext getAccessibleContext()
getAccessibleContext in interface AccessiblegetAccessibleContext in class Frame
|
Java™ Platform Standard Ed. 6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright © 1993, 2010, Oracle and/or its affiliates. All rights reserved.