|
PDAP Public Review Draft | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.awt.Component | +--java.awt.Container | +--java.awt.Window | +--java.awt.Frame
A Frame is a top-level window with a title and a border.
The size of the frame includes any area designated for the
border. The dimensions of the border area can be obtained
using the getInsets
method, however, since
these dimensions are platform-dependent, a valid insets
value cannot be obtained until the frame is made displayable
by either calling pack
or show
.
Since the border area is included in the overall size of the
frame, the border effectively obscures a portion of the frame,
constraining the area available for rendering and/or displaying
subcomponents to the rectangle which has an upper-left corner
location of (insets.left, insets.top)
, and has a size of
width - (insets.left + insets.right)
by
height - (insets.top + insets.bottom)
.
The default layout for a frame is BorderLayout.
In a multi-screen environment, you can create a Frame
on a different screen device by constructing the Frame
with Frame(GraphicsConfiguration)
or
Frame(String title, GraphicsConfiguration)
. The
GraphicsConfiguration
object is one of the
GraphicsConfiguration
objects of the target screen
device.
In a virtual device multi-screen environment in which the desktop area could span multiple physical screen devices, the bounds of all configurations are relative to the virtual-coordinate system. The origin of the virtual-coordinate system is at the upper left-hand corner of the primary physical screen. Depending on the location of the primary screen in the virtual device, negative coordinates are possible, as shown in the following figure.
ALIGN=center HSPACE=10 VSPACE=7>
In such an environment, when calling setLocation
,
you must pass a virtual coordinate to this method. Similarly,
calling getLocationOnScreen
on a Frame
returns virtual device coordinates. Call the getBounds
method of a GraphicsConfiguration
to find its origin in
the virtual coordinate system.
The following code sets the
location of the Frame
at (10, 10) relative
to the origin of the physical screen of the corresponding
GraphicsConfiguration
. If the bounds of the
GraphicsConfiguration
is not taken into account, the
Frame
location would be set at (10, 10) relative to the
virtual-coordinate system and would appear on the primary physical
screen, which might be different from the physical screen of the
specified GraphicsConfiguration
.
Frame f = new Frame(GraphicsConfiguration gc); Rectangle bounds = gc.getBounds(); f.setLocation(10 + bounds.x, 10 + bounds.y);
Frames are capable of generating the following types of window events: WindowOpened, WindowClosing, WindowClosed, WindowIconified, WindowDeiconified, WindowActivated, WindowDeactivated.
Restrictions
Implementations of Frame in the PDA Profile may exhibit
certain restrictions, specifically:
setTitle(java.lang.String)
and getTitle()
on all Frames behave as normal, but no title is visible to the user.
See:
WindowEvent
,
Window.addWindowListener(java.awt.event.WindowListener)
Field Summary | |
static int |
CROSSHAIR_CURSOR
Deprecated. replaced by Cursor.CROSSHAIR_CURSOR .
Value Cursor.CROSSHAIR_CURSOR is assigned to CROSSHAIR_CURSOR. |
static int |
DEFAULT_CURSOR
Deprecated. replaced by Cursor.DEFAULT_CURSOR .
Value Cursor.DEFAULT_CURSOR is assigned to DEFAULT_CURSOR. |
static int |
E_RESIZE_CURSOR
Deprecated. replaced by Cursor.E_RESIZE_CURSOR .
Value Cursor.E_RESIZE_CURSOR is assigned to E_RESIZE_CURSOR. |
static int |
HAND_CURSOR
Deprecated. replaced by Cursor.HAND_CURSOR .
Value Cursor.HAND_CURSOR is assigned to HAND_CURSOR. |
static int |
ICONIFIED
Value 1 is assigned to ICONIFIED. |
static int |
MOVE_CURSOR
Deprecated. replaced by Cursor.MOVE_CURSOR .
Value Cursor.MOVE_CURSOR is assigned to MOVE_CURSOR. |
static int |
N_RESIZE_CURSOR
Deprecated. replaced by Cursor.N_RESIZE_CURSOR .
Value Cursor.N_RESIZE_CURSOR is assigned to N_RESIZE_CURSOR. |
static int |
NE_RESIZE_CURSOR
Deprecated. replaced by Cursor.NE_RESIZE_CURSOR .
Value Cursor.NE_RESIZE_CURSOR is assigned to NE_RESIZE_CURSOR. |
static int |
NORMAL
Value 0 is assigned to NORMAL. |
static int |
NW_RESIZE_CURSOR
Deprecated. replaced by Cursor.NW_RESIZE_CURSOR .
Value Cursor.NW_RESIZE_CURSOR is assigned to NW_RESIZE_CURSOR. |
static int |
S_RESIZE_CURSOR
Deprecated. replaced by Cursor.S_RESIZE_CURSOR .
Value Cursor.S_RESIZE_CURSOR is assigned to S_RESIZE_CURSOR. |
static int |
SE_RESIZE_CURSOR
Deprecated. replaced by Cursor.SE_RESIZE_CURSOR .
Value Cursor.SE_RESIZE_CURSOR is assigned to SE_RESIZE_CURSOR. |
static int |
SW_RESIZE_CURSOR
Deprecated. replaced by Cursor.SW_RESIZE_CURSOR .
Value Cursor.SW_RESIZE_CURSOR is assigned to SW_RESIZE_CURSOR. |
static int |
TEXT_CURSOR
Deprecated. replaced by Cursor.TEXT_CURSOR .
Value Cursor.TEXT_CURSOR is assigned to TEXT_CURSOR. |
static int |
W_RESIZE_CURSOR
Deprecated. replaced by Cursor.W_RESIZE_CURSOR .
Value Cursor.W_RESIZE_CURSOR is assigned to W_RESIZE_CURSOR. |
static int |
WAIT_CURSOR
Deprecated. replaced by Cursor.WAIT_CURSOR .
Value Cursor.WAIT_CURSOR is assigned to WAIT_CURSOR. |
Fields inherited from class java.awt.Component |
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
Fields inherited from interface java.awt.image.ImageObserver |
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
Frame()
Constructs a new instance of Frame that is
initially invisible. |
|
Frame(GraphicsConfiguration gc)
Create a Frame with the specified
GraphicsConfiguration of
a screen device. |
|
Frame(java.lang.String title)
Constructs a new, initially invisible Frame object
with the specified title. |
|
Frame(java.lang.String title,
GraphicsConfiguration gc)
Constructs a new, initially invisible Frame object
with the specified title and a
GraphicsConfiguration . |
Method Summary | |
protected void |
finalize()
We have to remove the (hard) reference to weakThis in the Vector, otherwise the WeakReference instance will never get garbage collected. |
int |
getCursorType()
Deprecated. As of JDK version 1.1, replaced by Component.getCursor() . |
Image |
getIconImage()
Gets the image to be displayed in the minimized icon for this frame. |
MenuBar |
getMenuBar()
Gets the menu bar for this frame. |
int |
getState()
Gets the state of this frame. |
java.lang.String |
getTitle()
Gets the title of the frame. |
boolean |
isResizable()
Indicates whether this frame is resizable by the user. |
protected java.lang.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 displayed in the minimized icon 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. |
void |
setState(int state)
Sets the state of this frame. |
void |
setTitle(java.lang.String title)
Sets the title for this frame to the specified string. |
Methods inherited from class java.awt.Window |
addWindowListener, dispose, getFocusOwner, getLocale, getToolkit, getWarningString, isShowing, pack, postEvent, processEvent, processWindowEvent, removeWindowListener, setCursor, 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, setFont, setLayout, update, validate, validateTree |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.awt.MenuContainer |
getFont, postEvent |
Field Detail |
public static final int DEFAULT_CURSOR
Cursor.DEFAULT_CURSOR
.
Value Cursor.DEFAULT_CURSOR is assigned to DEFAULT_CURSOR.
public static final int CROSSHAIR_CURSOR
Cursor.CROSSHAIR_CURSOR
.
Value Cursor.CROSSHAIR_CURSOR is assigned to CROSSHAIR_CURSOR.
public static final int TEXT_CURSOR
Cursor.TEXT_CURSOR
.
Value Cursor.TEXT_CURSOR is assigned to TEXT_CURSOR.
public static final int WAIT_CURSOR
Cursor.WAIT_CURSOR
.
Value Cursor.WAIT_CURSOR is assigned to WAIT_CURSOR.
public static final int SW_RESIZE_CURSOR
Cursor.SW_RESIZE_CURSOR
.
Value Cursor.SW_RESIZE_CURSOR is assigned to SW_RESIZE_CURSOR.
public static final int SE_RESIZE_CURSOR
Cursor.SE_RESIZE_CURSOR
.
Value Cursor.SE_RESIZE_CURSOR is assigned to SE_RESIZE_CURSOR.
public static final int NW_RESIZE_CURSOR
Cursor.NW_RESIZE_CURSOR
.
Value Cursor.NW_RESIZE_CURSOR is assigned to NW_RESIZE_CURSOR.
public static final int NE_RESIZE_CURSOR
Cursor.NE_RESIZE_CURSOR
.
Value Cursor.NE_RESIZE_CURSOR is assigned to NE_RESIZE_CURSOR.
public static final int N_RESIZE_CURSOR
Cursor.N_RESIZE_CURSOR
.
Value Cursor.N_RESIZE_CURSOR is assigned to N_RESIZE_CURSOR.
public static final int S_RESIZE_CURSOR
Cursor.S_RESIZE_CURSOR
.
Value Cursor.S_RESIZE_CURSOR is assigned to S_RESIZE_CURSOR.
public static final int W_RESIZE_CURSOR
Cursor.W_RESIZE_CURSOR
.
Value Cursor.W_RESIZE_CURSOR is assigned to W_RESIZE_CURSOR.
public static final int E_RESIZE_CURSOR
Cursor.E_RESIZE_CURSOR
.
Value Cursor.E_RESIZE_CURSOR is assigned to E_RESIZE_CURSOR.
public static final int HAND_CURSOR
Cursor.HAND_CURSOR
.
Value Cursor.HAND_CURSOR is assigned to HAND_CURSOR.
public static final int MOVE_CURSOR
Cursor.MOVE_CURSOR
.
Value Cursor.MOVE_CURSOR is assigned to MOVE_CURSOR.
public static final int NORMAL
public static final int ICONIFIED
Constructor Detail |
public Frame()
Frame
that is
initially invisible. The title of the Frame
is empty.Component.setSize(int, int)
,
Component.setVisible(boolean)
public Frame(GraphicsConfiguration gc)
Frame
with the specified
GraphicsConfiguration
of
a screen device.gc
- the GraphicsConfiguration
of the target screen device. If gc
is null
, the system default
GraphicsConfiguration
is assumed.java.lang.IllegalArgumentException
- if
gc
is not from a screen device.public Frame(java.lang.String title)
Frame
object
with the specified title.
Note: This operation is subject to restriction in the PDA Profile.
title
- the title to be displayed in the frame's border.
A null
value
is treated as an empty string, "".java.lang.IllegalArgumentException
- if gc is not from
a screen device.Component.setSize(int, int)
,
Component.setVisible(boolean)
,
GraphicsConfiguration.getBounds()
public Frame(java.lang.String title, GraphicsConfiguration gc)
Frame
object
with the specified title and a
GraphicsConfiguration
.
Note: This operation is subject to restriction in the PDA Profile.
title
- the title to be displayed in the frame's border.
A null
value
is treated as an empty string, "".gc
- the GraphicsConfiguration
of the target screen device. If gc
is
null
, the system default
GraphicsConfiguration
is assumed.java.lang.IllegalArgumentException
- if gc
is not from a screen device.Component.setSize(int, int)
,
Component.setVisible(boolean)
,
GraphicsConfiguration.getBounds()
Method Detail |
protected void finalize() throws java.lang.Throwable
finalize
in class Window
public java.lang.String getTitle()
setTitle(java.lang.String)
public void setTitle(java.lang.String title)
Note: This operation is subject to restriction in the PDA Profile.
title
- the title to be displayed in the frame's bordertitle
- the title to be displayed in the frame's border.
A null
value
is treated as an empty string, "".getTitle()
public Image getIconImage()
null
if this frame doesn't have an icon image.setIconImage(java.awt.Image)
public void setIconImage(Image image)
image
- the icon image to be displayed.
If this parameter is null
then the
icon image is set to the default image, which may vary
with platform.getIconImage()
public MenuBar getMenuBar()
null
if this frame doesn't have a menu bar.setMenuBar(java.awt.MenuBar)
public void setMenuBar(MenuBar mb)
mb
- the menu bar being set.
If this parameter is null
then any
existing menu bar on this frame is removed.getMenuBar()
public boolean isResizable()
true
if the user can resize this frame;
false
otherwise.setResizable(boolean)
public void setResizable(boolean resizable)
Note: This operation is subject to restriction in the PDA Profile.
resizable
- true
if this frame is resizable;
false
otherwise.isResizable()
public void setState(int state)
Note: This operation is subject to restriction in the PDA Profile.
state
- Frame.ICONIFIED
if this frame is in
iconic state; Frame.NORMAL
if this frame is
in normal state.getState()
public int getState()
Frame.ICONIFIED
if frame in iconic state;
Frame.NORMAL
if frame is in normal state.setState(int)
public void remove(MenuComponent m)
remove
in interface MenuContainer
remove
in class Component
m
- the menu component to remove.
If this parameter is null
then a
NullPointerException is thrown and no action
is taken.protected java.lang.String paramString()
paramString
in class Container
java.awt.Container
public void setCursor(int cursorType)
Component.setCursor(Cursor)
.
public int getCursorType()
Component.getCursor()
.
|
PDAP 1.0 Spec, Rev. 0.16 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |