java.awt
Class Window

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window

All Implemented Interfaces:

Accessible, java.awt.image.ImageObserver, MenuContainer, Serializable

Direct Known Subclasses:

Dialog, Frame, JWindow

public class Window

extends Container

implements Accessible

Unsafe:

See Also:

Serialized Form

Field Summary

private static String	base
private static sun.awt.DebugHelper	dbg
private boolean	focusableWindowState Indicates whether this Window can become the focused Window.
private FocusManager	focusMgr Unused.
(package private) java.awt.im.InputContext	inputContext
private Object	inputContextLock
(package private) boolean	isFirstPack
private static int	nameCounter
(package private) static int	OPENED
(package private) Vector	ownedWindowList A vector containing all the windows this window currently owns.
private static long	serialVersionUID
private boolean	showWithParent
(package private) int	state An Integer value representing the Window State.
(package private) boolean	syncLWRequests
(package private) static boolean	systemSyncLWRequests
(package private) String	warningString This represents the warning message that is to be displayed in a non secure window.
private java.lang.ref.WeakReference	weakThis
(package private) WindowFocusListener	windowFocusListener
(package private) WindowListener	windowListener
private int	windowSerializedDataVersion The window serialized data version.
(package private) WindowStateListener	windowStateListener

Fields inherited from class java.awt.Container

component, containerListener, descendantsCount, INCLUDE_SELF, layoutMgr, listeningBoundsChildren, listeningChildren, ncomponents, SEARCH_HEAVYWEIGHTS

Fields inherited from class java.awt.Component

accessibleContext, actionListenerK, adjustmentListenerK, appContext, background, BOTTOM_ALIGNMENT, bufferStrategy, CENTER_ALIGNMENT, componentListener, componentListenerK, componentOrientation, containerListenerK, cursor, dropTarget, enabled, eventMask, focusListener, focusListenerK, focusTraversalKeys, font, foreground, graphicsConfig, height, hierarchyBoundsListener, hierarchyBoundsListenerK, hierarchyListener, hierarchyListenerK, ignoreRepaint, incRate, inputMethodListener, inputMethodListenerK, isInc, isPacked, itemListenerK, keyListener, keyListenerK, LEFT_ALIGNMENT, locale, LOCK, metrics, minSize, mouseListener, mouseListenerK, mouseMotionListener, mouseMotionListenerK, mouseWheelListener, mouseWheelListenerK, newEventsOnly, ownedWindowK, parent, peer, peerFont, popups, prefSize, RIGHT_ALIGNMENT, textListenerK, TOP_ALIGNMENT, valid, visible, width, windowClosingException, windowFocusListenerK, windowListenerK, windowStateListenerK, x, y

Constructor Summary

(package private)	Window() Constructs a new window in the default size.
	Window(Frame owner) Suppressed: Constructs a new invisible window with the specified Frame as its owner.
(package private)	Window(GraphicsConfiguration gc) Constructs a new window in default size with the specified GraphicsConfiguration.
	Window(Window owner) Suppressed: Constructs a new invisible window with the specified Window as its owner.
	Window(Window owner, GraphicsConfiguration gc) Suppressed: Constructs a new invisible window with the specified window as its owner and a GraphicsConfiguration of a screen device.

Method Summary

void	addNotify() Suppressed: Makes this Window displayable by creating the connection to its native screen resource.
(package private) void	addOwnedWindow(java.lang.ref.WeakReference weakWindow)
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Suppressed: Adds a PropertyChangeListener to the listener list.
void	addPropertyChangeListener(String propertyName, java.beans.PropertyChangeListener listener) Suppressed: Adds a PropertyChangeListener to the listener list for a specific property.
void	addWindowFocusListener(WindowFocusListener l) Suppressed: Adds the specified window focus listener to receive window events from this window.
void	addWindowListener(WindowListener l) Enabled: Adds the specified window listener to receive window events from this window.
void	addWindowStateListener(WindowStateListener l) Suppressed: Adds the specified window state listener to receive window events from this window.
(package private) void	adjustDecendantsOnParent(int num)
(package private) void	adjustListeningChildrenOnParent(long mask, int num)
void	applyResourceBundle(ResourceBundle rb) Deprecated. As of J2SE 1.4, replaced by Component.applyComponentOrientation.
void	applyResourceBundle(String rbName) Deprecated. As of J2SE 1.4, replaced by Component.applyComponentOrientation.
(package private) void	clearMostRecentFocusOwnerOnHide()
(package private) void	connectOwnedWindow(Window child)
(package private) String	constructComponentName() Construct a name for this component.
void	createBufferStrategy(int numBuffers) Enabled: Creates a new strategy for multi-buffering on this component.
void	createBufferStrategy(int numBuffers, BufferCapabilities caps) Enabled: Creates a new strategy for multi-buffering on this component with the required buffer capabilities.
(package private) void	deliverMouseWheelToAncestor(MouseWheelEvent e) Overridden from Component.
(package private) void	dispatchEventImpl(AWTEvent e) Dispatches an event to this window or one of its sub components.
(package private) boolean	dispatchMouseWheelToAncestor(MouseWheelEvent e) Overridden from Component.
void	dispose() Enabled: Releases all of the native screen resources used by this Window, its subcomponents, and all of its owned children.
(package private) boolean	eventEnabled(AWTEvent e)
protected void	finalize() Disposes of the input methods and context, and removes the WeakReference which formerly pointed to this Window from the parent's owned Window list.
AccessibleContext	getAccessibleContext() Suppressed: Gets the AccessibleContext associated with this Window.
java.awt.image.BufferStrategy	getBufferStrategy() Enabled: @return the buffer strategy used by this component
boolean	getFocusableWindowState() Suppressed: Returns whether this Window can become the focused Window if it meets the other requirements outlined in isFocusableWindow.
Container	getFocusCycleRootAncestor() Suppressed: Always returns null because Windows have no ancestors; they represent the top of the Component hierarchy.
Component	getFocusOwner() Suppressed: Returns the child Component of this Window that has focus if this Window is focused; returns null otherwise.
Set	getFocusTraversalKeys(int id) Enabled: Gets a focus traversal key for this Window.
GraphicsConfiguration	getGraphicsConfiguration() Suppressed: This method returns the GraphicsConfiguration used by this Window.
java.awt.im.InputContext	getInputContext() Suppressed: Gets the input context for this window.
EventListener[]	getListeners(Class listenerType) Suppressed: Returns an array of all the objects currently registered as FooListeners upon this Window.
Locale	getLocale() Suppressed: Gets the Locale object that is associated with this window, if the locale has been set.
Component	getMostRecentFocusOwner() Suppressed: Returns the child Component of this Window that will receive the focus when this Window is focused.
Window[]	getOwnedWindows() Suppressed: Return an array containing all the windows this window currently owns.
Window	getOwner() Suppressed: Returns the owner of this window.
Toolkit	getToolkit() Suppressed: Returns the toolkit of this frame.
String	getWarningString() Suppressed: Gets the warning string that is displayed with this window.
WindowFocusListener[]	getWindowFocusListeners() Suppressed: Returns an array of all the window focus listeners registered on this window.
WindowListener[]	getWindowListeners() Suppressed: Returns an array of all the window listeners registered on this window.
WindowStateListener[]	getWindowStateListeners() Suppressed: Returns an array of all the window state listeners registered on this window.
void	hide() Enabled: Hide this Window, its subcomponents, and all of its owned children.
private void	init(GraphicsConfiguration gc)
private static void	initIDs() Initialize JNI field and method IDs for fields that may be accessed from C.
boolean	isActive() Enabled: Returns whether this Window is active.
boolean	isFocusableWindow() Suppressed: 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	isFocusCycleRoot() Suppressed: Always returns true because all Windows must be roots of a focus traversal cycle.
boolean	isFocused() Enabled: Returns whether this Window is focused.
boolean	isShowing() Enabled: Checks if this Window is showing on screen.
private void	ownedInit(Window owner)
void	pack() Enabled: Causes this Window to be sized to fit the preferred size and layouts of its subcomponents.
boolean	postEvent(Event e) Suppressed: @deprecated As of JDK version 1.1 replaced by dispatchEvent(AWTEvent).
(package private) void	postProcessKeyEvent(KeyEvent e)
(package private) void	postWindowEvent(int id)
(package private) void	preProcessKeyEvent(KeyEvent e) Implements a debugging hook -- checks to see if the user has typed control-shift-F1.
protected void	processEvent(AWTEvent e) Processes events on this window.
protected void	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.
protected void	processWindowStateEvent(WindowEvent e) Processes window state event occuring on this window by dispatching them to any registered WindowStateListener objects.
private void	readObject(ObjectInputStream s) Reads the ObjectInputStream and an optional list of listeners to receive various events fired by the component; also reads a list of (possibly null) child windows.
(package private) void	removeOwnedWindow(java.lang.ref.WeakReference weakWindow)
void	removeWindowFocusListener(WindowFocusListener l) Suppressed: Removes the specified window focus listener so that it no longer receives window events from this window.
void	removeWindowListener(WindowListener l) Enabled: Removes the specified window listener so that it no longer receives window events from this window.
void	removeWindowStateListener(WindowStateListener l) Suppressed: Removes the specified window state listener so that it no longer receives window events from this window.
(package private) void	resetGC() Reset this Window's GraphicsConfiguration to match its peer.
void	setCursor(Cursor cursor) Suppressed: Set the cursor image to a specified cursor.
void	setFocusableWindowState(boolean focusableWindowState) Suppressed: Sets whether this Window can become the focused Window if it meets the other requirements outlined in isFocusableWindow.
void	setFocusCycleRoot(boolean focusCycleRoot) Suppressed: Does nothing because Windows must always be roots of a focus traversal cycle.
void	setLocationRelativeTo(Component c) Enabled: Sets the location of the window relative to the specified component.
private void	setWarningString()
void	show() Enabled: Makes the Window visible.
void	toBack() Enabled: 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() Suppressed: If this Window is visible, brings this Window to the front and may make it the focused Window.
private void	writeObject(ObjectOutputStream s) Writes default serializable fields to stream.

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, adjustDescendants, adjustListeningChildren, applyComponentOrientation, areFocusTraversalKeysSet, checkGD, clearCurrentFocusCycleRootOnHide, containsFocus, countComponents, countHierarchyMembers, createChildHierarchyEvents, createHierarchyEvents, deliverEvent, dispatchEventToSelf, doLayout, findComponentAt, findComponentAt, findComponentAt, get, getAccessibleAt, getAccessibleChild, getAccessibleChildrenCount, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents_NoClientCode, getComponents, getContainerListeners, getDropTargetEventTarget, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMouseEventTarget, getPreferredSize, initializeFocusTraversalKeys, insets, invalidate, invalidateTree, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, iterate, layout, lightweightPaint, lightweightPrint, list, list, locate, minimumSize, nextFocusHelper, numListening, paint, paintComponents, paintHeavyweightComponents, paramString, postsOldMouseEvents, preferredSize, print, printComponents, printHeavyweightComponents, processContainerEvent, proxyEnableEvents, remove, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, setLayout, setZOrder, size, transferFocusBackward, transferFocusDownCycle, update, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, areInputMethodsEnabled, autoProcessMouseWheel, autoTransferFocus, bounds, checkImage, checkImage, checkWindowClosingException, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, eventTypeEnabled, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleIndexInParent, getAccessibleStateSet, getBackBuffer, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeys_NoIDCheck, getFocusTraversalKeysEnabled, getFont_NoClientCode, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen_NoTreeLock, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getNativeContainer, getParent_NoClientCode, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkitImpl, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isEnabledImpl, isFocusable, isFocusOwner, isFocusTraversable, isFocusTraversableOverridden, isFontSet, isForegroundSet, isLightweight, isOpaque, isRecursivelyVisible, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusHelper, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys_NoIDCheck, setFocusTraversalKeysEnabled, setForeground, setGCFromPeer, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, toString, transferFocus, transferFocus, transferFocusUpCycle, updateCursorImmediately

Methods inherited from class java.lang.Object

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

Field Detail

warningString

String warningString

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:

getWarningString()

systemSyncLWRequests

static boolean systemSyncLWRequests

syncLWRequests

boolean syncLWRequests

isFirstPack

boolean isFirstPack

OPENED

static final int OPENED

state

int state

An Integer value representing the Window State.

Since:

1.2

See Also:

show()

ownedWindowList

transient Vector ownedWindowList

A vector containing all the windows this window currently owns.

Since:

1.2

See Also:

getOwnedWindows()

weakThis

private transient java.lang.ref.WeakReference weakThis

showWithParent

private transient boolean showWithParent

windowListener

transient WindowListener windowListener

windowStateListener

transient WindowStateListener windowStateListener

windowFocusListener

transient WindowFocusListener windowFocusListener

inputContext

transient java.awt.im.InputContext inputContext

inputContextLock

private transient Object inputContextLock

focusMgr

private FocusManager focusMgr

Unused. Maintained for serialization backward-compatibility.

Since:

1.2

focusableWindowState

private boolean focusableWindowState

Indicates whether this Window can become the focused Window.

Since:

1.4

See Also:

getFocusableWindowState(), setFocusableWindowState(boolean)

base

private static final String base

nameCounter

private static int nameCounter

serialVersionUID

private static final long serialVersionUID

dbg

private static final sun.awt.DebugHelper dbg

windowSerializedDataVersion

private int windowSerializedDataVersion

The window serialized data version.

Constructor Detail

Window

Window(GraphicsConfiguration gc)

Constructs a new 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 screen device. If gc is null, the system default GraphicsConfiguration is assumed.

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.lang.SecurityManager#checkTopLevelWindow

Window

Window()
 throws HeadlessException

Constructs a new 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.

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.lang.SecurityManager#checkTopLevelWindow

Window

public Window(Frame owner)

Suppressed: Constructs a new 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

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.lang.SecurityManager#checkTopLevelWindow, isShowing()

Window

public Window(Window owner)

Suppressed: Constructs a new invisible window with the specified Window as its owner. 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

Since:

1.2

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.lang.SecurityManager#checkTopLevelWindow, isShowing()

Window

public Window(Window owner,
              GraphicsConfiguration gc)

Suppressed: Constructs a new invisible window with the specified window as its owner 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

gc - the GraphicsConfiguration of the target screen device; if gc is null, the system default GraphicsConfiguration is assumed

Throws:

IllegalArgumentException - if owner is null

IllegalArgumentException - if gc is not from a screen device; this exception is always thrown when GraphicsEnvironment.isHeadless returns true

Since:

1.3

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.lang.SecurityManager#checkTopLevelWindow, GraphicsConfiguration.getBounds(), isShowing()

Method Detail

initIDs

private static void initIDs()

Initialize JNI field and method IDs for fields that may be accessed from C.

init

private void init(GraphicsConfiguration gc)

ownedInit

private void ownedInit(Window owner)

finalize

protected void finalize()
                 throws Throwable

Disposes of the input methods and context, and removes the WeakReference which formerly pointed to this Window from the parent's owned Window list.

Overrides:

finalize in class Object

Throws:

Throwable - the Exception raised by this method

constructComponentName

String constructComponentName()

Construct a name for this component. Called by getName() when the name is null.

Overrides:

constructComponentName in class Component

addNotify

public void addNotify()

Suppressed: 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.

Overrides:

addNotify in class Container

Since:

JDK1.0

See Also:

Component.isDisplayable(), Container.removeNotify()

pack

public void pack()

Enabled: Causes this Window to be sized to fit the preferred size and layouts of its subcomponents. If the window and/or its owner are not yet displayable, both are made displayable before calculating the preferred size. The Window will be validated after the preferredSize is calculated.

See Also:

Component.isDisplayable()

show

public void show()

Enabled: 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.

Overrides:

show in class Component

See Also:

Component.isDisplayable(), toFront(), Component.setVisible(boolean)

postWindowEvent

void postWindowEvent(int id)

hide

public void hide()

Enabled: 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.

Overrides:

hide in class Component

See Also:

show(), dispose()

clearMostRecentFocusOwnerOnHide

final void clearMostRecentFocusOwnerOnHide()

Overrides:

clearMostRecentFocusOwnerOnHide in class Container

dispose

public void dispose()

Enabled: 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 modifcations between those actions).

See Also:

Component.isDisplayable(), pack(), show()

adjustListeningChildrenOnParent

void adjustListeningChildrenOnParent(long mask,
                                     int num)

Overrides:

adjustListeningChildrenOnParent in class Component

adjustDecendantsOnParent

void adjustDecendantsOnParent(int num)

Overrides:

adjustDecendantsOnParent in class Container

toFront

public void toFront()

Suppressed: 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 is 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.

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

See Also:

toBack()

toBack

public void toBack()

Enabled: 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:

toFront()

getToolkit

public Toolkit getToolkit()

Suppressed: Returns the toolkit of this frame.

Overrides:

getToolkit in class Component

Returns:

the toolkit of this window.

See Also:

Toolkit, Toolkit.getDefaultToolkit(), Component.getToolkit()

getWarningString

public final String getWarningString()

Suppressed: 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.

Returns:

the warning string for this window.

See Also:

java.lang.SecurityManager#checkTopLevelWindow(java.lang.Object)

setWarningString

private void setWarningString()

getLocale

public Locale getLocale()

Suppressed: 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.

Overrides:

getLocale in class Component

Returns:

the locale that is set for this window.

Since:

JDK1.1

See Also:

java.util.Locale

getInputContext

public java.awt.im.InputContext getInputContext()

Suppressed: 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.

Overrides:

getInputContext in class Component

Returns:

the input context used by this component; null if no context can be determined

Since:

1.2

See Also:

Component.getInputContext()

setCursor

public void setCursor(Cursor cursor)

Suppressed: Set the cursor image to a specified cursor.

Overrides:

setCursor in class Component

Parameters:

cursor - One of the constants defined by the Cursor class; if this parameter is null then this component will inherit the cursor of its parent

Since:

JDK1.1

See Also:

Component.getCursor(), Cursor

getOwner

public Window getOwner()

Suppressed: Returns the owner of this window.

Since:

1.2

getOwnedWindows

public Window[] getOwnedWindows()

Suppressed: Return an array containing all the windows this window currently owns.

Since:

1.2

addWindowListener

public void addWindowListener(WindowListener l)

Enabled: Adds the specified window listener to receive window events from this window. If l is null, no exception is thrown and no action is performed.

Parameters:

l - the window listener

See Also:

removeWindowListener(java.awt.event.WindowListener), getWindowListeners()

addWindowStateListener

public void addWindowStateListener(WindowStateListener l)

Suppressed: Adds the specified window state listener to receive window events from this window. If l is null, no exception is thrown and no action is performed.

Parameters:

l - the window state listener

Since:

1.4

See Also:

removeWindowStateListener(java.awt.event.WindowStateListener), getWindowStateListeners()

addWindowFocusListener

public void addWindowFocusListener(WindowFocusListener l)

Suppressed: Adds the specified window focus listener to receive window events from this window. If l is null, no exception is thrown and no action is performed.

Parameters:

l - the window focus listener

See Also:

removeWindowFocusListener(java.awt.event.WindowFocusListener), getWindowFocusListeners()

removeWindowListener

public void removeWindowListener(WindowListener l)

Enabled: 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.

Parameters:

l - the window listener

See Also:

addWindowListener(java.awt.event.WindowListener), getWindowListeners()

removeWindowStateListener

public void removeWindowStateListener(WindowStateListener l)

Suppressed: 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.

Parameters:

l - the window state listener

Since:

1.4

See Also:

addWindowStateListener(java.awt.event.WindowStateListener), getWindowStateListeners()

removeWindowFocusListener

public void removeWindowFocusListener(WindowFocusListener l)

Suppressed: 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.

Parameters:

l - the window focus listener

See Also:

addWindowFocusListener(java.awt.event.WindowFocusListener), getWindowFocusListeners()

getWindowListeners

public WindowListener[] getWindowListeners()

Suppressed: Returns an array of all the window listeners registered on this window.

Returns:

all of this window's WindowListeners or an empty array if no window listeners are currently registered

Since:

1.4

See Also:

addWindowListener(java.awt.event.WindowListener), removeWindowListener(java.awt.event.WindowListener)

getWindowFocusListeners

public WindowFocusListener[] getWindowFocusListeners()

Suppressed: Returns an array of all the window focus listeners registered on this window.

Returns:

all of this window's WindowFocusListeners or an empty array if no window focus listeners are currently registered

Since:

1.4

See Also:

addWindowFocusListener(java.awt.event.WindowFocusListener), removeWindowFocusListener(java.awt.event.WindowFocusListener)

getWindowStateListeners

public WindowStateListener[] getWindowStateListeners()

Suppressed: Returns an array of all the window state listeners registered on this window.

Returns:

all of this window's WindowStateListeners or an empty array if no window state listeners are currently registered

Since:

1.4

See Also:

addWindowStateListener(java.awt.event.WindowStateListener), removeWindowStateListener(java.awt.event.WindowStateListener)

getListeners

public EventListener[] getListeners(Class listenerType)

Suppressed: 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 Window w for its window listeners with the following code:

WindowListener[] wls = (WindowListener[])(w.getListeners(WindowListener.class));

If no such listeners exist, this method returns an empty array.

Overrides:

getListeners in class Container

Parameters:

listenerType - the type of listeners requested; this parameter should specify an interface that descends from java.util.EventListener

Returns:

an array of all objects registered as FooListeners on this window, or an empty array if no such listeners have been added

Since:

1.3

See Also:

getWindowListeners()

eventEnabled

boolean eventEnabled(AWTEvent e)

Overrides:

eventEnabled in class Container

processEvent

protected void processEvent(AWTEvent e)

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.

Overrides:

processEvent in class Container

Parameters:

e - the event

processWindowEvent

protected void processWindowEvent(WindowEvent e)

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(long)

processWindowFocusEvent

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. 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(long)

processWindowStateEvent

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

Since:

1.4

See Also:

java.awt.Component#enableEvents

preProcessKeyEvent

void preProcessKeyEvent(KeyEvent e)

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.

Overrides:

preProcessKeyEvent in class Container

Parameters:

e - the keyboard event

postProcessKeyEvent

void postProcessKeyEvent(KeyEvent e)

Overrides:

postProcessKeyEvent in class Container

getFocusOwner

public Component getFocusOwner()

Suppressed: Returns the child Component of this Window that has focus if this Window is focused; returns null otherwise.

Returns:

the child Component with focus, or null if this Window is not focused

See Also:

getMostRecentFocusOwner(), isFocused()

getMostRecentFocusOwner

public Component getMostRecentFocusOwner()

Suppressed: 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.

Returns:

the child Component that will receive focus when this Window is focused

Since:

1.4

See Also:

getFocusOwner(), isFocused(), isFocusableWindow()

isActive

public boolean isActive()

Enabled: 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.

Returns:

whether this is the active Window.

Since:

1.4

See Also:

isFocused()

isFocused

public boolean isFocused()

Enabled: 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.

Returns:

whether this is the focused Window.

Since:

1.4

See Also:

isActive()

getFocusTraversalKeys

public Set getFocusTraversalKeys(int id)

Enabled: 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.

Overrides:

getFocusTraversalKeys in class Container

Parameters:

id - one of KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS, KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS, or KeyboardFocusManager.DOWN_CYCLE_TRAVERSAL_KEYS

Returns:

the AWTKeyStroke for the specified key

Throws:

IllegalArgumentException - if id is not one of KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS, KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS, or KeyboardFocusManager.DOWN_CYCLE_TRAVERSAL_KEYS

Since:

1.4

See Also:

Container.setFocusTraversalKeys(int, java.util.Set), KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS, KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS, KeyboardFocusManager.DOWN_CYCLE_TRAVERSAL_KEYS

setFocusCycleRoot

public final void setFocusCycleRoot(boolean focusCycleRoot)

Suppressed: Does nothing because Windows must always be roots of a focus traversal cycle. The passed-in value is ignored.

Overrides:

setFocusCycleRoot in class Container

Parameters:

focusCycleRoot - this value is ignored

Since:

1.4

See Also:

isFocusCycleRoot(), Container.setFocusTraversalPolicy(java.awt.FocusTraversalPolicy), Container.getFocusTraversalPolicy()

isFocusCycleRoot

public final boolean isFocusCycleRoot()

Suppressed: Always returns true because all Windows must be roots of a focus traversal cycle.

Overrides:

isFocusCycleRoot in class Container

Returns:

true

Since:

1.4

See Also:

setFocusCycleRoot(boolean), Container.setFocusTraversalPolicy(java.awt.FocusTraversalPolicy), Container.getFocusTraversalPolicy()

getFocusCycleRootAncestor

public final Container getFocusCycleRootAncestor()

Suppressed: Always returns null because Windows have no ancestors; they represent the top of the Component hierarchy.

Overrides:

getFocusCycleRootAncestor in class Component

Returns:

null

Since:

1.4

See Also:

Container.isFocusCycleRoot()

isFocusableWindow

public final boolean isFocusableWindow()

Suppressed: 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.

Returns:

true if this Window can be the focused Window; false otherwise

Since:

1.4

See Also:

getFocusableWindowState(), setFocusableWindowState(boolean), isShowing(), Component.isFocusable()

getFocusableWindowState

public boolean getFocusableWindowState()

Suppressed: 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.

By default, all Windows have a focusable Window state of true.

Returns:

whether this Window can be the focused Window

Since:

1.4

See Also:

isFocusableWindow(), setFocusableWindowState(boolean), isShowing(), Component.setFocusable(boolean)

setFocusableWindowState

public void setFocusableWindowState(boolean focusableWindowState)

Suppressed: 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.

Parameters:

focusableWindowState - whether this Window can be the focused Window

Since:

1.4

See Also:

isFocusableWindow(), getFocusableWindowState(), isShowing(), Component.setFocusable(boolean)

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Suppressed: Adds a PropertyChangeListener to the listener list. The listener is registered for all bound properties of this class, including the following:

• this Window's font ("font")
• this Window's background color ("background")
• this Window's foreground color ("foreground")
• this Window's focusability ("focusable")
• this Window's focus traversal keys enabled state ("focusTraversalKeysEnabled")
• this Window's Set of FORWARD_TRAVERSAL_KEYS ("forwardFocusTraversalKeys")
• this Window's Set of BACKWARD_TRAVERSAL_KEYS ("backwardFocusTraversalKeys")
• this Window's Set of UP_CYCLE_TRAVERSAL_KEYS ("upCycleFocusTraversalKeys")
• this Window's Set of DOWN_CYCLE_TRAVERSAL_KEYS ("downCycleFocusTraversalKeys")
• this Window's focus traversal policy ("focusTraversalPolicy")
• this Window's focusable Window state ("focusableWindowState")

Note that if this Window is inheriting a bound property, then no event will be fired in response to a change in the inherited property.

If listener is null, no exception is thrown and no action is performed.

Overrides:

addPropertyChangeListener in class Container

Parameters:

listener - the PropertyChangeListener to be added

See Also:

Component.removePropertyChangeListener(java.beans.PropertyChangeListener), addPropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener)

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
                                      java.beans.PropertyChangeListener listener)

Suppressed: Adds a PropertyChangeListener to the listener list for a specific property. The specified property may be user-defined, or one of the following:

• this Window's font ("font")
• this Window's background color ("background")
• this Window's foreground color ("foreground")
• this Window's focusability ("focusable")
• this Window's focus traversal keys enabled state ("focusTraversalKeysEnabled")
• this Window's Set of FORWARD_TRAVERSAL_KEYS ("forwardFocusTraversalKeys")
• this Window's Set of BACKWARD_TRAVERSAL_KEYS ("backwardFocusTraversalKeys")
• this Window's Set of UP_CYCLE_TRAVERSAL_KEYS ("upCycleFocusTraversalKeys")
• this Window's Set of DOWN_CYCLE_TRAVERSAL_KEYS ("downCycleFocusTraversalKeys")
• this Window's focus traversal policy ("focusTraversalPolicy")
• this Window's focusable Window state ("focusableWindowState")

Note that if this Window is inheriting a bound property, then no event will be fired in response to a change in the inherited property.

If listener is null, no exception is thrown and no action is performed.

Overrides:

addPropertyChangeListener in class Container

Parameters:

propertyName - one of the property names listed above

listener - the PropertyChangeListener to be added

See Also:

addPropertyChangeListener(java.beans.PropertyChangeListener), Component.removePropertyChangeListener(java.beans.PropertyChangeListener)

dispatchEventImpl

void dispatchEventImpl(AWTEvent e)

Dispatches an event to this window or one of its sub components.

Overrides:

dispatchEventImpl in class Container

Parameters:

e - the event

postEvent

public boolean postEvent(Event e)

Suppressed: @deprecated As of JDK version 1.1 replaced by dispatchEvent(AWTEvent).

Specified by:

postEvent in interface MenuContainer

Overrides:

postEvent in class Component

isShowing

public boolean isShowing()

Enabled: Checks if this Window is showing on screen.

Overrides:

isShowing in class Component

Returns:

true if the component is showing, false otherwise

See Also:

Component.setVisible(boolean)

applyResourceBundle

public void applyResourceBundle(ResourceBundle rb)

Deprecated. As of J2SE 1.4, replaced by Component.applyComponentOrientation.

Suppressed: Applies the ResourceBundle's ComponentOrientation to this Window and all components contained within it.

Since:

1.2

See Also:

ComponentOrientation

applyResourceBundle

public void applyResourceBundle(String rbName)

Deprecated. As of J2SE 1.4, replaced by Component.applyComponentOrientation.

Suppressed: Loads the ResourceBundle with the given name using the default locale and applies its ComponentOrientation to this Window and all components contained within it.

Since:

1.2

See Also:

ComponentOrientation

addOwnedWindow

void addOwnedWindow(java.lang.ref.WeakReference weakWindow)

removeOwnedWindow

void removeOwnedWindow(java.lang.ref.WeakReference weakWindow)

connectOwnedWindow

void connectOwnedWindow(Window child)

writeObject

private void writeObject(ObjectOutputStream s)
                  throws IOException

Writes default serializable fields to stream. Writes a list of serializable WindowListeners and WindowFocusListeners as optional data. Writes a list of child windows as optional data.

Parameters:

s - the ObjectOutputStream to write

IOException

See Also:

AWTEventMulticaster.save(java.io.ObjectOutputStream, java.lang.String, java.util.EventListener), Component.windowListenerK, Component.windowFocusListenerK, Component.ownedWindowK, readObject(java.io.ObjectInputStream)

readObject

private void readObject(ObjectInputStream s)
                 throws ClassNotFoundException,
                        IOException,
                        HeadlessException

Reads the ObjectInputStream and an optional list of listeners to receive various events fired by the component; also reads a list of (possibly null) child windows. Unrecognized keys or values will be ignored.

Parameters:

s - the ObjectInputStream to read

ClassNotFoundException

IOException

HeadlessException

See Also:

java.awt.GraphicsEnvironment#isHeadless, writeObject(java.io.ObjectOutputStream)

getAccessibleContext

public AccessibleContext getAccessibleContext()

Suppressed: 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.

Specified by:

getAccessibleContext in interface Accessible

Overrides:

getAccessibleContext in class Component

Returns:

an AccessibleAWTWindow that serves as the AccessibleContext of this Window

getGraphicsConfiguration

public GraphicsConfiguration getGraphicsConfiguration()

Suppressed: This method returns the GraphicsConfiguration used by this Window.

Overrides:

getGraphicsConfiguration in class Component

Returns:

the GraphicsConfiguration used by this Component or null

resetGC

void resetGC()

Reset this Window's GraphicsConfiguration to match its peer.

Overrides:

resetGC in class Component

setLocationRelativeTo

public void setLocationRelativeTo(Component c)

Enabled: 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 centered on the screen. If the bottom of the component is offscreen, the window is displayed to the right of the component.

Parameters:

c - the component in relation to which the window's location is determined

Since:

1.4

deliverMouseWheelToAncestor

void deliverMouseWheelToAncestor(MouseWheelEvent e)

Overridden from Component. Top-level Windows should not propagate a MouseWheelEvent beyond themselves into their owning Windows.

dispatchMouseWheelToAncestor

boolean dispatchMouseWheelToAncestor(MouseWheelEvent e)

Overridden from Component. Top-level Windows don't dispatch to ancestors

Overrides:

dispatchMouseWheelToAncestor in class Component

createBufferStrategy

public void createBufferStrategy(int numBuffers)

Enabled: 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.

Overrides:

createBufferStrategy in class Component

Parameters:

numBuffers - number of buffers to create

Since:

1.4

See Also:

Component.isDisplayable(), getBufferStrategy()

createBufferStrategy

public void createBufferStrategy(int numBuffers,
                                 BufferCapabilities caps)
                          throws AWTException

Enabled: 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.

Overrides:

createBufferStrategy in class Component

Parameters:

numBuffers - number of buffers to create, including the front buffer

caps - the required capabilities for creating the buffer strategy; cannot be null

AWTException

Since:

1.4

See Also:

getBufferStrategy()

getBufferStrategy

public java.awt.image.BufferStrategy getBufferStrategy()

Enabled: @return the buffer strategy used by this component

Overrides:

getBufferStrategy in class Component

Returns:

the buffer strategy used by this component

Since:

1.4

See Also:

createBufferStrategy(int)