A Window object is a top-level window with no borders and no
menubar.
The default layout for a window is BorderLayout.
A window must have either a frame, dialog, or another window defined as its
owner when it's constructed.
In a multi-screen environment, you can create a Window
on a different screen device by constructing the Window
with
Window.Window(Window,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 device 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.
In such an environment, when calling setLocation,
you must pass a virtual coordinate to this method. Similarly,
calling getLocationOnScreen on a Window 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 a Window
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 Window 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.
Window w = new Window(Window owner, GraphicsConfiguration gc);
Rectangle bounds = gc.getBounds();
w.setLocation(10 + bounds.x, 10 + bounds.y);
Note: the location and size of top-level windows (including
Windows, Frames, and Dialogs)
are under the control of the desktop's window management system.
Calls to setLocation, setSize, and
setBounds are requests (not directives) which are
forwarded to the window management system. Every effort will be
made to honor such requests. However, in some cases the window
management system may ignore such requests, or modify the requested
geometry in order to place and size the Window in a way
that more closely matches the desktop settings.
Due to the asynchronous nature of native event handling, the results
returned by getBounds, getLocation,
getLocationOnScreen, and getSize might not
reflect the actual geometry of the Window on screen until the last
request has been processed. During the processing of subsequent
requests these values might change accordingly while the window
management system fulfills the requests.
An application may set the size and location of an invisible
Window arbitrarily, but the window management system may
subsequently change its size and/or location when the
Window is made visible. One or more
ComponentEvent s
will be generated to indicate the new geometry.
Windows are capable of generating the following WindowEvents:
WindowOpened, WindowClosed, WindowGainedFocus, WindowLostFocus.
version: @(#)Window.java 1.266 07/06/05 author: Sami Shaio author: Arthur van Hoff See Also:WindowEvent See Also:Window.addWindowListener See Also:java.awt.BorderLayout since: JDK1.0
Inner Class :static class WindowDisposerRecord implements sun.java2d.DisposerRecord
Inner Class :protected class AccessibleAWTWindow extends AccessibleAWTContainer
Window(GraphicsConfiguration gc) Constructs a new, initially invisible window in default size with the
specified GraphicsConfiguration.
If there is a security manager, this method first calls
the security manager's checkTopLevelWindow
method with this
as its argument to determine whether or not the window
must be displayed with a warning banner.
Window() Constructs a new, initially invisible window in the default size.
First, if there is a security manager, its
checkTopLevelWindow
method is called with this
as its argument
to see if it's ok to display the window without a warning banner.
public
Window(Frame owner) Constructs a new, initially invisible window with the specified
Frame as its owner.
public
Window(Window owner) Constructs a new, initially invisible window with the specified
Window as its owner.
public
Window(Window owner, GraphicsConfiguration gc) Constructs a new, initially invisible window with the specified owner
Window and a GraphicsConfiguration
of a screen device.
Method Summary
public void
addNotify() Makes this Window displayable by creating the connection to its
native screen resource.
createBufferStrategy(int numBuffers) Creates a new strategy for multi-buffering on this component.
Multi-buffering is useful for rendering performance.
public void
createBufferStrategy(int numBuffers, BufferCapabilities caps) Creates a new strategy for multi-buffering on this component with the
required buffer capabilities.
getIconImages() Returns the sequence of images to be displayed as the icon for this window.
This method returns a copy of the internally stored list, so all operations
on the returned object will not affect the window's behavior.
the copy of icon images' list for this window, or empty list if this window doesn't have icon images.
getWindows() Returns an array of all
Window s, both owned and ownerless,
created by this application.
If called from an applet, the array includes only the
Window s
accessible by that applet.
Warning: this method may return system created windows, such
as a print dialog.
public void
hide() Hide this Window, its subcomponents, and all of its owned children.
isAlwaysOnTop() Returns whether this window is an always-on-top window.
public boolean
isAlwaysOnTopSupported() Returns whether the always-on-top mode is supported for this
window.
public boolean
isAutoRequestFocus() Returns whether this window should receive focus on subsequently being shown
(with a call to
Window.setVisible setVisible(true) ), or being moved to the front
(with a call to
Window.toFront ).
final public boolean
isFocusCycleRoot() Always returns true because all Windows must be roots of a
focus traversal cycle.
final public 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.
public boolean
isFocused() Returns whether this Window is focused.
public 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.
processWindowEvent(WindowEvent e) Processes window events occurring on this window by
dispatching them to any registered WindowListener objects.
protected void
processWindowFocusEvent(WindowEvent e) Processes window focus event occuring on this window by
dispatching them to any registered WindowFocusListener objects.
NOTE: this method will not be called unless window focus events
are enabled for this window.
protected void
processWindowStateEvent(WindowEvent e) Processes window state event occuring on this window by
dispatching them to any registered WindowStateListener
objects.
NOTE: this method will not be called unless window state events
are enabled for this window.
setAlwaysOnTop(boolean alwaysOnTop) Sets whether this window should always be above other windows.
public void
setAutoRequestFocus(boolean autoRequestFocus) Sets whether this window should receive focus on
subsequently being shown (with a call to
Window.setVisible setVisible(true) ),
or being moved to the front (with a call to
Window.toFront ).
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 .
setCursor(Cursor cursor) Set the cursor image to a specified cursor.
The method may have no visual effect if the Java platform
implementation and/or the native system do not support
changing the mouse cursor shape.
Parameters: cursor - One of the constants definedby the Cursor class.
final public void
setFocusCycleRoot(boolean focusCycleRoot) Does nothing because Windows must always be roots of a focus traversal
cycle.
public void
setFocusableWindowState(boolean focusableWindowState) Sets whether this Window can become the focused Window if it meets
the other requirements outlined in isFocusableWindow.
public void
setIconImage(Image image) Sets the image to be displayed as the icon for this window.
This method can be used instead of
Window.setIconImages 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.
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.
This behavior resembles a native window shown without programmatically
setting its location.
icons is the graphical way we can
represent the frames and dialogs.
Window can't display icon but it's
being inherited by owned
Dialog s.
See Also:Window.getIconImages See Also: #setIconImages(List)
This represents the warning message that is
to be displayed in a non secure window. ie :
a window that has a security manager installed for
which calling SecurityManager.checkTopLevelWindow()
is false. This message can be displayed anywhere in
the window.
See Also:Window.getWarningString
Constructs a new, initially invisible window in default size with the
specified GraphicsConfiguration.
If there is a security manager, this method first calls
the security manager's checkTopLevelWindow
method with this
as its argument to determine whether or not the window
must be displayed with a warning banner.
Parameters: gc - the GraphicsConfiguration of the target screendevice. If gc is null, the system defaultGraphicsConfiguration is assumed exception: IllegalArgumentException - if gcis not from a screen device exception: HeadlessException - whenGraphicsEnvironment.isHeadless() returns true See Also:java.awt.GraphicsEnvironment.isHeadless See Also:java.lang.SecurityManager.checkTopLevelWindow See Also:
Constructs a new, initially invisible window in the default size.
First, if there is a security manager, its
checkTopLevelWindow
method is called with this
as its argument
to see if it's ok to display the window without a warning banner.
If the default implementation of checkTopLevelWindow
is used (that is, that method is not overriden), then this results in
a call to the security manager's checkPermission method
with an AWTPermission("showWindowWithoutWarningBanner")
permission. It that method raises a SecurityException,
checkTopLevelWindow returns false, otherwise it
returns true. If it returns false, a warning banner is created.
exception: HeadlessException - whenGraphicsEnvironment.isHeadless() returns true See Also:java.awt.GraphicsEnvironment.isHeadless See Also:java.lang.SecurityManager.checkTopLevelWindow
Constructs a new, initially invisible window with the specified
Frame as its owner. The window will not be focusable
unless its owner is showing on the screen.
If there is a security manager, this method first calls
the security manager's checkTopLevelWindow
method with this
as its argument to determine whether or not the window
must be displayed with a warning banner.
Parameters: owner - the Frame to act as owner or nullif this window has no owner exception: IllegalArgumentException - if the owner'sGraphicsConfiguration is not from a screen device exception: HeadlessException - whenGraphicsEnvironment.isHeadless returns true See Also:java.awt.GraphicsEnvironment.isHeadless See Also:java.lang.SecurityManager.checkTopLevelWindow See Also:Window.isShowing
Constructs a new, initially invisible window with the specified
Window as its owner. This window will not be focusable
unless its nearest owning Frame or Dialog
is showing on the screen.
If there is a security manager, this method first calls
the security manager's checkTopLevelWindow
method with this
as its argument to determine whether or not the window
must be displayed with a warning banner.
Parameters: owner - the Window to act as owner ornull if this window has no owner exception: IllegalArgumentException - if the owner'sGraphicsConfiguration is not from a screen device exception: HeadlessException - whenGraphicsEnvironment.isHeadless() returnstrue See Also:java.awt.GraphicsEnvironment.isHeadless See Also:java.lang.SecurityManager.checkTopLevelWindow See Also:Window.isShowing since: 1.2
Constructs a new, initially invisible window with the specified owner
Window and a GraphicsConfiguration
of a screen device. The Window will not be focusable unless
its nearest owning Frame or Dialog
is showing on the screen.
If there is a security manager, this method first calls
the security manager's checkTopLevelWindow
method with this
as its argument to determine whether or not the window
must be displayed with a warning banner.
Parameters: owner - the window to act as owner or nullif this window has no owner Parameters: gc - the GraphicsConfiguration of the targetscreen device; if gc is null,the system default GraphicsConfiguration is assumed exception: IllegalArgumentException - if gcis not from a screen device exception: HeadlessException - whenGraphicsEnvironment.isHeadless() returnstrue See Also:java.awt.GraphicsEnvironment.isHeadless See Also:java.lang.SecurityManager.checkTopLevelWindow See Also:GraphicsConfiguration.getBounds See Also:Window.isShowing since: 1.3
Makes this Window displayable by creating the connection to its
native screen resource.
This method is called internally by the toolkit and should
not be called directly by programs.
See Also:Component.isDisplayable See Also:Container.removeNotify since: JDK1.0
Construct a name for this component. Called by getName() when the
name is null.
createBufferStrategy
public void createBufferStrategy(int numBuffers)(Code)
Creates a new strategy for multi-buffering on this component.
Multi-buffering is useful for rendering performance. This method
attempts to create the best strategy available with the number of
buffers supplied. It will always create a BufferStrategy
with that number of buffers.
A page-flipping strategy is attempted first, then a blitting strategy
using accelerated buffers. Finally, an unaccelerated blitting
strategy is used.
Each time this method is called,
the existing buffer strategy for this component is discarded.
Parameters: numBuffers - number of buffers to create exception: IllegalArgumentException - if numBuffers is less than 1. exception: IllegalStateException - if the component is not displayable See Also:Window.isDisplayable See Also:Window.getBufferStrategy since: 1.4
Creates a new strategy for multi-buffering on this component with the
required buffer capabilities. This is useful, for example, if only
accelerated memory or page flipping is desired (as specified by the
buffer capabilities).
Each time this method
is called, the existing buffer strategy for this component is discarded.
Parameters: numBuffers - number of buffers to create, including the front buffer Parameters: caps - the required capabilities for creating the buffer strategy;cannot be null exception: AWTException - if the capabilities supplied could not besupported or met; this may happen, for example, if there is not enoughaccelerated memory currently available, or if page flipping is specifiedbut not possible. exception: IllegalArgumentException - if numBuffers is less than 1, or ifcaps is null See Also:Window.getBufferStrategy since: 1.4
Releases all of the native screen resources used by this
Window, its subcomponents, and all of its owned
children. That is, the resources for these Components
will be destroyed, any memory they consume will be returned to the
OS, and they will be marked as undisplayable.
The Window and its subcomponents can be made displayable
again by rebuilding the native resources with a subsequent call to
pack or show. The states of the recreated
Window and its subcomponents will be identical to the
states of these objects at the point where the Window
was disposed (not accounting for additional modifications between
those actions).
Gets the AccessibleContext associated with this Window.
For windows, the AccessibleContext takes the form of an
AccessibleAWTWindow.
A new AccessibleAWTWindow instance is created if necessary.
an AccessibleAWTWindow that serves as the AccessibleContext of this Window since: 1.3
Returns the BufferStrategy used by this component. This
method will return null if a BufferStrategy has not yet
been created or has been disposed.
the buffer strategy used by this component See Also:Window.createBufferStrategy since: 1.4
Always returns null because Windows have no ancestors; they
represent the top of the Component hierarchy.
null See Also:Container.isFocusCycleRoot since: 1.4
Returns the child Component of this Window that has focus if this Window
is focused; returns null otherwise.
the child Component with focus, or null if this Window is notfocused See Also:Window.getMostRecentFocusOwner See Also:Window.isFocused
Gets a focus traversal key for this Window. (See
setFocusTraversalKeys for a full description of each key.)
If the traversal key has not been explicitly set for this Window,
then this Window's parent's traversal key is returned. If the
traversal key has not been explicitly set for any of this Window's
ancestors, then the current KeyboardFocusManager's default traversal key
is returned.
Parameters: id - one of KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS,KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS,KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS, orKeyboardFocusManager.DOWN_CYCLE_TRAVERSAL_KEYS the AWTKeyStroke for the specified key See Also:Container.setFocusTraversalKeys See Also:KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS See Also:KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS See Also:KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS See Also:KeyboardFocusManager.DOWN_CYCLE_TRAVERSAL_KEYS throws: IllegalArgumentException - if id is not one ofKeyboardFocusManager.FORWARD_TRAVERSAL_KEYS,KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS,KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS, orKeyboardFocusManager.DOWN_CYCLE_TRAVERSAL_KEYS since: 1.4
Returns whether this Window can become the focused Window if it meets
the other requirements outlined in isFocusableWindow. If
this method returns false, then
isFocusableWindow will return false as well.
If this method returns true, then
isFocusableWindow may return true or
false depending upon the other requirements which must be
met in order for a Window to be focusable.
Returns the sequence of images to be displayed as the icon for this window.
This method returns a copy of the internally stored list, so all operations
on the returned object will not affect the window's behavior.
the copy of icon images' list for this window, or empty list if this window doesn't have icon images. See Also:Window.setIconImages See Also:Window.setIconImage(Image) since: 1.6
Gets the input context for this window. A window always has an input context,
which is shared by subcomponents unless they create and set their own.
See Also:Component.getInputContext since: 1.2
getListeners
public T[] getListeners(Class<T> listenerType)(Code)
Returns an array of all the objects currently registered
as FooListeners
upon this Window.
FooListeners are registered using the
addFooListener method.
You can specify the listenerType argument
with a class literal, such as
FooListener.class.
For example, you can query a
Windoww
for its window listeners with the following code:
If no such listeners exist, this method returns an empty array.
Parameters: listenerType - the type of listeners requested; this parametershould specify an interface that descends fromjava.util.EventListener an array of all objects registered asFooListeners on this window,or an empty array if no suchlisteners have been added exception: ClassCastException - if listenerTypedoesn't specify a class or interface that implementsjava.util.EventListener See Also:Window.getWindowListeners since: 1.3
Gets the Locale object that is associated
with this window, if the locale has been set.
If no locale has been set, then the default locale
is returned.
the locale that is set for this window. See Also:java.util.Locale since: JDK1.1
Returns the modal exclusion type of this window.
the modal exclusion type of this window See Also: java.awt.Dialog.ModalExclusionType See Also:java.awt.Window.setModalExclusionType since: 1.6
Returns the child Component of this Window that will receive the focus
when this Window is focused. If this Window is currently focused, this
method returns the same Component as getFocusOwner(). If
this Window is not focused, then the child Component that most recently
requested focus will be returned. If no child Component has ever
requested focus, and this is a focusable Window, then this Window's
initial focusable Component is returned. If no child Component has ever
requested focus, and this is a non-focusable Window, null is returned.
the child Component that will receive focus when this Window isfocused See Also:Window.getFocusOwner See Also:Window.isFocused See Also:Window.isFocusableWindow since: 1.4
public static Window[] getOwnerlessWindows()(Code)
Returns an array of all
Window s created by this application
that have no owner. They include
Frame s and ownerless
Dialog s and
Window s.
If called from an applet, the array includes only the
Window s
accessible by that applet.
Warning: this method may return system created windows, such
as a print dialog. Applications should not assume the existence of
these dialogs, nor should an application assume anything about these
dialogs such as component positions, LayoutManagers
or serialization.
See Also:Frame.getFrames See Also:Window.getWindows since: 1.6
Gets the warning string that is displayed with this window.
If this window is insecure, the warning string is displayed
somewhere in the visible area of the window. A window is
insecure if there is a security manager, and the security
manager's checkTopLevelWindow method returns
false when this window is passed to it as an
argument.
If the window is secure, then getWarningString
returns null. If the window is insecure, this
method checks for the system property
awt.appletWarning
and returns the string value of that property.
the warning string for this window. See Also:java.lang.SecurityManager.checkTopLevelWindow(java.lang.Object)
Returns an array of all the window focus listeners
registered on this window.
all of this window's WindowFocusListenersor an empty array if no window focuslisteners are currently registered See Also:Window.addWindowFocusListener See Also:Window.removeWindowFocusListener since: 1.4
Returns an array of all the window listeners
registered on this window.
all of this window's WindowListenersor an empty array if no windowlisteners are currently registered See Also:Window.addWindowListener See Also:Window.removeWindowListener since: 1.4
Returns an array of all the window state listeners
registered on this window.
all of this window's WindowStateListenersor an empty array if no window statelisteners are currently registered See Also:Window.addWindowStateListener See Also:Window.removeWindowStateListener since: 1.4
Returns an array of all
Window s, both owned and ownerless,
created by this application.
If called from an applet, the array includes only the
Window s
accessible by that applet.
Warning: this method may return system created windows, such
as a print dialog. Applications should not assume the existence of
these dialogs, nor should an application assume anything about these
dialogs such as component positions, LayoutManagers
or serialization.
See Also:Frame.getFrames See Also:Window.getOwnerlessWindows since: 1.6
Hide this Window, its subcomponents, and all of its owned children.
The Window and its subcomponents can be made visible again
with a call to
show .
See Also:Window.show See Also:Window.disposeWindow.setVisible(boolean)
Returns whether this Window is active. Only a Frame or a Dialog may be
active. The native windowing system may denote the active Window or its
children with special decorations, such as a highlighted title bar. The
active Window is always either the focused Window, or the first Frame or
Dialog that is an owner of the focused Window.
whether this is the active Window. See Also:Window.isFocused since: 1.4
Returns whether this window is an always-on-top window.
true, if the window is in always-on-top state, false otherwise See Also:Window.setAlwaysOnTop since: 1.5
Returns whether the always-on-top mode is supported for this
window. Some platforms may not support always-on-top windows, some
may support only some kinds of top-level windows; for example,
a platform may not support always-on-top modal dialogs.
true, if the always-on-top mode issupported by the toolkit and for this window,false, if always-on-top mode is not supportedfor this window or toolkit doesn't support always-on-top windows. See Also:Window.setAlwaysOnTop(boolean) See Also:Toolkit.isAlwaysOnTopSupported since: 1.6
Returns whether this window should receive focus on subsequently being shown
(with a call to
Window.setVisible setVisible(true) ), or being moved to the front
(with a call to
Window.toFront ).
By default, the window has
autoRequestFocus value of
true .
autoRequestFocus value See Also:Window.setAutoRequestFocus since: 1.7
Returns whether this Window can become the focused Window, that is,
whether this Window or any of its subcomponents can become the focus
owner. For a Frame or Dialog to be focusable, its focusable Window state
must be set to true. For a Window which is not a Frame or
Dialog to be focusable, its focusable Window state must be set to
true, its nearest owning Frame or Dialog must be
showing on the screen, and it must contain at least one Component in
its focus traversal cycle. If any of these conditions is not met, then
neither this Window nor any of its subcomponents can become the focus
owner.
true if this Window can be the focused Window;false otherwise See Also:Window.getFocusableWindowState See Also:Window.setFocusableWindowState See Also:Window.isShowing See Also:Component.isFocusable since: 1.4
Returns whether this Window is focused. If there exists a focus owner,
the focused Window is the Window that is, or contains, that focus owner.
If there is no focus owner, then no Window is focused.
If the focused Window is a Frame or a Dialog it is also the active
Window. Otherwise, the active Window is the first Frame or Dialog that
is an owner of the focused Window.
whether this is the focused Window. See Also:Window.isActive since: 1.4
Returns true if this Window will appear at the default location
for the native windowing system the next time this Window is made visible.
This method always returns false if the Window is showing on the
screen.
whether this Window will appear at the default location See Also:Window.setLocationByPlatform See Also:Window.isShowing since: 1.5
Determines whether this component will be displayed on the screen.
true if the component and all of its ancestorsuntil a toplevel window are visible, false otherwise
Causes this Window to be sized to fit the preferred size
and layouts of its subcomponents. The resulting width and
height of the window are automatically enlarged if either
of dimensions is less than the minimum size as specified
by the previous call to the
setMinimumSize method.
If the window and/or its owner are not displayable yet,
both of them are made displayable before calculating
the preferred size. The Window is validated after its
size is being calculated.
See Also:Component.isDisplayable See Also:Window.setMinimumSize
Implements a debugging hook -- checks to see if
the user has typed control-shift-F1. If so,
the list of child windows is dumped to System.out.
Parameters: e - the keyboard event
Processes events on this window. If the event is an
WindowEvent, it invokes the
processWindowEvent method, else it invokes its
superclass's processEvent.
Note that if the event parameter is null
the behavior is unspecified and may result in an
exception.
Parameters: e - the event
Processes window events occurring on this window by
dispatching them to any registered WindowListener objects.
NOTE: This method will not be called unless window events
are enabled for this component; this happens when one of the
following occurs:
A WindowListener object is registered via
addWindowListener
Window events are enabled via enableEvents
Note that if the event parameter is null
the behavior is unspecified and may result in an
exception.
Parameters: e - the window event See Also:Component.enableEvents
Processes window focus event occuring on this window by
dispatching them to any registered WindowFocusListener objects.
NOTE: this method will not be called unless window focus events
are enabled for this window. This happens when one of the
following occurs:
a WindowFocusListener is registered via
addWindowFocusListener
Window focus events are enabled via enableEvents
Note that if the event parameter is null
the behavior is unspecified and may result in an
exception.
Parameters: e - the window focus event See Also:Component.enableEvents since: 1.4
Processes window state event occuring on this window by
dispatching them to any registered WindowStateListener
objects.
NOTE: this method will not be called unless window state events
are enabled for this window. This happens when one of the
following occurs:
a WindowStateListener is registered via
addWindowStateListener
window state events are enabled via enableEvents
Note that if the event parameter is null
the behavior is unspecified and may result in an
exception.
Parameters: e - the window state event See Also:java.awt.Component.enableEvents since: 1.4
Removes the specified window focus listener so that it no longer
receives window events from this window.
If l is null, no exception is thrown and no action is performed.
Removes the specified window listener so that it no longer
receives window events from this window.
If l is null, no exception is thrown and no action is performed.
Removes the specified window state listener so that it no
longer receives window events from this window. If
l is null, no exception is thrown and
no action is performed.
Sets whether this window should always be above other windows. If
there are multiple always-on-top windows, their relative order is
unspecified and platform dependent.
If some other window is already always-on-top then the
relative order between these windows is unspecified (depends on
platform). No window can be brought to be over the always-on-top
window except maybe another always-on-top window.
All windows owned by an always-on-top window inherit this state and
automatically become always-on-top. If a window ceases to be
always-on-top, the windows that it owns will no longer be
always-on-top. When an always-on-top window is sent
Window.toBacktoBack , its always-on-top state is set to false.
When this method is called on a window with a value of
true, and the window is visible and the platform
supports always-on-top for this window, the window is immediately
brought forward, "sticking" it in the top-most position. If the
window isn`t currently visible, this method sets the always-on-top
state to true but does not bring the window forward.
When the window is later shown, it will be always-on-top.
When this method is called on a window with a value of
false the always-on-top state is set to normal. The
window remains in the top-most position but it`s z-order can be
changed as for any other window. Calling this method with a value
of false on a window that has a normal state has no
effect. Setting the always-on-top state to false has no effect on
the relative z-order of the windows if there are no other
always-on-top windows.
Note: some platforms might not support always-on-top
windows. To detect if always-on-top windows are supported by the
current platform, use
Toolkit.isAlwaysOnTopSupported and
Window.isAlwaysOnTopSupported . If always-on-top mode
isn't supported by the toolkit or for this window, calling this
method has no effect.
If a SecurityManager is installed, the calling thread must be
granted the AWTPermission "setWindowAlwaysOnTop" in
order to set the value of this property. If this
permission is not granted, this method will throw a
SecurityException, and the current value of the property will
be left unchanged.
Parameters: alwaysOnTop - true if the window should always be above otherwindows throws: SecurityException - if the calling thread does not havepermission to set the value of always-on-top property See Also:Window.isAlwaysOnTop See Also:Window.toFront See Also:Window.toBack See Also:AWTPermission See Also:Window.isAlwaysOnTopSupported See Also:Toolkit.isAlwaysOnTopSupported since: 1.5
setAutoRequestFocus
public void setAutoRequestFocus(boolean autoRequestFocus)(Code)
Sets whether this window should receive focus on
subsequently being shown (with a call to
Window.setVisible setVisible(true) ),
or being moved to the front (with a call to
Window.toFront ).
Note that
Window.setVisible setVisible(true) may be called indirectly
(e.g. when showing an owner of the window makes the window to be shown).
Window.toFront may also be called indirectly (e.g. when
Window.setVisible setVisible(true) is called on already visible window).
In all such cases this property takes effect as well.
The method may have no visual effect if the Java platform
implementation and/or the native system do not support
changing the mouse cursor shape.
Parameters: cursor - One of the constants definedby the Cursor class. If this parameter is nullthen the cursor for this window will be set to the typeCursor.DEFAULT_CURSOR. See Also:Component.getCursor See Also:Cursor since: JDK1.1
setFocusCycleRoot
final public void setFocusCycleRoot(boolean focusCycleRoot)(Code)
public void setFocusableWindowState(boolean focusableWindowState)(Code)
Sets whether this Window can become the focused Window if it meets
the other requirements outlined in isFocusableWindow. If
this Window's focusable Window state is set to false, then
isFocusableWindow will return false. If this
Window's focusable Window state is set to true, then
isFocusableWindow may return true or
false depending upon the other requirements which must be
met in order for a Window to be focusable.
Setting a Window's focusability state to false is the
standard mechanism for an application to identify to the AWT a Window
which will be used as a floating palette or toolbar, and thus should be
a non-focusable Window.
Setting the focusability state on a visible Window
can have a delayed effect on some platforms — the actual
change may happen only when the Window becomes
hidden and then visible again. To ensure consistent behavior
across platforms, set the Window's focusable state
when the Window is invisible and then show it.
Parameters: focusableWindowState - whether this Window can be the focusedWindow See Also:Window.isFocusableWindow See Also:Window.getFocusableWindowState See Also:Window.isShowing See Also:Component.setFocusable since: 1.4
Sets the image to be displayed as the icon for this window.
This method can be used instead of
Window.setIconImages 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. See Also:Window.setIconImages See Also:Window.getIconImages() since: 1.6
Sets the sequence of images to be displayed as the icon
for this window. Subsequent calls to
getIconImages will
always return a copy of the
icons list.
Depending on the platform capabilities one or several images
of different dimensions will be used as the window's icon.
The
icons list is scanned for the images of most
appropriate dimensions from the beginning. If the list contains
several images of the same size, the first will be used.
Ownerless windows with no icon specified use platfrom-default icon.
The icon of an owned window may be inherited from the owner
unless explicitly overridden.
Setting the icon to
null or empty list restores
the default behavior.
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: icons - the list of icon images to be displayed. See Also:Window.getIconImages() See Also:Window.setIconImage(Image) since: 1.6
setLocationByPlatform
public void setLocationByPlatform(boolean locationByPlatform)(Code)
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.
This behavior resembles a native window shown without programmatically
setting its location. Most windowing systems cascade windows if their
locations are not explicitly set. The actual location is determined once the
window is shown on the screen.
This behavior can also be enabled by setting the System Property
"java.awt.Window.locationByPlatform" to "true", though calls to this method
take precedence.
Calls to setVisible, setLocation and
setBounds after calling setLocationByPlatform clear
this property of the Window.
For example, after the following code is executed:
setLocationByPlatform(true);
setVisible(true);
boolean flag = isLocationByPlatform();
The window will be shown at platform's default location and
flag will be false.
In the following sample:
setLocationByPlatform(true);
setLocation(10, 10);
boolean flag = isLocationByPlatform();
setVisible(true);
The window will be shown at (10, 10) and flag will be
false.
Parameters: locationByPlatform - true if this Window should appearat the default location, false if at the current location IllegalComponentStateException if the windowis showing on screen and locationByPlatform is true. See Also:Window.setLocation See Also:Window.isShowing See Also:Window.setVisible See Also:Window.isLocationByPlatform See Also:java.lang.System.getProperty(String) since: 1.5
Sets the location of the window relative to the specified
component.
If the component is not currently showing, or c
is null, the window is placed at the center of
the screen. The center point can be determined with
GraphicsEnvironment.getCenterPoint GraphicsEnvironment.getCenterPoint
If the bottom of the component is offscreen, the window is
placed to the side of the Component that is
closest to the center of the screen. So if the Component
is on the right part of the screen, the Window
is placed to its left, and vice versa.
Parameters: c - the component in relation to which the window's locationis determined See Also:java.awt.GraphicsEnvironment.getCenterPoint since: 1.4
Sets the minimum size of this window to a constant
value. Subsequent calls to
getMinimumSize will always return this value. If current window's
size is less than
minimumSize the size of the
window is automatically enlarged to honor the minimum size.
If the
setSize or
setBounds methods
are called afterwards with a width or height less than
that was specified by the
setMinimumSize method
the window is automatically enlarged to meet
the
minimumSize value. The
minimumSize
value also affects the behaviour of the
pack method.
The default behavior is restored by setting the minimum size
parameter to the
null value.
Specifies the modal exclusion type for this window. If a window is modal
excluded, it is not blocked by some modal dialogs. See
java.awt.Dialog.ModalExclusionType Dialog.ModalExclusionType for
possible modal exclusion types.
If the given type is not supported, NO_EXCLUDE is used.
Note: changing the modal exclusion type for a visible window may have no
effect until it is hidden and then shown again.
Parameters: exclusionType - the modal exclusion type for this window; a nullvalue is equivivalent to Dialog.ModalExclusionType.NO_EXCLUDENO_EXCLUDE throws: SecurityException - if the calling thread does not have permissionto set the modal exclusion property to the window with the givenexclusionType See Also: java.awt.Dialog.ModalExclusionType See Also:java.awt.Window.getModalExclusionType See Also:java.awt.Toolkit.isModalExclusionTypeSupported since: 1.6
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 .
See Also:Window.getSize See Also:Window.setBounds See Also:Window.setMinimumSize since: 1.6
The
width and
height values
are automatically enlarged if either is less than
the minimum size as specified by previous call to
setMinimumSize .
See Also:Window.getSize See Also:Window.setBounds See Also:Window.setMinimumSize since: 1.6
The
Window 's
autoRequestFocus property is of the
true value.
Native windowing system allows the
Window to get focused.
There is an exception for the second condition (the value of the
autoRequestFocus property). The property is not taken into account if the
window is a modal dialog, which blocks the currently focused window.
Developers must never assume that the window is the focused or active window
until it receives a WINDOW_GAINED_FOCUS or WINDOW_ACTIVATED event.
Parameters: b - if true , makes the Window visible, otherwise hides the Window .If the Window and/or its ownerare not yet displayable, both are made displayable. The Window will be validated prior to being made visible. If the Window is already visible, this will bring the Window to the front.
Makes the Window visible. If the Window and/or its owner
are not yet displayable, both are made displayable. The
Window will be validated prior to being made visible.
If the Window is already visible, this will bring the Window
to the front.
See Also:Component.isDisplayable See Also:Window.toFrontWindow.setVisible(boolean)
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.
Places this Window at the bottom of the stacking order and shows it
behind any other Windows in this VM. No action will take place is this
Window is not visible. Some platforms do not allow Windows which are
owned by other Windows to appear below their owners. Every attempt will
be made to move this Window as low as possible in the stacking order;
however, developers should not assume that this method will move this
Window below all other windows in every situation.
Because of variations in native windowing systems, no guarantees about
changes to the focused and active Windows can be made. Developers must
never assume that this Window is no longer the focused or active Window
until this Window receives a WINDOW_LOST_FOCUS or WINDOW_DEACTIVATED
event. On platforms where the top-most window is the focused window,
this method will probably cause this Window to lose focus. In
that case, the next highest, focusable Window in this VM will receive
focus. On platforms where the stacking order does not typically affect
the focused window, this method will probably leave the focused
and active Windows unchanged.
See Also:Window.toFront
If this Window is visible, brings this Window to the front and may make
it the focused Window.
Places this Window at the top of the stacking order and shows it in
front of any other Windows in this VM. No action will take place if this
Window is not visible. Some platforms do not allow Windows which own
other Windows to appear on top of those owned Windows. Some platforms
may not permit this VM to place its Windows above windows of native
applications, or Windows of other VMs. This permission may depend on
whether a Window in this VM is already focused. Every attempt will be
made to move this Window as high as possible in the stacking order;
however, developers should not assume that this method will move this
Window above all other windows in every situation.
Developers must never assume that this Window is the focused or active
Window until this Window receives a WINDOW_GAINED_FOCUS or WINDOW_ACTIVATED
event. On platforms where the top-most window is the focused window, this
method will probably focus this Window (if it is not already focused)
under the following conditions:
The window's property
autoRequestFocus is of the
true value.
Native windowing system allows the window to get focused.
On platforms where the stacking order does not typically affect the focused
window, this method will probably leave the focused and active
Windows unchanged.
If this method causes this Window to be focused, and this Window is a
Frame or a Dialog, it will also become activated. If this Window is
focused, but it is not a Frame or a Dialog, then the first Frame or
Dialog that is an owner of this Window will be activated.
