public class

JFrame

extends Frame
implements Accessible RootPaneContainer WindowConstants

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

Known Direct Subclasses

InputMethodJFrame, JConsole

Class Overview

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 JavaBeans^TM has been added to the java.beans package. Please see XMLEncoder.

Summary

Nested Classes
class	JFrame.AccessibleJFrame	This class implements accessibility support for the `JFrame` class.

Constants
int	EXIT_ON_CLOSE	The exit application default window close operation.

[Expand]

Inherited Constants

From class java.awt.Frame

int	CROSSHAIR_CURSOR	This constant is deprecated. replaced by `Cursor.CROSSHAIR_CURSOR`.
int	DEFAULT_CURSOR	This constant is deprecated. replaced by `Cursor.DEFAULT_CURSOR`.
int	E_RESIZE_CURSOR	This constant is deprecated. replaced by `Cursor.E_RESIZE_CURSOR`.
int	HAND_CURSOR	This constant is deprecated. replaced by `Cursor.HAND_CURSOR`.
int	ICONIFIED	This state bit indicates that frame is iconified.
int	MAXIMIZED_BOTH	This state bit mask indicates that frame is fully maximized (that is both horizontally and vertically).
int	MAXIMIZED_HORIZ	This state bit indicates that frame is maximized in the horizontal direction.
int	MAXIMIZED_VERT	This state bit indicates that frame is maximized in the vertical direction.
int	MOVE_CURSOR	This constant is deprecated. replaced by `Cursor.MOVE_CURSOR`.
int	NE_RESIZE_CURSOR	This constant is deprecated. replaced by `Cursor.NE_RESIZE_CURSOR`.
int	NORMAL	Frame is in the "normal" state.
int	NW_RESIZE_CURSOR	This constant is deprecated. replaced by `Cursor.NW_RESIZE_CURSOR`.
int	N_RESIZE_CURSOR	This constant is deprecated. replaced by `Cursor.N_RESIZE_CURSOR`.
int	SE_RESIZE_CURSOR	This constant is deprecated. replaced by `Cursor.SE_RESIZE_CURSOR`.
int	SW_RESIZE_CURSOR	This constant is deprecated. replaced by `Cursor.SW_RESIZE_CURSOR`.
int	S_RESIZE_CURSOR	This constant is deprecated. replaced by `Cursor.S_RESIZE_CURSOR`.
int	TEXT_CURSOR	This constant is deprecated. replaced by `Cursor.TEXT_CURSOR`.
int	WAIT_CURSOR	This constant is deprecated. replaced by `Cursor.WAIT_CURSOR`.
int	W_RESIZE_CURSOR	This constant is deprecated. replaced by `Cursor.W_RESIZE_CURSOR`.

From class java.awt.Component

From interface java.awt.image.ImageObserver

From interface javax.swing.WindowConstants

Fields
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`.

Public Constructors
	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.

Public Methods
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.
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 `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(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`.
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)`.

Protected Methods
void	addImpl(Component comp, Object constraints, int index) Adds the specified child `Component`.
JRootPane	createRootPane() Called by the constructor methods to create the default `rootPane`.
void	frameInit() Called by the constructors to init the `JFrame` properly.
boolean	isRootPaneCheckingEnabled() Returns whether calls to `add` and `setLayout` are forwarded to the `contentPane`.
String	paramString() Returns a string representation of this `JFrame`.
void	processWindowEvent(WindowEvent e) Processes window events occurring on this component.
void	setRootPane(JRootPane root) Sets the `rootPane` property.
void	setRootPaneCheckingEnabled(boolean enabled) Sets whether calls to `add` and `setLayout` are forwarded to the `contentPane`.

[Expand]

Inherited Methods

From class java.awt.Frame

void	addNotify() Makes this Frame displayable by connecting it to a native screen resource.
AccessibleContext	getAccessibleContext() Gets the AccessibleContext associated with this Frame.
int	getCursorType() This method is deprecated. As of JDK version 1.1, replaced by `Component.getCursor()`.
synchronized int	getExtendedState() Gets the state of this frame.
static Frame[]	getFrames() Returns an array of all `Frame`s created by this application.
Image	getIconImage() Returns the image to be displayed as the icon for this frame.
Rectangle	getMaximizedBounds() Gets maximized bounds for this frame.
MenuBar	getMenuBar() Gets the menu bar for this frame.
synchronized int	getState() Gets the state of this frame (obsolete).
String	getTitle() Gets the title of the frame.
boolean	isResizable() Indicates whether this frame is resizable by the user.
boolean	isUndecorated() Indicates whether this frame is undecorated.
String	paramString() Returns a string representing the state of this `Frame`.
void	remove(MenuComponent m) Removes the specified menu bar from this frame.
void	removeNotify() Makes this Frame undisplayable by removing its connection to its native screen resource.
void	setCursor(int cursorType) This method is deprecated. As of JDK version 1.1, replaced by `Component.setCursor(Cursor)`.
synchronized void	setExtendedState(int state) Sets the state of this frame.
void	setIconImage(Image image) Sets the image to be displayed as the icon for this window.
synchronized void	setMaximizedBounds(Rectangle bounds) Sets the maximized bounds for this frame.
void	setMenuBar(MenuBar mb) Sets the menu bar for this frame to the specified menu bar.
void	setResizable(boolean resizable) Sets whether this frame is resizable by the user.
synchronized void	setState(int state) Sets the state of this frame (obsolete).
void	setTitle(String title) Sets the title for this frame to the specified string.
void	setUndecorated(boolean undecorated) Disables or enables decorations for this frame.

From class java.awt.Window

void	addNotify() Makes this Window displayable by creating the connection to its native screen resource.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener) Adds a PropertyChangeListener to the listener list for a specific property.
void	addPropertyChangeListener(PropertyChangeListener listener) Adds a PropertyChangeListener to the listener list.
synchronized void	addWindowFocusListener(WindowFocusListener l) Adds the specified window focus listener to receive window events from this window.
synchronized void	addWindowListener(WindowListener l) Adds the specified window listener to receive window events from this window.
synchronized void	addWindowStateListener(WindowStateListener l) Adds the specified window state listener to receive window events from this window.
void	applyResourceBundle(ResourceBundle rb) This method is deprecated. As of J2SE 1.4, replaced by `Component.applyComponentOrientation`.
void	applyResourceBundle(String rbName) This method is deprecated. As of J2SE 1.4, replaced by `Component.applyComponentOrientation`.
void	createBufferStrategy(int numBuffers) Creates a new strategy for multi-buffering on this component.
void	createBufferStrategy(int numBuffers, BufferCapabilities caps) Creates a new strategy for multi-buffering on this component with the required buffer capabilities.
void	dispose() Releases all of the native screen resources used by this `Window`, its subcomponents, and all of its owned children.
AccessibleContext	getAccessibleContext() Gets the AccessibleContext associated with this Window.
BufferStrategy	getBufferStrategy() Returns the `BufferStrategy` used by this component.
final Container	getFocusCycleRootAncestor() Always returns `null` because Windows have no ancestors; they represent the top of the Component hierarchy.
Component	getFocusOwner() Returns the child Component of this Window that has focus if this Window is focused; returns null otherwise.
Set<AWTKeyStroke>	getFocusTraversalKeys(int id) Gets a focus traversal key for this Window.
boolean	getFocusableWindowState() Returns whether this Window can become the focused Window if it meets the other requirements outlined in `isFocusableWindow`.
GraphicsConfiguration	getGraphicsConfiguration() This method returns the GraphicsConfiguration used by this Window.
List<Image>	getIconImages() Returns the sequence of images to be displayed as the icon for this window.
InputContext	getInputContext() Gets the input context for this window.
<T extends EventListener> T[]	getListeners(Class<T> listenerType) Returns an array of all the objects currently registered as `FooListener`s upon this `Window`.
Locale	getLocale() Gets the `Locale` object that is associated with this window, if the locale has been set.
Dialog.ModalExclusionType	getModalExclusionType() Returns the modal exclusion type of this window.
Component	getMostRecentFocusOwner() Returns the child Component of this Window that will receive the focus when this Window is focused.
Window[]	getOwnedWindows() Return an array containing all the windows this window currently owns.
Window	getOwner() Returns the owner of this window.
static Window[]	getOwnerlessWindows() Returns an array of all `Window`s created by this application that have no owner.
Toolkit	getToolkit() Returns the toolkit of this frame.
final String	getWarningString() Gets the warning string that is displayed with this window.
synchronized WindowFocusListener[]	getWindowFocusListeners() Returns an array of all the window focus listeners registered on this window.
synchronized WindowListener[]	getWindowListeners() Returns an array of all the window listeners registered on this window.
synchronized WindowStateListener[]	getWindowStateListeners() Returns an array of all the window state listeners registered on this window.
static Window[]	getWindows() Returns an array of all `Window`s, both owned and ownerless, created by this application.
void	hide() This method is deprecated. As of JDK version 1.5, replaced by `setVisible(boolean)`.
boolean	isActive() Returns whether this Window is active.
final boolean	isAlwaysOnTop() Returns whether this window is an always-on-top window.
boolean	isAlwaysOnTopSupported() Returns whether the always-on-top mode is supported for this window.
final boolean	isFocusCycleRoot() Always returns `true` because all Windows must be roots of a focus traversal cycle.
final boolean	isFocusableWindow() Returns whether this Window can become the focused Window, that is, whether this Window or any of its subcomponents can become the focus owner.
boolean	isFocused() Returns whether this Window is focused.
boolean	isLocationByPlatform() Returns `true` if this Window will appear at the default location for the native windowing system the next time this Window is made visible.
boolean	isShowing() Checks if this Window is showing on screen.
void	pack() Causes this Window to be sized to fit the preferred size and layouts of its subcomponents.
boolean	postEvent(Event e) This method is deprecated. As of JDK version 1.1 replaced by `dispatchEvent(AWTEvent)`.
void	processEvent(AWTEvent e) Processes events on this window.
void	processWindowEvent(WindowEvent e) Processes window events occurring on this window by dispatching them to any registered WindowListener objects.
void	processWindowFocusEvent(WindowEvent e) Processes window focus event occuring on this window by dispatching them to any registered WindowFocusListener objects.
void	processWindowStateEvent(WindowEvent e) Processes window state event occuring on this window by dispatching them to any registered `WindowStateListener` objects.
void	removeNotify() Makes this Container undisplayable by removing its connection to its native screen resource.
synchronized void	removeWindowFocusListener(WindowFocusListener l) Removes the specified window focus listener so that it no longer receives window events from this window.
synchronized void	removeWindowListener(WindowListener l) Removes the specified window listener so that it no longer receives window events from this window.
synchronized void	removeWindowStateListener(WindowStateListener l) Removes the specified window state listener so that it no longer receives window events from this window.
void	reshape(int x, int y, int width, int height) This method is deprecated. As of JDK version 1.1, replaced by `setBounds(int, int, int, int)`.
final void	setAlwaysOnTop(boolean alwaysOnTop) Sets whether this window should always be above other windows.
void	setBounds(Rectangle r) Moves and resizes this component to conform to the new bounding rectangle `r`. The `r.width` or `r.height` values will be automatically enlarged if either is less than the minimum size as specified by previous call to `setMinimumSize`.
void	setBounds(int x, int y, int width, int height) Moves and resizes this component. The `width` or `height` values are automatically enlarged if either is less than the minimum size as specified by previous call to `setMinimumSize`.
void	setCursor(Cursor cursor) Set the cursor image to a specified cursor.
final void	setFocusCycleRoot(boolean focusCycleRoot) Does nothing because Windows must always be roots of a focus traversal cycle.
void	setFocusableWindowState(boolean focusableWindowState) Sets whether this Window can become the focused Window if it meets the other requirements outlined in `isFocusableWindow`.
void	setIconImage(Image image) Sets the image to be displayed as the icon for this window.
synchronized void	setIconImages(List<? extends Image> icons) Sets the sequence of images to be displayed as the icon for this window.
void	setLocationByPlatform(boolean locationByPlatform) Sets whether this Window should appear at the default location for the native windowing system or at the current location (returned by `getLocation`) the next time the Window is made visible.
void	setLocationRelativeTo(Component c) Sets the location of the window relative to the specified component.
void	setMinimumSize(Dimension minimumSize) Sets the minimum size of this window to a constant value.
void	setModalExclusionType(Dialog.ModalExclusionType exclusionType) Specifies the modal exclusion type for this window.
void	setSize(int width, int height) Resizes this component so that it has width `width` and height `height`. The `width` and `height` values are automatically enlarged if either is less than the minimum size as specified by previous call to `setMinimumSize`.
void	setSize(Dimension d) Resizes this component so that it has width `d.width` and height `d.height`. The `d.width` and `d.height` values are automatically enlarged if either is less than the minimum size as specified by previous call to `setMinimumSize`.
void	setVisible(boolean b) Shows or hides this `Window` depending on the value of parameter `b`.
void	show() This method is deprecated. As of JDK version 1.5, replaced by `setVisible(boolean)`.
void	toBack() If this Window is visible, sends this Window to the back and may cause it to lose focus or activation if it is the focused or active Window.
void	toFront() If this Window is visible, brings this Window to the front and may make it the focused Window.

From class java.awt.Container

void	add(Component comp, Object constraints) Adds the specified component to the end of this container.
Component	add(String name, Component comp) Adds the specified component to this container.
Component	add(Component comp, int index) Adds the specified component to this container at the given position.
Component	add(Component comp) Appends the specified component to the end of this container.
void	add(Component comp, Object constraints, int index) Adds the specified component to this container with the specified constraints at the specified index.
synchronized void	addContainerListener(ContainerListener l) Adds the specified container listener to receive container events from this container.
void	addImpl(Component comp, Object constraints, int index) Adds the specified component to this container at the specified index.
void	addNotify() Makes this Container displayable by connecting it to a native screen resource.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener) Adds a PropertyChangeListener to the listener list for a specific property.
void	addPropertyChangeListener(PropertyChangeListener listener) Adds a PropertyChangeListener to the listener list.
void	applyComponentOrientation(ComponentOrientation o) Sets the `ComponentOrientation` property of this container and all components contained within it.
boolean	areFocusTraversalKeysSet(int id) Returns whether the Set of focus traversal keys for the given focus traversal operation has been explicitly defined for this Container.
int	countComponents() This method is deprecated. As of JDK version 1.1, replaced by getComponentCount().
void	deliverEvent(Event e) This method is deprecated. As of JDK version 1.1, replaced by `dispatchEvent(AWTEvent e)`
void	doLayout() Causes this container to lay out its components.
Component	findComponentAt(Point p) Locates the visible child component that contains the specified point.
Component	findComponentAt(int x, int y) Locates the visible child component that contains the specified position.
float	getAlignmentX() Returns the alignment along the x axis.
float	getAlignmentY() Returns the alignment along the y axis.
Component	getComponent(int n) Gets the nth component in this container.
Component	getComponentAt(int x, int y) Locates the component that contains the x,y position.
Component	getComponentAt(Point p) Gets the component that contains the specified point.
int	getComponentCount() Gets the number of components in this panel.
int	getComponentZOrder(Component comp) Returns the z-order index of the component inside the container.
Component[]	getComponents() Gets all the components in this container.
synchronized ContainerListener[]	getContainerListeners() Returns an array of all the container listeners registered on this container.
Set<AWTKeyStroke>	getFocusTraversalKeys(int id) Returns the Set of focus traversal keys for a given traversal operation for this Container.
FocusTraversalPolicy	getFocusTraversalPolicy() Returns the focus traversal policy that will manage keyboard traversal of this Container's children, or null if this Container is not a focus cycle root.
Insets	getInsets() Determines the insets of this container, which indicate the size of the container's border.
LayoutManager	getLayout() Gets the layout manager for this container.
<T extends EventListener> T[]	getListeners(Class<T> listenerType) Returns an array of all the objects currently registered as `FooListener`s upon this `Container`.
Dimension	getMaximumSize() Returns the maximum size of this container.
Dimension	getMinimumSize() Returns the minimum size of this container.
Point	getMousePosition(boolean allowChildren) Returns the position of the mouse pointer in this `Container`'s coordinate space if the `Container` is under the mouse pointer, otherwise returns `null`.
Dimension	getPreferredSize() Returns the preferred size of this container.
Insets	insets() This method is deprecated. As of JDK version 1.1, replaced by `getInsets()`.
void	invalidate() Invalidates the container.
boolean	isAncestorOf(Component c) Checks if the component is contained in the component hierarchy of this container.
boolean	isFocusCycleRoot(Container container) Returns whether the specified Container is the focus cycle root of this Container's focus traversal cycle.
boolean	isFocusCycleRoot() Returns whether this Container is the root of a focus traversal cycle.
final boolean	isFocusTraversalPolicyProvider() Returns whether this container provides focus traversal policy.
boolean	isFocusTraversalPolicySet() Returns whether the focus traversal policy has been explicitly set for this Container.
void	layout() This method is deprecated. As of JDK version 1.1, replaced by `doLayout()`.
void	list(PrintStream out, int indent) Prints a listing of this container to the specified output stream.
void	list(PrintWriter out, int indent) Prints out a list, starting at the specified indentation, to the specified print writer.
Component	locate(int x, int y) This method is deprecated. As of JDK version 1.1, replaced by `getComponentAt(int, int)`.
Dimension	minimumSize() This method is deprecated. As of JDK version 1.1, replaced by `getMinimumSize()`.
void	paint(Graphics g) Paints the container.
void	paintComponents(Graphics g) Paints each of the components in this container.
String	paramString() Returns a string representing the state of this `Container`.
Dimension	preferredSize() This method is deprecated. As of JDK version 1.1, replaced by `getPreferredSize()`.
void	print(Graphics g) Prints the container.
void	printComponents(Graphics g) Prints each of the components in this container.
void	processContainerEvent(ContainerEvent e) Processes container events occurring on this container by dispatching them to any registered ContainerListener objects.
void	processEvent(AWTEvent e) Processes events on this container.
void	remove(Component comp) Removes the specified component from this container.
void	remove(int index) Removes the component, specified by `index`, from this container.
void	removeAll() Removes all the components from this container.
synchronized void	removeContainerListener(ContainerListener l) Removes the specified container listener so it no longer receives container events from this container.
void	removeNotify() Makes this Container undisplayable by removing its connection to its native screen resource.
void	setComponentZOrder(Component comp, int index) Moves the specified component to the specified z-order index in the container.
void	setFocusCycleRoot(boolean focusCycleRoot) Sets whether this Container is the root of a focus traversal cycle.
void	setFocusTraversalKeys(int id, Set<? extends AWTKeyStroke> keystrokes) Sets the focus traversal keys for a given traversal operation for this Container.
void	setFocusTraversalPolicy(FocusTraversalPolicy policy) Sets the focus traversal policy that will manage keyboard traversal of this Container's children, if this Container is a focus cycle root.
final void	setFocusTraversalPolicyProvider(boolean provider) Sets whether this container will be used to provide focus traversal policy.
void	setFont(Font f) Sets the font of this container.
void	setLayout(LayoutManager mgr) Sets the layout manager for this container.
void	transferFocusDownCycle() Transfers the focus down one focus traversal cycle.
void	update(Graphics g) Updates the container.
void	validate() Validates this container and all of its subcomponents.
void	validateTree() Recursively descends the container tree and recomputes the layout for any subtrees marked as needing it (those marked as invalid).

From class java.awt.Component

boolean	action(Event evt, Object what) This method is deprecated. As of JDK version 1.1, should register this component as ActionListener on component which fires action events.
void	add(PopupMenu popup) Adds the specified popup menu to the component.
synchronized void	addComponentListener(ComponentListener l) Adds the specified component listener to receive component events from this component.
synchronized void	addFocusListener(FocusListener l) Adds the specified focus listener to receive focus events from this component when this component gains input focus.
void	addHierarchyBoundsListener(HierarchyBoundsListener l) Adds the specified hierarchy bounds listener to receive hierarchy bounds events from this component when the hierarchy to which this container belongs changes.
void	addHierarchyListener(HierarchyListener l) Adds the specified hierarchy listener to receive hierarchy changed events from this component when the hierarchy to which this container belongs changes.
synchronized void	addInputMethodListener(InputMethodListener l) Adds the specified input method listener to receive input method events from this component.
synchronized void	addKeyListener(KeyListener l) Adds the specified key listener to receive key events from this component.
synchronized void	addMouseListener(MouseListener l) Adds the specified mouse listener to receive mouse events from this component.
synchronized void	addMouseMotionListener(MouseMotionListener l) Adds the specified mouse motion listener to receive mouse motion events from this component.
synchronized void	addMouseWheelListener(MouseWheelListener l) Adds the specified mouse wheel listener to receive mouse wheel events from this component.
void	addNotify() Makes this `Component` displayable by connecting it to a native screen resource.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener) Adds a PropertyChangeListener to the listener list for a specific property.
void	addPropertyChangeListener(PropertyChangeListener listener) Adds a PropertyChangeListener to the listener list.
void	applyComponentOrientation(ComponentOrientation orientation) Sets the `ComponentOrientation` property of this component and all components contained within it.
boolean	areFocusTraversalKeysSet(int id) Returns whether the Set of focus traversal keys for the given focus traversal operation has been explicitly defined for this Component.
Rectangle	bounds() This method is deprecated. As of JDK version 1.1, replaced by `getBounds()`.
int	checkImage(Image image, ImageObserver observer) Returns the status of the construction of a screen representation of the specified image.
int	checkImage(Image image, int width, int height, ImageObserver observer) Returns the status of the construction of a screen representation of the specified image.
AWTEvent	coalesceEvents(AWTEvent existingEvent, AWTEvent newEvent) Potentially coalesce an event being posted with an existing event.
boolean	contains(Point p) Checks whether this component "contains" the specified point, where the point's x and y coordinates are defined to be relative to the coordinate system of this component.
boolean	contains(int x, int y) Checks whether this component "contains" the specified point, where `x` and `y` are defined to be relative to the coordinate system of this component.
Image	createImage(int width, int height) Creates an off-screen drawable image to be used for double buffering.
Image	createImage(ImageProducer producer) Creates an image from the specified image producer.
VolatileImage	createVolatileImage(int width, int height, ImageCapabilities caps) Creates a volatile off-screen drawable image, with the given capabilities.
VolatileImage	createVolatileImage(int width, int height) Creates a volatile off-screen drawable image to be used for double buffering.
void	deliverEvent(Event e) This method is deprecated. As of JDK version 1.1, replaced by `dispatchEvent(AWTEvent e)`.
void	disable() This method is deprecated. As of JDK version 1.1, replaced by `setEnabled(boolean)`.
final void	disableEvents(long eventsToDisable) Disables the events defined by the specified event mask parameter from being delivered to this component.
final void	dispatchEvent(AWTEvent e) Dispatches an event to this component or one of its sub components.
void	doLayout() Prompts the layout manager to lay out this component.
void	enable() This method is deprecated. As of JDK version 1.1, replaced by `setEnabled(boolean)`.
void	enable(boolean b) This method is deprecated. As of JDK version 1.1, replaced by `setEnabled(boolean)`.
final void	enableEvents(long eventsToEnable) Enables the events defined by the specified event mask parameter to be delivered to this component.
void	enableInputMethods(boolean enable) Enables or disables input method support for this component.
void	firePropertyChange(String propertyName, float oldValue, float newValue) Reports a bound property change.
void	firePropertyChange(String propertyName, byte oldValue, byte newValue) Reports a bound property change.
void	firePropertyChange(String propertyName, char oldValue, char newValue) Reports a bound property change.
void	firePropertyChange(String propertyName, short oldValue, short newValue) Reports a bound property change.
void	firePropertyChange(String propertyName, long oldValue, long newValue) Reports a bound property change.
void	firePropertyChange(String propertyName, boolean oldValue, boolean newValue) Support for reporting bound property changes for boolean properties.
void	firePropertyChange(String propertyName, double oldValue, double newValue) Reports a bound property change.
void	firePropertyChange(String propertyName, Object oldValue, Object newValue) Support for reporting bound property changes for Object properties.
void	firePropertyChange(String propertyName, int oldValue, int newValue) Support for reporting bound property changes for integer properties.
AccessibleContext	getAccessibleContext() Gets the `AccessibleContext` associated with this `Component`.
float	getAlignmentX() Returns the alignment along the x axis.
float	getAlignmentY() Returns the alignment along the y axis.
Color	getBackground() Gets the background color of this component.
int	getBaseline(int width, int height) Returns the baseline.
Component.BaselineResizeBehavior	getBaselineResizeBehavior() Returns an enum indicating how the baseline of the component changes as the size changes.
Rectangle	getBounds(Rectangle rv) Stores the bounds of this component into "return value" rv and return rv.
Rectangle	getBounds() Gets the bounds of this component in the form of a `Rectangle` object.
ColorModel	getColorModel() Gets the instance of `ColorModel` used to display the component on the output device.
Component	getComponentAt(Point p) Returns the component or subcomponent that contains the specified point.
Component	getComponentAt(int x, int y) Determines if this component or one of its immediate subcomponents contains the (x, y) location, and if so, returns the containing component.
synchronized ComponentListener[]	getComponentListeners() Returns an array of all the component listeners registered on this component.
ComponentOrientation	getComponentOrientation() Retrieves the language-sensitive orientation that is to be used to order the elements or text within this component.
Cursor	getCursor() Gets the cursor set in the component.
synchronized DropTarget	getDropTarget() Gets the `DropTarget` associated with this `Component`.
Container	getFocusCycleRootAncestor() Returns the Container which is the focus cycle root of this Component's focus traversal cycle.
synchronized FocusListener[]	getFocusListeners() Returns an array of all the focus listeners registered on this component.
Set<AWTKeyStroke>	getFocusTraversalKeys(int id) Returns the Set of focus traversal keys for a given traversal operation for this Component.
boolean	getFocusTraversalKeysEnabled() Returns whether focus traversal keys are enabled for this Component.
Font	getFont() Gets the font of this component.
FontMetrics	getFontMetrics(Font font) Gets the font metrics for the specified font.
Color	getForeground() Gets the foreground color of this component.
Graphics	getGraphics() Creates a graphics context for this component.
GraphicsConfiguration	getGraphicsConfiguration() Gets the `GraphicsConfiguration` associated with this `Component`.
int	getHeight() Returns the current height of this component.
synchronized HierarchyBoundsListener[]	getHierarchyBoundsListeners() Returns an array of all the hierarchy bounds listeners registered on this component.
synchronized HierarchyListener[]	getHierarchyListeners() Returns an array of all the hierarchy listeners registered on this component.
boolean	getIgnoreRepaint()
InputContext	getInputContext() Gets the input context used by this component for handling the communication with input methods when text is entered in this component.
synchronized InputMethodListener[]	getInputMethodListeners() Returns an array of all the input method listeners registered on this component.
InputMethodRequests	getInputMethodRequests() Gets the input method request handler which supports requests from input methods for this component.
synchronized KeyListener[]	getKeyListeners() Returns an array of all the key listeners registered on this component.
<T extends EventListener> T[]	getListeners(Class<T> listenerType) Returns an array of all the objects currently registered as `FooListener`s upon this `Component`.
Locale	getLocale() Gets the locale of this component.
Point	getLocation() Gets the location of this component in the form of a point specifying the component's top-left corner.
Point	getLocation(Point rv) Stores the x,y origin of this component into "return value" rv and return rv.
Point	getLocationOnScreen() Gets the location of this component in the form of a point specifying the component's top-left corner in the screen's coordinate space.
Dimension	getMaximumSize() Gets the maximum size of this component.
Dimension	getMinimumSize() Gets the mininimum size of this component.
synchronized MouseListener[]	getMouseListeners() Returns an array of all the mouse listeners registered on this component.
synchronized MouseMotionListener[]	getMouseMotionListeners() Returns an array of all the mouse motion listeners registered on this component.
Point	getMousePosition() Returns the position of the mouse pointer in this `Component`'s coordinate space if the `Component` is directly under the mouse pointer, otherwise returns `null`.
synchronized MouseWheelListener[]	getMouseWheelListeners() Returns an array of all the mouse wheel listeners registered on this component.
String	getName() Gets the name of the component.
Container	getParent() Gets the parent of this component.
ComponentPeer	getPeer() This method is deprecated. As of JDK version 1.1, programs should not directly manipulate peers; replaced by `boolean isDisplayable()`.
Dimension	getPreferredSize() Gets the preferred size of this component.
PropertyChangeListener[]	getPropertyChangeListeners() Returns an array of all the property change listeners registered on this component.
PropertyChangeListener[]	getPropertyChangeListeners(String propertyName) Returns an array of all the listeners which have been associated with the named property.
Dimension	getSize() Returns the size of this component in the form of a `Dimension` object.
Dimension	getSize(Dimension rv) Stores the width/height of this component into "return value" rv and return rv.
Toolkit	getToolkit() Gets the toolkit of this component.
final Object	getTreeLock() Gets this component's locking object (the object that owns the thread sychronization monitor) for AWT component-tree and layout operations.
int	getWidth() Returns the current width of this component.
int	getX() Returns the current x coordinate of the components origin.
int	getY() Returns the current y coordinate of the components origin.
boolean	gotFocus(Event evt, Object what) This method is deprecated. As of JDK version 1.1, replaced by processFocusEvent(FocusEvent).
boolean	handleEvent(Event evt) This method is deprecated. As of JDK version 1.1 replaced by processEvent(AWTEvent).
boolean	hasFocus() Returns `true` if this `Component` is the focus owner.
void	hide() This method is deprecated. As of JDK version 1.1, replaced by `setVisible(boolean)`.
boolean	imageUpdate(Image img, int infoflags, int x, int y, int w, int h) Repaints the component when the image has changed.
boolean	inside(int x, int y) This method is deprecated. As of JDK version 1.1, replaced by contains(int, int).
void	invalidate() Invalidates this component.
boolean	isBackgroundSet() Returns whether the background color has been explicitly set for this Component.
boolean	isCursorSet() Returns whether the cursor has been explicitly set for this Component.
boolean	isDisplayable() Determines whether this component is displayable.
boolean	isDoubleBuffered() Returns true if this component is painted to an offscreen image ("buffer") that's copied to the screen later.
boolean	isEnabled() Determines whether this component is enabled.
boolean	isFocusCycleRoot(Container container) Returns whether the specified Container is the focus cycle root of this Component's focus traversal cycle.
boolean	isFocusOwner() Returns `true` if this `Component` is the focus owner.
boolean	isFocusTraversable() This method is deprecated. As of 1.4, replaced by `isFocusable()`.
boolean	isFocusable() Returns whether this Component can be focused.
boolean	isFontSet() Returns whether the font has been explicitly set for this Component.
boolean	isForegroundSet() Returns whether the foreground color has been explicitly set for this Component.
boolean	isLightweight() A lightweight component doesn't have a native toolkit peer.
boolean	isMaximumSizeSet() Returns true if the maximum size has been set to a non-`null` value otherwise returns false.
boolean	isMinimumSizeSet() Returns whether or not `setMinimumSize` has been invoked with a non-null value.
boolean	isOpaque() Returns true if this component is completely opaque, returns false by default.
boolean	isPreferredSizeSet() Returns true if the preferred size has been set to a non-`null` value otherwise returns false.
boolean	isShowing() Determines whether this component is showing on screen.
boolean	isValid() Determines whether this component is valid.
boolean	isVisible() Determines whether this component should be visible when its parent is visible.
boolean	keyDown(Event evt, int key) This method is deprecated. As of JDK version 1.1, replaced by processKeyEvent(KeyEvent).
boolean	keyUp(Event evt, int key) This method is deprecated. As of JDK version 1.1, replaced by processKeyEvent(KeyEvent).
void	layout() This method is deprecated. As of JDK version 1.1, replaced by `doLayout()`.
void	list(PrintStream out) Prints a listing of this component to the specified output stream.
void	list() Prints a listing of this component to the standard system output stream `System.out`.
void	list(PrintStream out, int indent) Prints out a list, starting at the specified indentation, to the specified print stream.
void	list(PrintWriter out) Prints a listing to the specified print writer.
void	list(PrintWriter out, int indent) Prints out a list, starting at the specified indentation, to the specified print writer.
Component	locate(int x, int y) This method is deprecated. As of JDK version 1.1, replaced by getComponentAt(int, int).
Point	location() This method is deprecated. As of JDK version 1.1, replaced by `getLocation()`.
boolean	lostFocus(Event evt, Object what) This method is deprecated. As of JDK version 1.1, replaced by processFocusEvent(FocusEvent).
Dimension	minimumSize() This method is deprecated. As of JDK version 1.1, replaced by `getMinimumSize()`.
boolean	mouseDown(Event evt, int x, int y) This method is deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
boolean	mouseDrag(Event evt, int x, int y) This method is deprecated. As of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent).
boolean	mouseEnter(Event evt, int x, int y) This method is deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
boolean	mouseExit(Event evt, int x, int y) This method is deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
boolean	mouseMove(Event evt, int x, int y) This method is deprecated. As of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent).
boolean	mouseUp(Event evt, int x, int y) This method is deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
void	move(int x, int y) This method is deprecated. As of JDK version 1.1, replaced by `setLocation(int, int)`.
void	nextFocus() This method is deprecated. As of JDK version 1.1, replaced by transferFocus().
void	paint(Graphics g) Paints this component.
void	paintAll(Graphics g) Paints this component and all of its subcomponents.
String	paramString() Returns a string representing the state of this component.
boolean	postEvent(Event e) This method is deprecated. As of JDK version 1.1, replaced by dispatchEvent(AWTEvent).
Dimension	preferredSize() This method is deprecated. As of JDK version 1.1, replaced by `getPreferredSize()`.
boolean	prepareImage(Image image, ImageObserver observer) Prepares an image for rendering on this component.
boolean	prepareImage(Image image, int width, int height, ImageObserver observer) Prepares an image for rendering on this component at the specified width and height.
void	print(Graphics g) Prints this component.
void	printAll(Graphics g) Prints this component and all of its subcomponents.
void	processComponentEvent(ComponentEvent e) Processes component events occurring on this component by dispatching them to any registered `ComponentListener` objects.
void	processEvent(AWTEvent e) Processes events occurring on this component.
void	processFocusEvent(FocusEvent e) Processes focus events occurring on this component by dispatching them to any registered `FocusListener` objects.
void	processHierarchyBoundsEvent(HierarchyEvent e) Processes hierarchy bounds events occurring on this component by dispatching them to any registered `HierarchyBoundsListener` objects.
void	processHierarchyEvent(HierarchyEvent e) Processes hierarchy events occurring on this component by dispatching them to any registered `HierarchyListener` objects.
void	processInputMethodEvent(InputMethodEvent e) Processes input method events occurring on this component by dispatching them to any registered `InputMethodListener` objects.
void	processKeyEvent(KeyEvent e) Processes key events occurring on this component by dispatching them to any registered `KeyListener` objects.
void	processMouseEvent(MouseEvent e) Processes mouse events occurring on this component by dispatching them to any registered `MouseListener` objects.
void	processMouseMotionEvent(MouseEvent e) Processes mouse motion events occurring on this component by dispatching them to any registered `MouseMotionListener` objects.
void	processMouseWheelEvent(MouseWheelEvent e) Processes mouse wheel events occurring on this component by dispatching them to any registered `MouseWheelListener` objects.
void	remove(MenuComponent popup) Removes the specified popup menu from the component.
synchronized void	removeComponentListener(ComponentListener l) Removes the specified component listener so that it no longer receives component events from this component.
synchronized void	removeFocusListener(FocusListener l) Removes the specified focus listener so that it no longer receives focus events from this component.
void	removeHierarchyBoundsListener(HierarchyBoundsListener l) Removes the specified hierarchy bounds listener so that it no longer receives hierarchy bounds events from this component.
void	removeHierarchyListener(HierarchyListener l) Removes the specified hierarchy listener so that it no longer receives hierarchy changed events from this component.
synchronized void	removeInputMethodListener(InputMethodListener l) Removes the specified input method listener so that it no longer receives input method events from this component.
synchronized void	removeKeyListener(KeyListener l) Removes the specified key listener so that it no longer receives key events from this component.
synchronized void	removeMouseListener(MouseListener l) Removes the specified mouse listener so that it no longer receives mouse events from this component.
synchronized void	removeMouseMotionListener(MouseMotionListener l) Removes the specified mouse motion listener so that it no longer receives mouse motion events from this component.
synchronized void	removeMouseWheelListener(MouseWheelListener l) Removes the specified mouse wheel listener so that it no longer receives mouse wheel events from this component.
void	removeNotify() Makes this `Component` undisplayable by destroying it native screen resource.
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener) Removes a `PropertyChangeListener` from the listener list for a specific property.
void	removePropertyChangeListener(PropertyChangeListener listener) Removes a PropertyChangeListener from the listener list.
void	repaint(int x, int y, int width, int height) Repaints the specified rectangle of this component.
void	repaint(long tm, int x, int y, int width, int height) Repaints the specified rectangle of this component within `tm` milliseconds.
void	repaint() Repaints this component.
void	repaint(long tm) Repaints the component.
void	requestFocus() Requests that this Component get the input focus, and that this Component's top-level ancestor become the focused Window.
boolean	requestFocus(boolean temporary) Requests that this `Component` get the input focus, and that this `Component`'s top-level ancestor become the focused `Window`.
boolean	requestFocusInWindow(boolean temporary) Requests that this `Component` get the input focus, if this `Component`'s top-level ancestor is already the focused `Window`.
boolean	requestFocusInWindow() Requests that this Component get the input focus, if this Component's top-level ancestor is already the focused Window.
void	reshape(int x, int y, int width, int height) This method is deprecated. As of JDK version 1.1, replaced by `setBounds(int, int, int, int)`.
void	resize(Dimension d) This method is deprecated. As of JDK version 1.1, replaced by `setSize(Dimension)`.
void	resize(int width, int height) This method is deprecated. As of JDK version 1.1, replaced by `setSize(int, int)`.
void	setBackground(Color c) Sets the background color of this component.
void	setBounds(int x, int y, int width, int height) Moves and resizes this component.
void	setBounds(Rectangle r) Moves and resizes this component to conform to the new bounding rectangle `r`.
void	setComponentOrientation(ComponentOrientation o) Sets the language-sensitive orientation that is to be used to order the elements or text within this component.
void	setCursor(Cursor cursor) Sets the cursor image to the specified cursor.
synchronized void	setDropTarget(DropTarget dt) Associate a `DropTarget` with this component.
void	setEnabled(boolean b) Enables or disables this component, depending on the value of the parameter `b`.
void	setFocusTraversalKeys(int id, Set<? extends AWTKeyStroke> keystrokes) Sets the focus traversal keys for a given traversal operation for this Component.
void	setFocusTraversalKeysEnabled(boolean focusTraversalKeysEnabled) Sets whether focus traversal keys are enabled for this Component.
void	setFocusable(boolean focusable) Sets the focusable state of this Component to the specified value.
void	setFont(Font f) Sets the font of this component.
void	setForeground(Color c) Sets the foreground color of this component.
void	setIgnoreRepaint(boolean ignoreRepaint) Sets whether or not paint messages received from the operating system should be ignored.
void	setLocale(Locale l) Sets the locale of this component.
void	setLocation(int x, int y) Moves this component to a new location.
void	setLocation(Point p) Moves this component to a new location.
void	setMaximumSize(Dimension maximumSize) Sets the maximum size of this component to a constant value.
void	setMinimumSize(Dimension minimumSize) Sets the minimum size of this component to a constant value.
void	setName(String name) Sets the name of the component to the specified string.
void	setPreferredSize(Dimension preferredSize) Sets the preferred size of this component to a constant value.
void	setSize(int width, int height) Resizes this component so that it has width `width` and height `height`.
void	setSize(Dimension d) Resizes this component so that it has width `d.width` and height `d.height`.
void	setVisible(boolean b) Shows or hides this component depending on the value of parameter `b`.
void	show() This method is deprecated. As of JDK version 1.1, replaced by `setVisible(boolean)`.
void	show(boolean b) This method is deprecated. As of JDK version 1.1, replaced by `setVisible(boolean)`.
Dimension	size() This method is deprecated. As of JDK version 1.1, replaced by `getSize()`.
String	toString() Returns a string representation of this component and its values.
void	transferFocus() Transfers the focus to the next component, as though this Component were the focus owner.
void	transferFocusBackward() Transfers the focus to the previous component, as though this Component were the focus owner.
void	transferFocusUpCycle() Transfers the focus up one focus traversal cycle.
void	update(Graphics g) Updates this component.
void	validate() Ensures that this component has a valid layout.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface java.awt.MenuContainer

From interface java.awt.image.ImageObserver

From interface javax.accessibility.Accessible

From interface javax.swing.RootPaneContainer

Constants

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.

Constant Value: 3 (0x00000003)

Fields

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. This is initially false, but is set to true when the JFrame is constructed.

Public Constructors

public 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.

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.

Parameters

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

Throws

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

public JFrame (String title)

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

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

Parameters

title	the title for the frame

Throws

HeadlessException	if GraphicsEnvironment.isHeadless() returns true.

public JFrame (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.

Parameters

title	the title to be displayed in the frame's border. A `null` value is treated as an empty string, "".
gc	the `GraphicsConfiguration` that is used to construct the new `JFrame` with; if `gc` is `null`, the system default `GraphicsConfiguration` is assumed

Throws

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

Public Methods

public AccessibleContext 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.

Returns

an AccessibleJFrame that serves as the AccessibleContext of this JFrame

public Container getContentPane ()

Returns the contentPane object for this frame.

Returns

the contentPane property

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

public Component getGlassPane ()

Returns the glassPane object for this frame.

Returns

the glassPane property

public Graphics getGraphics ()

Creates a graphics context for this component. This method will return null if this component is currently not displayable.

Returns

a graphics context for this component, or null if it has none

public JMenuBar getJMenuBar ()

Returns the menubar set on this frame.

Returns

the menubar for this frame

public JLayeredPane getLayeredPane ()

Returns the layeredPane object for this frame.

Returns

the layeredPane property

public JRootPane getRootPane ()

Returns the rootPane object for this frame.

Returns

the rootPane property

public TransferHandler getTransferHandler ()

Gets the transferHandler property.

Returns

the value of the transferHandler property

public static boolean isDefaultLookAndFeelDecorated ()

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

Returns

true if look and feel should provide Window decorations.

public void remove (Component comp)

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

Parameters

comp	the component to be removed

Throws

NullPointerException	if `comp` is null

public void repaint (long time, int x, int y, int width, int height)

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

Parameters

time	maximum time in milliseconds before update
x	the x coordinate
y	the y coordinate
width	the width
height	the height

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

Parameters

contentPane	the `contentPane` object for this frame

Throws

IllegalComponentStateException	(a runtime exception) if the content pane parameter is `null`

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. 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
SecurityException	if `EXIT_ON_CLOSE` has been specified and the `SecurityManager` will not allow the caller to invoke `System.exit`

public 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. 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);

Parameters

defaultLookAndFeelDecorated	A hint as to whether or not current look and feel should provide window decorations

public void setGlassPane (Component glassPane)

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

Parameters

glassPane	the `glassPane` object for this frame

public void setIconImage (Image image)

Sets the image to be displayed as the icon for this window.

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<Image> imageList = new ArrayList<Image>();
     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.

Parameters

image	the icon image to be displayed.

public void setJMenuBar (JMenuBar menubar)

Sets the menubar for this frame.

Parameters

menubar	the menubar being placed in the frame

public void setLayeredPane (JLayeredPane layeredPane)

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

Parameters

layeredPane	the `layeredPane` object for this frame

Throws

IllegalComponentStateException	(a runtime exception) if the layered pane parameter is `null`

public void setLayout (LayoutManager manager)

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

Parameters

manager	the `LayoutManager`

public void setTransferHandler (TransferHandler newHandler)

Sets the 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.

Parameters

newHandler	the new `TransferHandler`

public void update (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

Protected Methods

protected void addImpl (Component comp, Object constraints, int index)

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

Parameters

comp	the component to be enhanced
constraints	the constraints to be respected
index	the index

Throws

IllegalArgumentException	if `index` is invalid
IllegalArgumentException	if adding the container's parent to itself
IllegalArgumentException	if adding a window to a container

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.

protected boolean isRootPaneCheckingEnabled ()

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

Returns

true if add and setLayout are fowarded; false otherwise

protected 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

protected void processWindowEvent (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

protected void setRootPane (JRootPane root)

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

Parameters

root	the `rootPane` object for this frame

protected void setRootPaneCheckingEnabled (boolean enabled)

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

Parameters

enabled	true if `add` and `setLayout` are forwarded, false if they should operate directly on the `JFrame`.

Interfaces

Classes

Enums

Exceptions

JFrame

Class Overview

See Also

Summary

Constants

public static final int EXIT_ON_CLOSE

Fields

protected AccessibleContext accessibleContext

protected JRootPane rootPane

See Also

protected boolean rootPaneCheckingEnabled

See Also

Public Constructors

public JFrame ()

Throws

See Also

public JFrame (GraphicsConfiguration gc)

Parameters

Throws

See Also

public JFrame (String title)

Parameters

Throws

See Also

public JFrame (String title, GraphicsConfiguration gc)

Parameters

Throws

See Also

Public Methods

public AccessibleContext getAccessibleContext ()

Returns

public Container getContentPane ()

Returns

See Also

public int getDefaultCloseOperation ()

Returns

See Also

public Component getGlassPane ()

Returns

See Also

public Graphics getGraphics ()

Returns

public JMenuBar getJMenuBar ()

Returns

See Also

public JLayeredPane getLayeredPane ()

Returns

See Also

public JRootPane getRootPane ()

Returns

See Also

public TransferHandler getTransferHandler ()

Returns

See Also

public static boolean isDefaultLookAndFeelDecorated ()

Returns

public void remove (Component comp)

Parameters

Throws

See Also

public void repaint (long time, int x, int y, int width, int height)

Parameters

See Also

public void setContentPane (Container contentPane)

Parameters

Throws

See Also

public void setDefaultCloseOperation (int operation)

Parameters

Throws

See Also

public static void setDefaultLookAndFeelDecorated (boolean defaultLookAndFeelDecorated)

Parameters

See Also

public void setGlassPane (Component glassPane)

Parameters