javax.swing
Class JWindow

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

All Implemented Interfaces:

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

Direct Known Subclasses:

javax.swing.Popup.HeavyWeightWindow

public class JWindow

extends Window

implements Accessible, RootPaneContainer

Unsafe: A JWindow is a container that can be displayed anywhere on the user's desktop. It does not have the title bar, window-management buttons, or other trimmings associated with a JFrame, but it is still a "first-class citizen" of the user's desktop, and can exist anywhere on it.

The JWindow component contains a JRootPane as its only child. The contentPane should be the parent of any children of the JWindow. From the older java.awt.Window object you would normally do something like this:

       window.add(child);
 

However, using JWindow you would code:

       window.getContentPane().add(child);
 

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

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

In a multi-screen environment, you can create a JWindow on a different screen device. See java.awt.Window for more information.

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

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder.

Version:

1.52 12/03/01

Author:

David Kloba

See Also:

JRootPane, Serialized Form

Field Summary

protected AccessibleContext	accessibleContext The accessible context property.
protected JRootPane	rootPane The JRootPane instance that manages the contentPane and optional menuBar for this frame, as well as the glassPane.
protected boolean	rootPaneCheckingEnabled If true then calls to add and setLayout will cause an exception to be thrown.

Fields inherited from class java.awt.Window

Fields inherited from class java.awt.Container

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Constructor Summary

JWindow()
Enabled: Creates a window with no specified owner.

JWindow(Frame owner)
Enabled: Creates a window with the specified owner frame.

JWindow(GraphicsConfiguration gc)
Enabled: Creates a window with the specified GraphicsConfiguration of a screen device.

JWindow(Window owner)
Enabled: Creates a window with the specified owner window.

JWindow(Window owner, GraphicsConfiguration gc)
Enabled: Creates a window with the specified owner window and GraphicsConfiguration of a screen device.

Method Summary

protected void	addImpl(Component comp, Object constraints, int index) By default, children may not be added directly to a this component, they must be added to its contentPane instead.
protected JRootPane	createRootPane() Called by the constructor methods to create the default rootPane.
private Error	createRootPaneException(String op) Creates a string with a message that can be used for a runtime exception.
AccessibleContext	getAccessibleContext() Suppressed: Gets the AccessibleContext associated with this JWindow.
Container	getContentPane() Enabled: Returns the Container which is the contentPane for this window.
Component	getGlassPane() Suppressed: Returns the glassPane Component for this window.
JLayeredPane	getLayeredPane() Suppressed: Returns the layeredPane object for this window.
JRootPane	getRootPane() Suppressed: Returns the rootPane object for this window.
protected boolean	isRootPaneCheckingEnabled() Returns whether calls to add and setLayout will cause an exception to be thrown.
protected String	paramString() Returns a string representation of this JWindow.
void	remove(Component comp) Enabled: Removes the specified component from this container.
void	setContentPane(Container contentPane) Enabled: Sets the contentPane property for this window.
void	setGlassPane(Component glassPane) Suppressed: Sets the glassPane property.
void	setLayeredPane(JLayeredPane layeredPane) Suppressed: Sets the layeredPane property.
void	setLayout(LayoutManager manager) Enabled: By default the layout of this component may not be set, the layout of its contentPane should be set instead.
protected void	setRootPane(JRootPane root) Sets the new rootPane object for this window.
protected void	setRootPaneCheckingEnabled(boolean enabled) Determines whether calls to add and setLayout will cause an exception to be thrown.
void	update(Graphics g) Enabled: Calls paint(g).
protected void	windowInit() Called by the constructors to init the JWindow properly.

Methods inherited from class java.awt.Window

addNotify, addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, get, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, iterate, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, size, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, 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, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, toString, transferFocus, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

rootPane

protected JRootPane rootPane

The JRootPane instance that manages the contentPane and optional menuBar for this frame, as well as the glassPane.

See Also:

getRootPane(), setRootPane(javax.swing.JRootPane)

rootPaneCheckingEnabled

protected boolean rootPaneCheckingEnabled

If true then calls to add and setLayout will cause an exception to be thrown.

See Also:

isRootPaneCheckingEnabled(), setRootPaneCheckingEnabled(boolean)

accessibleContext

protected AccessibleContext accessibleContext

The accessible context property.

Constructor Detail

JWindow

public JWindow()

Enabled: Creates a window with no specified owner. This window will not be focusable.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

See Also:

java.awt.GraphicsEnvironment#isHeadless, Window.isFocusableWindow(), JComponent.getDefaultLocale()

JWindow

public JWindow(GraphicsConfiguration gc)

Enabled: Creates a window with the specified GraphicsConfiguration of a screen device. This window will not be focusable.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

gc - the GraphicsConfiguration that is used to construct the new window with; if gc is null, the system default GraphicsConfiguration is assumed

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() returns true.

IllegalArgumentException - if gc is not from a screen device.

Since:

1.3

See Also:

java.awt.GraphicsEnvironment#isHeadless, Window.isFocusableWindow(), JComponent.getDefaultLocale()

JWindow

public JWindow(Frame owner)

Enabled: Creates a window with the specified owner frame. If owner is null, the shared owner will be used and this window will not be focusable. Also, this window will not be focusable unless its owner is showing on the screen.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

owner - the frame from which the window is displayed

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

See Also:

java.awt.GraphicsEnvironment#isHeadless, Window.isFocusableWindow(), JComponent.getDefaultLocale()

JWindow

public JWindow(Window owner)

Enabled: Creates a window with the specified owner window. This window will not be focusable unless its owner is showing on the screen. If owner is null, the shared owner will be used and this window will not be focusable.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

owner - the window from which the window is displayed

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

See Also:

java.awt.GraphicsEnvironment#isHeadless, Window.isFocusableWindow(), JComponent.getDefaultLocale()

JWindow

public JWindow(Window owner,
               GraphicsConfiguration gc)

Enabled: Creates a window with the specified owner window and GraphicsConfiguration of a screen device. If owner is null, the shared owner will be used and this window will not be focusable.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

owner - the window from which the window is displayed

gc - the GraphicsConfiguration that is used to construct the new window with; if gc is null, the system default GraphicsConfiguration is assumed, unless owner is also null, in which case the GraphicsConfiguration from the shared owner frame will be used.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

IllegalArgumentException - if gc is not from a screen device.

Since:

1.3

See Also:

java.awt.GraphicsEnvironment#isHeadless, Window.isFocusableWindow(), JComponent.getDefaultLocale()

Method Detail

windowInit

protected void windowInit()

Called by the constructors to init the JWindow properly.

createRootPane

protected JRootPane createRootPane()

Called by the constructor methods to create the default rootPane.

isRootPaneCheckingEnabled

protected boolean isRootPaneCheckingEnabled()

Returns whether calls to add and setLayout will cause an exception to be thrown.

Returns:

true if add and setLayout are checked

See Also:

addImpl(java.awt.Component, java.lang.Object, int), setLayout(java.awt.LayoutManager), setRootPaneCheckingEnabled(boolean)

update

public void update(Graphics g)

Enabled: Calls paint(g). This method was overridden to prevent an unnecessary call to clear the background.

Overrides:

update in class Container

Parameters:

g - the Graphics context in which to paint

See Also:

Component.update(Graphics)

setRootPaneCheckingEnabled

protected void setRootPaneCheckingEnabled(boolean enabled)

Determines whether calls to add and setLayout will cause an exception to be thrown.

Parameters:

enabled - a boolean value, true if checking is to be enabled, which cause the exceptions to be thrown

See Also:

addImpl(java.awt.Component, java.lang.Object, int), setLayout(java.awt.LayoutManager), isRootPaneCheckingEnabled()

createRootPaneException

private Error createRootPaneException(String op)

Creates a string with a message that can be used for a runtime exception. The message will look like:

 "Do not use JWindow.add() use JWindow.getContentPane().add() instead"
 

Parameters:

op - a String indicating the attempted operation; in the example above, the operation string is "add"

Returns:

a string containing the message to be used for the exception

addImpl

protected void addImpl(Component comp,
                       Object constraints,
                       int index)

By default, children may not be added directly to a this component, they must be added to its contentPane instead. For example:

 thisComponent.getContentPane().add(child)
 

An attempt to add to directly to this component will cause an runtime exception to be thrown. Subclasses can disable this behavior.

Overrides:

addImpl in class Container

Parameters:

comp - the component to be enhanced

constraints - the constraints to be enforced on the component

index - the index of the component

See Also:

setRootPaneCheckingEnabled(boolean)

remove

public void remove(Component comp)

Enabled: Removes the specified component from this container.

Overrides:

remove in class Container

Parameters:

comp - the component to be removed

See Also:

Container.add(java.awt.Component)

setLayout

public void setLayout(LayoutManager manager)

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

 thisComponent.getContentPane().setLayout(new GridLayout(1, 2))
 

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

Overrides:

setLayout in class Container

Parameters:

manager - the layout manager for the window

See Also:

setRootPaneCheckingEnabled(boolean)

getRootPane

public JRootPane getRootPane()

Suppressed: Returns the rootPane object for this window.

Specified by:

getRootPane in interface RootPaneContainer

Returns:

the rootPane property for this window

See Also:

setRootPane(javax.swing.JRootPane), RootPaneContainer.getRootPane()

setRootPane

protected void setRootPane(JRootPane root)

Sets the new rootPane object for this window. This method is called by the constructor.

Parameters:

root - the new rootPane property

See Also:

getRootPane()

getContentPane

public Container getContentPane()

Enabled: Returns the Container which is the contentPane for this window.

Specified by:

getContentPane in interface RootPaneContainer

Returns:

the contentPane property

See Also:

setContentPane(java.awt.Container), RootPaneContainer.getContentPane()

setContentPane

public void setContentPane(Container contentPane)

Enabled: Sets the contentPane property for this window. This method is called by the constructor.

Specified by:

setContentPane in interface RootPaneContainer

Parameters:

contentPane - the new contentPane

See Also:

getContentPane(), RootPaneContainer.setContentPane(java.awt.Container)

getLayeredPane

public JLayeredPane getLayeredPane()

Suppressed: Returns the layeredPane object for this window.

Specified by:

getLayeredPane in interface RootPaneContainer

Returns:

the layeredPane property

See Also:

setLayeredPane(javax.swing.JLayeredPane), RootPaneContainer.getLayeredPane()

setLayeredPane

public void setLayeredPane(JLayeredPane layeredPane)

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

Specified by:

setLayeredPane in interface RootPaneContainer

Parameters:

layeredPane - the new layeredPane object

See Also:

getLayeredPane(), RootPaneContainer.setLayeredPane(javax.swing.JLayeredPane)

getGlassPane

public Component getGlassPane()

Suppressed: Returns the glassPane Component for this window.

Specified by:

getGlassPane in interface RootPaneContainer

Returns:

the glassPane property

See Also:

setGlassPane(java.awt.Component), RootPaneContainer.getGlassPane()

setGlassPane

public void setGlassPane(Component glassPane)

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

Specified by:

setGlassPane in interface RootPaneContainer

Parameters:

glassPane - the glassPane object for this window

See Also:

getGlassPane(), RootPaneContainer.setGlassPane(java.awt.Component)

paramString

protected String paramString()

Returns a string representation of this JWindow. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Overrides:

paramString in class Container

Returns:

a string representation of this JWindow

getAccessibleContext

public AccessibleContext getAccessibleContext()

Suppressed: Gets the AccessibleContext associated with this JWindow. For JWindows, the AccessibleContext takes the form of an AccessibleJWindow. A new AccessibleJWindow instance is created if necessary.

Specified by:

getAccessibleContext in interface Accessible

Overrides:

getAccessibleContext in class Window

Returns:

an AccessibleJWindow that serves as the AccessibleContext of this JWindow