: Class JFrame

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.swing
Class JFrame

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

public class JFrame
extends java.awt.Frame
implements javax.swing.WindowConstants, javax.accessibility.Accessible, javax.swing.RootPaneContainer

An extended version of java.awt.Frame that adds support for interposing input and painting behavior in front of the frame's children (see glassPane), support for special children that are managed by a LayeredPane (see rootPane) and for Swing MenuBars.

The JFrame class is slightly incompatible with java.awt.Frame. JFrame contains a JRootPane as it's only child. The contentPane should be the parent of any children of the JFrame. This is different than java.awt.Frame, e.g. to add a child to an AWT Frame you'd write:

       frame.add(child);

However using JFrame you need to add the child to the JFrames contentPane instead:

       frame.getContentPane().add(child);

The same is true for setting LayoutManagers, removing components, listing children, etc. All these methods should normally be sent to the contentPane() instead of the JFrame itself. The contentPane() will always be non-null. Attempting to set it to null will cause the JFrame to throw an exception. The default contentPane() will have a BorderLayout manager set on it.

Please see the JRootPane documentation for a complete description of the contentPane, glassPane, and layeredPane properties.

Unlike its parent class, java.awt.Frame, you can tell a JFrame 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. To make the JFrame remain open unless you handle the window-closing event and explicitly invoke dispose() (or exit the app, which is also pretty effective), use setDefaultCloseOperation(WindowConstants.DO_NOTHING_ON_CLOSE). That makes the JFrame behave the same as java.awt.Frame. A third option lets you completely dispose of the window when it closes, instead of merely hiding it.

For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions, see the JFrame key assignments.

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. A future release of Swing will provide support for long term persistence.

See Also:: JRootPane, setDefaultCloseOperation(int), WindowListener.windowClosing(java.awt.event.WindowEvent), Serialized Form

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR,  
DEFAULT_CURSOR,  
E_RESIZE_CURSOR,  
HAND_CURSOR,  
ICONIFIED,  
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

Constructor Summary
`JFrame()` Constructs a new Frame that is initially invisible.
`JFrame(java.lang.String title)` Constructs a new, initially invisible Frame with the specified title.

Method Summary
`javax.accessibility.AccessibleContext`	`getAccessibleContext()` Get the AccessibleContext associated with this JFrame
`java.awt.Container`	`getContentPane()` Returns the contentPane object for this frame.
`int`	`getDefaultCloseOperation()` Returns the operation which occurs when the user initiates a "close" on this frame.
`java.awt.Component`	`getGlassPane()` Returns the glassPane object for this frame.
`javax.swing.JMenuBar`	`getJMenuBar()` Returns the menubar set on this frame.
`javax.swing.JLayeredPane`	`getLayeredPane()` Returns the layeredPane object for this frame.
`javax.swing.JRootPane`	`getRootPane()` Returns the rootPane object for this frame.
`void`	`setContentPane(java.awt.Container contentPane)` Sets the contentPane property.
`void`	`setDefaultCloseOperation(int operation)` Sets the operation which will happen by default when the user initiates a "close" on this frame.
`void`	`setGlassPane(java.awt.Component glassPane)` Sets the glassPane property.
`void`	`setJMenuBar(javax.swing.JMenuBar menubar)` Sets the menubar for this frame.
`void`	`setLayeredPane(javax.swing.JLayeredPane layeredPane)` Sets the layeredPane property.
`void`	`setLayout(java.awt.LayoutManager manager)` By default the layout of this component may not be set, the layout of its contentPane should be set instead.
`void`	`update(java.awt.Graphics g)` Just calls `paint(g)`.

Methods inherited from class java.awt.Frame

addNotify, 
getCursorType, 
getFrames, 
getIconImage, 
getMenuBar, 
getState, 
getTitle, 
isResizable, 
remove, 
removeNotify, 
setCursor, 
setIconImage, 
setMenuBar, 
setResizable, 
setState, 
setTitle

Methods inherited from class java.awt.Window

addWindowListener, 
applyResourceBundle, 
applyResourceBundle, 
dispose, 
getFocusOwner, 
getInputContext, 
getLocale, 
getOwnedWindows, 
getOwner, 
getToolkit, 
getWarningString, 
isShowing, 
pack, 
postEvent, 
removeWindowListener, 
show, 
toBack, 
toFront

Methods inherited from class java.awt.Container

add, 
add, 
add, 
add, 
add, 
addContainerListener, 
countComponents, 
deliverEvent, 
doLayout, 
findComponentAt, 
findComponentAt, 
getAlignmentX, 
getAlignmentY, 
getComponent, 
getComponentAt, 
getComponentAt, 
getComponentCount, 
getComponents, 
getInsets, 
getLayout, 
getMaximumSize, 
getMinimumSize, 
getPreferredSize, 
insets, 
invalidate, 
isAncestorOf, 
layout, 
list, 
list, 
locate, 
minimumSize, 
paint, 
paintComponents, 
preferredSize, 
print, 
printComponents, 
remove, 
remove, 
removeAll, 
removeContainerListener, 
setFont, 
validate

Methods inherited from class java.awt.Component

action, 
add, 
addComponentListener, 
addFocusListener, 
addInputMethodListener, 
addKeyListener, 
addMouseListener, 
addMouseMotionListener, 
addPropertyChangeListener, 
addPropertyChangeListener, 
bounds, 
checkImage, 
checkImage, 
contains, 
contains, 
createImage, 
createImage, 
disable, 
dispatchEvent, 
enable, 
enable, 
enableInputMethods, 
getBackground, 
getBounds, 
getBounds, 
getColorModel, 
getComponentOrientation, 
getCursor, 
getDropTarget, 
getFont, 
getFontMetrics, 
getForeground, 
getGraphics, 
getHeight, 
getInputMethodRequests, 
getLocation, 
getLocation, 
getLocationOnScreen, 
getName, 
getParent, 
getPeer, 
getSize, 
getSize, 
getTreeLock, 
getWidth, 
getX, 
getY, 
gotFocus, 
handleEvent, 
hasFocus, 
hide, 
imageUpdate, 
inside, 
isDisplayable, 
isDoubleBuffered, 
isEnabled, 
isFocusTraversable, 
isLightweight, 
isOpaque, 
isValid, 
isVisible, 
keyDown, 
keyUp, 
list, 
list, 
list, 
location, 
lostFocus, 
mouseDown, 
mouseDrag, 
mouseEnter, 
mouseExit, 
mouseMove, 
mouseUp, 
move, 
nextFocus, 
paintAll, 
prepareImage, 
prepareImage, 
printAll, 
removeComponentListener, 
removeFocusListener, 
removeInputMethodListener, 
removeKeyListener, 
removeMouseListener, 
removeMouseMotionListener, 
removePropertyChangeListener, 
removePropertyChangeListener, 
repaint, 
repaint, 
repaint, 
repaint, 
requestFocus, 
reshape, 
resize, 
resize, 
setBackground, 
setBounds, 
setBounds, 
setComponentOrientation, 
setCursor, 
setDropTarget, 
setEnabled, 
setForeground, 
setLocale, 
setLocation, 
setLocation, 
setName, 
setSize, 
setSize, 
setVisible, 
show, 
size, 
toString, 
transferFocus

Methods inherited from class java.lang.Object

equals, 
getClass, 
hashCode, 
notify, 
notifyAll, 
wait, 
wait, 
wait

Constructor Detail

JFrame

public JFrame()

Constructs a new Frame that is initially invisible.

See Also:: Component.setSize(int, int), Component.setVisible(boolean)

JFrame

public JFrame(java.lang.String title)

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

Parameters:: title - the title for the frame
See Also:: Component.setSize(int, int), Component.setVisible(boolean)

Method Detail

setDefaultCloseOperation

public void setDefaultCloseOperation(int operation)

Sets the operation which will happen by default when the user initiates a "close" on this frame. The possible choices are defined in the WindowConstants interface:

DO_NOTHING_ON_CLOSE - do not do anything - require the program to handle the operation in the windowClosing method of a registered WindowListener object.
HIDE_ON_CLOSE - automatically hide the frame after invoking any registered WindowListener objects
DISPOSE_ON_CLOSE - automatically hide and dispose the frame after invoking any registered WindowListener objects

The value is set to HIDE_ON_CLOSE by default.

See Also:: Window.addWindowListener(java.awt.event.WindowListener), getDefaultCloseOperation()

getDefaultCloseOperation

public int getDefaultCloseOperation()

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

Returns:: an int indicating the window-close operation
See Also:: setDefaultCloseOperation(int)

update

public void update(java.awt.Graphics g)

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

Parameters:: g - the Graphics context in which to paint
Overrides:: update in class java.awt.Container

setJMenuBar

public void setJMenuBar(javax.swing.JMenuBar menubar)

Sets the menubar for this frame.

Parameters:: menubar - the menubar being placed in the frame
See Also:: getJMenuBar()

getJMenuBar

public javax.swing.JMenuBar getJMenuBar()

Returns the menubar set on this frame.

See Also:: setJMenuBar(javax.swing.JMenuBar)

setLayout

public void setLayout(java.awt.LayoutManager manager)

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

 thiComponent.getContentPane().setLayout(new BorderLayout())

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

Throws:: Error - if called with rootPaneChecking true
Overrides:: setLayout in class java.awt.Container
See Also:: #setRootPaneCheckingEnabled

getRootPane

public javax.swing.JRootPane getRootPane()

Returns the rootPane object for this frame.

Specified by:: getRootPane in interface javax.swing.RootPaneContainer
See Also:: #setRootPane, RootPaneContainer.getRootPane()

getContentPane

public java.awt.Container getContentPane()

Returns the contentPane object for this frame.

Specified by:: getContentPane in interface javax.swing.RootPaneContainer
See Also:: setContentPane(java.awt.Container), RootPaneContainer.getContentPane()

setContentPane

public void setContentPane(java.awt.Container contentPane)

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

Specified by:: setContentPane in interface javax.swing.RootPaneContainer
Parameters:: contentPane - the contentPane object for this frame
Throws:: java.awt.IllegalComponentStateException - (a runtime exception) if the content pane parameter is null
See Also:: getContentPane(), RootPaneContainer.setContentPane(java.awt.Container)

getLayeredPane

public javax.swing.JLayeredPane getLayeredPane()

Returns the layeredPane object for this frame.

Specified by:: getLayeredPane in interface javax.swing.RootPaneContainer
See Also:: setLayeredPane(javax.swing.JLayeredPane), RootPaneContainer.getLayeredPane()

setLayeredPane

public void setLayeredPane(javax.swing.JLayeredPane layeredPane)

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

Specified by:: setLayeredPane in interface javax.swing.RootPaneContainer
Parameters:: layeredPane - the layeredPane object for this frame
Throws:: java.awt.IllegalComponentStateException - (a runtime exception) if the layered pane parameter is null
See Also:: getLayeredPane(), RootPaneContainer.setLayeredPane(javax.swing.JLayeredPane)

getGlassPane

public java.awt.Component getGlassPane()

Returns the glassPane object for this frame.

Specified by:: getGlassPane in interface javax.swing.RootPaneContainer
See Also:: setGlassPane(java.awt.Component), RootPaneContainer.getGlassPane()

setGlassPane

public void setGlassPane(java.awt.Component glassPane)

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

Specified by:: setGlassPane in interface javax.swing.RootPaneContainer
Parameters:: glassPane - the glassPane object for this frame
See Also:: getGlassPane(), RootPaneContainer.setGlassPane(java.awt.Component)

getAccessibleContext

public javax.accessibility.AccessibleContext getAccessibleContext()

Get the AccessibleContext associated with this JFrame

Specified by:: getAccessibleContext in interface javax.accessibility.Accessible
Returns:: the AccessibleContext of this JFrame

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.swing Class JFrame

JFrame

JFrame

setDefaultCloseOperation

getDefaultCloseOperation

update

setJMenuBar

getJMenuBar

setLayout

getRootPane

getContentPane

setContentPane

getLayeredPane

setLayeredPane

getGlassPane

setGlassPane

getAccessibleContext

javax.swing
Class JFrame