|
JavaTM 2 Platform Std. Ed. v1.4.2 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectjava.awt.Component
java.awt.Container
java.awt.Window
javax.swing.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.
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 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 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 inherited from class java.awt.Window |
Window.AccessibleAWTWindow |
| Nested classes inherited from class java.awt.Container |
Container.AccessibleAWTContainer |
| Nested classes inherited from class java.awt.Component |
Component.AccessibleAWTComponent, 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 cause an exception to be thrown. |
| 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)
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. |
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. |
JLayeredPane |
getLayeredPane()
Returns the layeredPane object for this window. |
JRootPane |
getRootPane()
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)
Removes the specified component from this container. |
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)
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)
Calls paint(g). |
protected void |
windowInit()
Called by the constructors to init the JWindow properly. |
| Methods inherited from class java.lang.Object |
clone, equals, 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.
getRootPane(),
setRootPane(javax.swing.JRootPane)protected boolean rootPaneCheckingEnabled
add and setLayout
will cause an exception to be thrown.
isRootPaneCheckingEnabled(),
setRootPaneCheckingEnabled(boolean)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 will cause an exception to be thrown.
add and setLayout
are checkedaddImpl(java.awt.Component, java.lang.Object, int),
setLayout(java.awt.LayoutManager),
setRootPaneCheckingEnabled(boolean)public void update(Graphics g)
paint(g). This method was overridden to
prevent an unnecessary call to clear the background.
update in class Containerg - the Graphics context in which to paintComponent.update(Graphics)protected void setRootPaneCheckingEnabled(boolean enabled)
add and
setLayout will cause an exception to be thrown.
enabled - a boolean value, true if checking is to be
enabled, which cause the exceptions to be thrownaddImpl(java.awt.Component, java.lang.Object, int),
setLayout(java.awt.LayoutManager),
isRootPaneCheckingEnabled()
protected void addImpl(Component comp,
Object constraints,
int index)
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.
addImpl in class Containercomp - the component to be enhancedconstraints - the constraints to be enforced on the componentindex - the index of the component
Error - if called with rootPaneChecking truesetRootPaneCheckingEnabled(boolean)public void remove(Component comp)
remove in class Containercomp - the component to be removedContainer.add(java.awt.Component)public void setLayout(LayoutManager manager)
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.
setLayout in class Containermanager - the layout manager for the window
Error - if called with rootPaneChecking truesetRootPaneCheckingEnabled(boolean)public JRootPane getRootPane()
rootPane object for this window.
getRootPane in interface RootPaneContainerrootPane 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 RootPaneContainercontentPane 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 RootPaneContainercontentPane - the new contentPane
IllegalComponentStateException - (a runtime
exception) if the content pane parameter is nullgetContentPane(),
RootPaneContainer.setContentPane(java.awt.Container)public JLayeredPane getLayeredPane()
layeredPane object for this window.
getLayeredPane in interface RootPaneContainerlayeredPane propertysetLayeredPane(javax.swing.JLayeredPane),
RootPaneContainer.getLayeredPane()public void setLayeredPane(JLayeredPane layeredPane)
layeredPane property.
This method is called by the constructor.
setLayeredPane in interface RootPaneContainerlayeredPane - the new layeredPane object
IllegalComponentStateException - (a runtime
exception) if the content pane parameter is nullgetLayeredPane(),
RootPaneContainer.setLayeredPane(javax.swing.JLayeredPane)public Component getGlassPane()
glassPane Component for this window.
getGlassPane in interface RootPaneContainerglassPane propertysetGlassPane(java.awt.Component),
RootPaneContainer.getGlassPane()public void setGlassPane(Component glassPane)
glassPane property.
This method is called by the constructor.
setGlassPane in interface RootPaneContainerglassPane - the glassPane object for this windowgetGlassPane(),
RootPaneContainer.setGlassPane(java.awt.Component)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 ContainerJWindowpublic AccessibleContext getAccessibleContext()
getAccessibleContext in interface AccessiblegetAccessibleContext in class Window
|
JavaTM 2 Platform Std. Ed. v1.4.2 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
Copyright 2003 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.