public class

JWindow

extends Window
implements Accessible RootPaneContainer
java.lang.Object
   ↳ java.awt.Component
     ↳ java.awt.Container
       ↳ java.awt.Window
         ↳ javax.swing.JWindow

Class Overview

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. As a conveniance add and its variants, remove and setLayout have been overridden to forward to the contentPane as necessary. This means you can write:

       window.add(child);
 
And the child will be added to the contentPane. 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. Refer to RootPaneContainer for details on adding, removing and setting the LayoutManager of a JWindow.

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 Window for more information.

Warning: Swing is not thread safe. For more information see Swing's Threading Policy.

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 JavaBeansTM has been added to the java.beans package. Please see XMLEncoder.

See Also

Summary

Nested Classes
class JWindow.AccessibleJWindow This class implements accessibility support for the JWindow class. 
[Expand]
Inherited Constants
From class java.awt.Component
From interface java.awt.image.ImageObserver
Fields
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 be forwarded to the contentPane.
Public Constructors
JWindow()
Creates a window with no specified owner.
JWindow(GraphicsConfiguration gc)
Creates a window with the specified GraphicsConfiguration of a screen device.
JWindow(Frame owner)
Creates a window with the specified owner frame.
JWindow(Window owner)
Creates a window with the specified owner window.
JWindow(Window owner, GraphicsConfiguration gc)
Creates a window with the specified owner window and GraphicsConfiguration of a screen device.
Public Methods
AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this JWindow.
Container getContentPane()
Returns the Container which is the contentPane for this window.
Component getGlassPane()
Returns the glassPane Component for this window.
Graphics getGraphics()
Creates a graphics context for this component.
JLayeredPane getLayeredPane()
Returns the layeredPane object for this window.
JRootPane getRootPane()
Returns the rootPane object for this window.
TransferHandler getTransferHandler()
Gets the transferHandler property.
void remove(Component comp)
Removes the specified component from the container.
void repaint(long time, int x, int y, int width, int height)
Repaints the specified rectangle of this component within time milliseconds.
void setContentPane(Container contentPane)
Sets the contentPane property for this window.
void setGlassPane(Component glassPane)
Sets the glassPane property.
void setLayeredPane(JLayeredPane layeredPane)
Sets the layeredPane property.
void setLayout(LayoutManager manager)
Sets the LayoutManager.
void setTransferHandler(TransferHandler newHandler)
Sets the transferHandler property, which is a mechanism to support transfer of data into this component.
void update(Graphics g)
Calls paint(g).
Protected Methods
void addImpl(Component comp, Object constraints, int index)
Adds the specified child Component.
JRootPane createRootPane()
Called by the constructor methods to create the default rootPane.
boolean isRootPaneCheckingEnabled()
Returns whether calls to add and setLayout are forwarded to the contentPane.
String paramString()
Returns a string representation of this JWindow.
void setRootPane(JRootPane root)
Sets the new rootPane object for this window.
void setRootPaneCheckingEnabled(boolean enabled)
Sets whether calls to add and setLayout are forwarded to the contentPane.
void windowInit()
Called by the constructors to init the JWindow properly.
[Expand]
Inherited Methods
From class java.awt.Window
From class java.awt.Container
From class java.awt.Component
From class java.lang.Object
From interface java.awt.MenuContainer
From interface java.awt.image.ImageObserver
From interface javax.accessibility.Accessible
From interface javax.swing.RootPaneContainer

Fields

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 be forwarded to the contentPane. This is initially false, but is set to true when the JWindow is constructed.

Public Constructors

public JWindow ()

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.

public JWindow (GraphicsConfiguration gc)

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.

public JWindow (Frame owner)

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.

public JWindow (Window owner)

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.

public JWindow (Window owner, GraphicsConfiguration gc)

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.

Public Methods

public AccessibleContext getAccessibleContext ()

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.

Returns
  • an AccessibleJWindow that serves as the AccessibleContext of this JWindow

public Container getContentPane ()

Returns the Container which is the contentPane for this window.

Returns
  • the contentPane property

public Component getGlassPane ()

Returns the glassPane Component for this window.

Returns
  • the glassPane property

public Graphics getGraphics ()

Creates a graphics context for this component. This method will return null if this component is currently not displayable.

Returns
  • a graphics context for this component, or null if it has none

public JLayeredPane getLayeredPane ()

Returns the layeredPane object for this window.

Returns
  • the layeredPane property

public JRootPane getRootPane ()

Returns the rootPane object for this window.

Returns
  • the rootPane property for this window

public TransferHandler getTransferHandler ()

Gets the transferHandler property.

Returns
  • the value of the transferHandler property

public void remove (Component comp)

Removes the specified component from the container. If comp is not the rootPane, this will forward the call to the contentPane. This will do nothing if comp is not a child of the JWindow or contentPane.

Parameters
comp the component to be removed
Throws
NullPointerException if comp is null

public void repaint (long time, int x, int y, int width, int height)

Repaints the specified rectangle of this component within time milliseconds. Refer to RepaintManager for details on how the repaint is handled.

Parameters
time maximum time in milliseconds before update
x the x coordinate
y the y coordinate
width the width
height the height
See Also

public void setContentPane (Container contentPane)

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

Parameters
contentPane the new contentPane
Throws
IllegalComponentStateException (a runtime exception) if the content pane parameter is null

public void setGlassPane (Component glassPane)

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

Parameters
glassPane the glassPane object for this window

public void setLayeredPane (JLayeredPane layeredPane)

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

Parameters
layeredPane the new layeredPane object
Throws
IllegalComponentStateException (a runtime exception) if the content pane parameter is null

public void setLayout (LayoutManager manager)

Sets the LayoutManager. Overridden to conditionally forward the call to the contentPane. Refer to RootPaneContainer for more information.

Parameters
manager the LayoutManager

public void setTransferHandler (TransferHandler newHandler)

Sets the transferHandler property, which is a mechanism to support transfer of data into this component. Use null if the component does not support data transfer operations.

If the system property suppressSwingDropSupport is false (the default) and the current drop target on this component is either null or not a user-set drop target, this method will change the drop target as follows: If newHandler is null it will clear the drop target. If not null it will install a new DropTarget.

Note: When used with JWindow, TransferHandler only provides data import capability, as the data export related methods are currently typed to JComponent.

Please see How to Use Drag and Drop and Data Transfer, a section in The Java Tutorial, for more information.

Parameters
newHandler the new TransferHandler

public void update (Graphics g)

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

Parameters
g the Graphics context in which to paint

Protected Methods

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

Adds the specified child Component. This method is overridden to conditionally forward calls to the contentPane. By default, children are added to the contentPane instead of the frame, refer to RootPaneContainer for details.

Parameters
comp the component to be enhanced
constraints the constraints to be respected
index the index
Throws
IllegalArgumentException if index is invalid
IllegalArgumentException if adding the container's parent to itself
IllegalArgumentException if adding a window to a container

protected JRootPane createRootPane ()

Called by the constructor methods to create the default rootPane.

protected boolean isRootPaneCheckingEnabled ()

Returns whether calls to add and setLayout are forwarded to the contentPane.

Returns
  • true if add and setLayout are fowarded; false otherwise

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.

Returns
  • a string representation of this JWindow

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

protected void setRootPaneCheckingEnabled (boolean enabled)

Sets whether calls to add and setLayout are forwarded to the contentPane.

Parameters
enabled true if add and setLayout are forwarded, false if they should operate directly on the JWindow.

protected void windowInit ()

Called by the constructors to init the JWindow properly.