Java Platform 1.2
Beta 4

Class java.awt.Frame

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Frame
Direct Known Subclasses:
JFrame

public class Frame
extends Window
implements MenuContainer
A Frame is a top-level window with a title and a border. The default layout for a frame is BorderLayout. Frames are capable of generating the following types of window events: WindowOpened, WindowClosing, WindowClosed, WindowIconified, WindowDeiconified, WindowActivated, WindowDeactivated.

Since:
JDK1.0
See Also:
WindowEvent, Window.addWindowListener(java.awt.event.WindowListener), Serialized Form

Field Summary
static int CROSSHAIR_CURSOR
          Deprecated. replaced by Cursor.CROSSHAIR_CURSOR.
static int DEFAULT_CURSOR
          Deprecated. replaced by Cursor.DEFAULT_CURSOR.
static int E_RESIZE_CURSOR
          Deprecated. replaced by Cursor.E_RESIZE_CURSOR.
static int HAND_CURSOR
          Deprecated. replaced by Cursor.HAND_CURSOR.
static int MOVE_CURSOR
          Deprecated. replaced by Cursor.MOVE_CURSOR.
static int N_RESIZE_CURSOR
          Deprecated. replaced by Cursor.N_RESIZE_CURSOR.
static int NE_RESIZE_CURSOR
          Deprecated. replaced by Cursor.NE_RESIZE_CURSOR.
static int NW_RESIZE_CURSOR
          Deprecated. replaced by Cursor.NW_RESIZE_CURSOR.
static int S_RESIZE_CURSOR
          Deprecated. replaced by Cursor.S_RESIZE_CURSOR.
static int SE_RESIZE_CURSOR
          Deprecated. replaced by Cursor.SE_RESIZE_CURSOR.
static int SW_RESIZE_CURSOR
          Deprecated. replaced by Cursor.SW_RESIZE_CURSOR.
static int TEXT_CURSOR
          Deprecated. replaced by Cursor.TEXT_CURSOR.
static int W_RESIZE_CURSOR
          Deprecated. replaced by Cursor.W_RESIZE_CURSOR.
static int WAIT_CURSOR
          Deprecated. replaced by Cursor.WAIT_CURSOR.
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT , CENTER_ALIGNMENT , LEFT_ALIGNMENT , RIGHT_ALIGNMENT , TOP_ALIGNMENT
 
Constructor Summary
Frame()
          Constructs a new instance of Frame that is initially invisible.
Frame(String title)
          Constructs a new, initially invisible Frame object with the specified title.
 
Method Summary
 void addNotify()
          Creates the Frame's peer.
 void dispose()
          Disposes of the Frame.
protected  void finalize()
          We have to remove the (hard) reference to softThis in the Vector, otherwise the SoftReference instance will never get garbage collected.
 int getCursorType()
          Deprecated. As of JDK version 1.1, replaced by Component.getCursor().
static Frame[] getFrames()
          Returns an array containing all Frames created by the application.
 Image getIconImage()
          Gets the icon image for this frame.
 MenuBar getMenuBar()
          Gets the menu bar for this frame.
 String getTitle()
          Gets the title of the frame.
 boolean isResizable()
          Indicates whether this frame is resizable.
protected  String paramString()
          Returns the parameter String of this Frame.
 void remove(MenuComponent m)
          Removes the specified menu bar from this frame.
 void setCursor(int cursorType)
          Deprecated. As of JDK version 1.1, replaced by Component.setCursor(Cursor).
 void setIconImage(Image image)
          Sets the image to display when this frame is iconized.
 void setMenuBar(MenuBar mb)
          Sets the menu bar for this frame to the specified menu bar.
 void setResizable(boolean resizable)
          Sets the resizable flag, which determines whether this frame is resizable.
 void setTitle(String title)
          Sets the title for this frame to the specified title.
 
Methods inherited from class java.awt.Window
addWindowListener , applyResourceBundle , applyResourceBundle , getFocusOwner , getInputContext , getLocale , getOwnedWindows , getOwner , getToolkit , getWarningString , isShowing , pack , postEvent , processEvent , processWindowEvent , removeWindowListener , show , toBack , toFront
 
Methods inherited from class java.awt.Container
add , add , add , add , add , addContainerListener , addImpl , 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 , processContainerEvent , remove , remove , removeAll , removeContainerListener , removeNotify , setLayout , update , validate , validateTree
 
Methods inherited from class java.awt.Component
action , add , addComponentListener , addFocusListener , addInputMethodListener , addKeyListener , addMouseListener , addMouseMotionListener , addPropertyChangeListener , addPropertyChangeListener , bounds , checkImage , checkImage , coalesceEvents , contains , contains , createImage , createImage , disable , disableEvents , dispatchEvent , enable , enable , enableEvents , enableInputMethods , firePropertyChange , 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 , processComponentEvent , processFocusEvent , processInputMethodEvent , processKeyEvent , processMouseEvent , processMouseMotionEvent , removeComponentListener , removeFocusListener , removeInputMethodListener , removeKeyListener , removeMouseListener , removeMouseMotionListener , removePropertyChangeListener , removePropertyChangeListener , repaint , repaint , repaint , repaint , requestFocus , reshape , resize , resize , setBackground , setBounds , setBounds , setComponentOrientation , setCursor , setDropTarget , setEnabled , setFont , setForeground , setLocale , setLocation , setLocation , setName , setSize , setSize , setVisible , show , size , toString , transferFocus
 
Methods inherited from class java.lang.Object
clone , equals , getClass , hashCode , notify , notifyAll , wait , wait , wait
 

Field Detail

DEFAULT_CURSOR

public static final int DEFAULT_CURSOR
Deprecated. replaced by Cursor.DEFAULT_CURSOR.

CROSSHAIR_CURSOR

public static final int CROSSHAIR_CURSOR
Deprecated. replaced by Cursor.CROSSHAIR_CURSOR.

TEXT_CURSOR

public static final int TEXT_CURSOR
Deprecated. replaced by Cursor.TEXT_CURSOR.

WAIT_CURSOR

public static final int WAIT_CURSOR
Deprecated. replaced by Cursor.WAIT_CURSOR.

SW_RESIZE_CURSOR

public static final int SW_RESIZE_CURSOR
Deprecated. replaced by Cursor.SW_RESIZE_CURSOR.

SE_RESIZE_CURSOR

public static final int SE_RESIZE_CURSOR
Deprecated. replaced by Cursor.SE_RESIZE_CURSOR.

NW_RESIZE_CURSOR

public static final int NW_RESIZE_CURSOR
Deprecated. replaced by Cursor.NW_RESIZE_CURSOR.

NE_RESIZE_CURSOR

public static final int NE_RESIZE_CURSOR
Deprecated. replaced by Cursor.NE_RESIZE_CURSOR.

N_RESIZE_CURSOR

public static final int N_RESIZE_CURSOR
Deprecated. replaced by Cursor.N_RESIZE_CURSOR.

S_RESIZE_CURSOR

public static final int S_RESIZE_CURSOR
Deprecated. replaced by Cursor.S_RESIZE_CURSOR.

W_RESIZE_CURSOR

public static final int W_RESIZE_CURSOR
Deprecated. replaced by Cursor.W_RESIZE_CURSOR.

E_RESIZE_CURSOR

public static final int E_RESIZE_CURSOR
Deprecated. replaced by Cursor.E_RESIZE_CURSOR.

HAND_CURSOR

public static final int HAND_CURSOR
Deprecated. replaced by Cursor.HAND_CURSOR.

MOVE_CURSOR

public static final int MOVE_CURSOR
Deprecated. replaced by Cursor.MOVE_CURSOR.
Constructor Detail

Frame

public Frame()
Constructs a new instance of Frame that is initially invisible.
See Also:
Component.setSize(int, int), Component.setVisible(boolean)

Frame

public Frame(String title)
Constructs a new, initially invisible Frame object with the specified title.
Parameters:
title - the title for the frame
See Also:
Component.setSize(int, int), Component.setVisible(boolean)
Method Detail

finalize

protected void finalize()
                 throws Throwable
We have to remove the (hard) reference to softThis in the Vector, otherwise the SoftReference instance will never get garbage collected.
Overrides:
finalize in class Object

addNotify

public void addNotify()
Creates the Frame's peer. The peer allows us to change the look of the Frame without changing its functionality.
Overrides:
addNotify in class Window

getTitle

public String getTitle()
Gets the title of the frame.
Returns:
the title of this frame, or null if this frame doesn't have a title.
See Also:
setTitle(java.lang.String)

setTitle

public void setTitle(String title)
Sets the title for this frame to the specified title.
Parameters:
title - the specified title of this frame.
See Also:
getTitle()

getIconImage

public Image getIconImage()
Gets the icon image for this frame.
Returns:
the icon image for this frame, or null if this frame doesn't have an icon image.
See Also:
setIconImage(java.awt.Image)

setIconImage

public void setIconImage(Image image)
Sets the image to display when this frame is iconized. Not all platforms support the concept of iconizing a window.
Parameters:
image - the icon image to be displayed
See Also:
getIconImage()

getMenuBar

public MenuBar getMenuBar()
Gets the menu bar for this frame.
Returns:
the menu bar for this frame, or null if this frame doesn't have a menu bar.
See Also:
setMenuBar(java.awt.MenuBar)

setMenuBar

public void setMenuBar(MenuBar mb)
Sets the menu bar for this frame to the specified menu bar.
Parameters:
mb - the menu bar being set
See Also:
getMenuBar()

isResizable

public boolean isResizable()
Indicates whether this frame is resizable. By default, all frames are initially resizable.
Returns:
true if the user can resize this frame; false otherwise.
See Also:
setResizable(boolean)

setResizable

public void setResizable(boolean resizable)
Sets the resizable flag, which determines whether this frame is resizable. By default, all frames are initially resizable.
Parameters:
resizable - true if this frame is resizable; false otherwise.
See Also:
isResizable()

remove

public void remove(MenuComponent m)
Removes the specified menu bar from this frame.
Specified by:
remove in interface MenuContainer
Parameters:
m - the menu component to remove.
Overrides:
remove in class Component

dispose

public void dispose()
Disposes of the Frame. This method must be called to release the resources that are used for the frame. All components contained by the frame and all windows owned by the frame will also be destroyed.
Overrides:
dispose in class Window

paramString

protected String paramString()
Returns the parameter String of this Frame.
Overrides:
paramString in class Container

setCursor

public void setCursor(int cursorType)
Deprecated. As of JDK version 1.1, replaced by Component.setCursor(Cursor).

getCursorType

public int getCursorType()
Deprecated. As of JDK version 1.1, replaced by Component.getCursor().

getFrames

public static Frame[] getFrames()
Returns an array containing all Frames created by the application. If called from an applet, the array will only include the Frames created by those applets which share a SecurityContext.
Since:
JDK1.2
See Also:
SecurityManager.getSecurityContext()

Java Platform 1.2
Beta 4

Submit a bug or feature
Submit comments/suggestions about new javadoc look
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.
This documentation was generated with a post-Beta4 version of Javadoc.