|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.awt.Component java.awt.Container java.awt.Window javax.swing.JWindow
public class JWindow
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
.
JRootPane
Nested Class Summary | |
---|---|
protected class |
JWindow.AccessibleJWindow
This class implements accessibility support for the JWindow class. |
Nested classes/interfaces inherited from class java.awt.Window |
---|
Window.AccessibleAWTWindow |
Nested classes/interfaces inherited from class java.awt.Container |
---|
Container.AccessibleAWTContainer |
Nested classes/interfaces inherited from class java.awt.Component |
---|
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy |
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 be forwarded to the contentPane . |
Fields inherited from class java.awt.Component |
---|
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
Fields inherited from interface java.awt.image.ImageObserver |
---|
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
---|---|
JWindow()
Creates a window with no specified owner. |
|
JWindow(Frame owner)
Creates a window with the specified owner frame. |
|
JWindow(GraphicsConfiguration gc)
Creates a window with the specified GraphicsConfiguration
of a screen device. |
|
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. |
Method Summary | |
---|---|
protected void |
addImpl(Component comp,
Object constraints,
int index)
Adds the specified child Component . |
protected JRootPane |
createRootPane()
Called by the constructor methods to create the default rootPane . |
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. |
protected boolean |
isRootPaneCheckingEnabled()
Returns whether calls to add and
setLayout are forwarded to the contentPane . |
protected String |
paramString()
Returns a string representation of this JWindow . |
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 . |
protected void |
setRootPane(JRootPane root)
Sets the new rootPane object for this window. |
protected void |
setRootPaneCheckingEnabled(boolean enabled)
Sets whether calls to add and
setLayout are forwarded to the contentPane . |
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 void |
windowInit()
Called by the constructors to init the JWindow properly. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected JRootPane rootPane
JRootPane
instance that manages the
contentPane
and optional menuBar
for this frame, as well as the
glassPane
.
protected boolean rootPaneCheckingEnabled
add
and setLayout
will be forwarded to the contentPane
. This is initially
false, but is set to true when the JWindow
is constructed.
protected AccessibleContext accessibleContext
Constructor Detail |
---|
public JWindow()
This constructor sets the component's locale property to the value
returned by JComponent.getDefaultLocale
.
HeadlessException
- if
GraphicsEnvironment.isHeadless()
returns true.GraphicsEnvironment.isHeadless()
,
Window.isFocusableWindow()
,
JComponent.getDefaultLocale()
public JWindow(GraphicsConfiguration gc)
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
.
gc
- the GraphicsConfiguration
that is used
to construct the new window with; if gc is null
,
the system default GraphicsConfiguration
is assumed
HeadlessException
- If
GraphicsEnvironment.isHeadless()
returns true.
IllegalArgumentException
- if gc
is not from
a screen device.GraphicsEnvironment.isHeadless()
,
Window.isFocusableWindow()
,
JComponent.getDefaultLocale()
public JWindow(Frame owner)
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
.
owner
- the frame from which the window is displayed
HeadlessException
- if GraphicsEnvironment.isHeadless()
returns true.GraphicsEnvironment.isHeadless()
,
Window.isFocusableWindow()
,
JComponent.getDefaultLocale()
public JWindow(Window owner)
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
.
owner
- the window from which the window is displayed
HeadlessException
- if
GraphicsEnvironment.isHeadless()
returns true.GraphicsEnvironment.isHeadless()
,
Window.isFocusableWindow()
,
JComponent.getDefaultLocale()
public JWindow(Window owner, GraphicsConfiguration gc)
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
.
owner
- the window from which the window is displayedgc
- 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.
HeadlessException
- if
GraphicsEnvironment.isHeadless()
returns true.
IllegalArgumentException
- if gc
is not from
a screen device.GraphicsEnvironment.isHeadless()
,
Window.isFocusableWindow()
,
JComponent.getDefaultLocale()
Method Detail |
---|
protected void windowInit()
JWindow
properly.
protected JRootPane createRootPane()
rootPane
.
protected boolean isRootPaneCheckingEnabled()
add
and
setLayout
are forwarded to the contentPane
.
add
and setLayout
are fowarded; false otherwiseaddImpl(java.awt.Component, java.lang.Object, int)
,
setLayout(java.awt.LayoutManager)
,
setRootPaneCheckingEnabled(boolean)
,
RootPaneContainer
public void setTransferHandler(TransferHandler newHandler)
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.
newHandler
- the new TransferHandler
TransferHandler
,
getTransferHandler()
,
Component.setDropTarget(java.awt.dnd.DropTarget)
public TransferHandler getTransferHandler()
transferHandler
property.
transferHandler
propertyTransferHandler
,
setTransferHandler(javax.swing.TransferHandler)
public void update(Graphics g)
paint(g)
. This method was overridden to
prevent an unnecessary call to clear the background.
g
- the Graphics
context in which to paintComponent.update(Graphics)
protected void setRootPaneCheckingEnabled(boolean enabled)
add
and
setLayout
are forwarded to the contentPane
.
enabled
- true if add
and setLayout
are forwarded, false if they should operate directly on the
JWindow
.addImpl(java.awt.Component, java.lang.Object, int)
,
setLayout(java.awt.LayoutManager)
,
isRootPaneCheckingEnabled()
,
RootPaneContainer
protected void addImpl(Component comp, Object constraints, int index)
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.
comp
- the component to be enhancedconstraints
- the constraints to be respectedindex
- the index
IllegalArgumentException
- if index
is invalid
IllegalArgumentException
- if adding the container's parent
to itself
IllegalArgumentException
- if adding a window to a containersetRootPaneCheckingEnabled(boolean)
,
RootPaneContainer
public void remove(Component comp)
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
.
comp
- the component to be removed
NullPointerException
- if comp
is nullContainer.add(java.awt.Component)
,
RootPaneContainer
public void setLayout(LayoutManager manager)
LayoutManager
.
Overridden to conditionally forward the call to the
contentPane
.
Refer to RootPaneContainer
for
more information.
manager
- the LayoutManager
setRootPaneCheckingEnabled(boolean)
,
RootPaneContainer
public JRootPane getRootPane()
rootPane
object for this window.
getRootPane
in interface RootPaneContainer
rootPane
property for this windowsetRootPane(javax.swing.JRootPane)
,
RootPaneContainer.getRootPane()
protected void setRootPane(JRootPane root)
rootPane
object for this window.
This method is called by the constructor.
root
- the new rootPane
propertygetRootPane()
public Container getContentPane()
Container
which is the contentPane
for this window.
getContentPane
in interface RootPaneContainer
contentPane
propertysetContentPane(java.awt.Container)
,
RootPaneContainer.getContentPane()
public void setContentPane(Container contentPane)
contentPane
property for this window.
This method is called by the constructor.
setContentPane
in interface RootPaneContainer
contentPane
- the new contentPane
IllegalComponentStateException
- (a runtime
exception) if the content pane parameter is null
getContentPane()
,
RootPaneContainer.setContentPane(java.awt.Container)
public JLayeredPane getLayeredPane()
layeredPane
object for this window.
getLayeredPane
in interface RootPaneContainer
layeredPane
propertysetLayeredPane(javax.swing.JLayeredPane)
,
RootPaneContainer.getLayeredPane()
public void setLayeredPane(JLayeredPane layeredPane)
layeredPane
property.
This method is called by the constructor.
setLayeredPane
in interface RootPaneContainer
layeredPane
- the new layeredPane
object
IllegalComponentStateException
- (a runtime
exception) if the content pane parameter is null
getLayeredPane()
,
RootPaneContainer.setLayeredPane(javax.swing.JLayeredPane)
public Component getGlassPane()
glassPane Component
for this window.
getGlassPane
in interface RootPaneContainer
glassPane
propertysetGlassPane(java.awt.Component)
,
RootPaneContainer.getGlassPane()
public void setGlassPane(Component glassPane)
glassPane
property.
This method is called by the constructor.
setGlassPane
in interface RootPaneContainer
glassPane
- the glassPane
object for this windowgetGlassPane()
,
RootPaneContainer.setGlassPane(java.awt.Component)
public Graphics getGraphics()
null
if this component is currently not
displayable.
getGraphics
in class Component
null
if it has noneComponent.paint(java.awt.Graphics)
public void repaint(long time, int x, int y, int width, int height)
time
milliseconds. Refer to RepaintManager
for details on how the repaint is handled.
time
- maximum time in milliseconds before updatex
- the x coordinatey
- the y coordinatewidth
- the widthheight
- the heightRepaintManager
protected String paramString()
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
.
paramString
in class Container
JWindow
public AccessibleContext getAccessibleContext()
getAccessibleContext
in interface Accessible
getAccessibleContext
in class Window
|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.