ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer
@JavaBean(defaultProperty="accessibleContext", description="A toplevel window which has no system border or controls.") public class JWindow extends Window implements Accessible, RootPaneContainer
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 convenience, the add, remove, and setLayout methods of this class are overridden, so that they delegate calls to the corresponding methods of the ContentPane. For example, you can add a child component to a window as follows:
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 JavaBeans has been added to the java.beans package. Please see XMLEncoder.
| Modifier and Type | Class | Description |
|---|---|---|
protected class |
JWindow.AccessibleJWindow |
This class implements accessibility support for the JWindow class. |
Window.AccessibleAWTWindow, Window.Type
Container.AccessibleAWTContainer
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
| Modifier and Type | Field | Description |
|---|---|---|
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. |
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
| Constructor | Description |
|---|---|
JWindow() |
Creates a window with no specified owner. |
JWindow |
Creates a window with the specified owner frame. |
JWindow |
Creates a window with the specified GraphicsConfiguration of a screen device. |
JWindow |
Creates a window with the specified owner window. |
JWindow |
Creates a window with the specified owner window and GraphicsConfiguration of a screen device. |
| Modifier and Type | Method | Description |
|---|---|---|
protected void |
addImpl |
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 |
Removes the specified component from the container. |
void |
repaint |
Repaints the specified rectangle of this component within time milliseconds. |
void |
setContentPane |
Sets the contentPane property for this window. |
void |
setGlassPane |
Sets the glassPane property. |
void |
setLayeredPane |
Sets the layeredPane property. |
void |
setLayout |
Sets the LayoutManager. |
protected void |
setRootPane |
Sets the new rootPane object for this window. |
protected void |
setRootPaneCheckingEnabled |
Sets whether calls to add and setLayout are forwarded to the contentPane. |
void |
setTransferHandler |
Sets the transferHandler property, which is a mechanism to support transfer of data into this component. |
void |
update |
Calls paint(g). |
protected void |
windowInit() |
Called by the constructors to init the JWindow properly. |
addNotify, addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBackground, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setOpacity, setShape, setSize, setSize, setType, setVisible, show, toBack, toFront
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree
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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
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
public JWindow()
This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.
HeadlessException - if GraphicsEnvironment.isHeadless() returns true.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 assumedHeadlessException - If GraphicsEnvironment.isHeadless() returns true.IllegalArgumentException - if gc is not from a screen device.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 displayedHeadlessException - if GraphicsEnvironment.isHeadless() returns true.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 displayedHeadlessException - if GraphicsEnvironment.isHeadless() returns true.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.protected void windowInit()
JWindow properly.protected JRootPane createRootPane()
rootPane.JRootPane
protected boolean isRootPaneCheckingEnabled()
add and setLayout are forwarded to the contentPane.add and setLayout are forwarded; false otherwise@BeanProperty(hidden=true, description="Mechanism for transfer of data into the component") 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
public TransferHandler getTransferHandler()
transferHandler property.transferHandler propertypublic void update(Graphics g)
paint(g). This method was overridden to prevent an unnecessary call to clear the background.@BeanProperty(hidden=true, description="Whether the add and setLayout methods are forwarded") 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.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.addImpl in class Container
comp - the component to be enhancedconstraints - the constraints to be respectedindex - the indexIllegalArgumentException - if index is invalidIllegalArgumentException - if adding the container's parent to itselfIllegalArgumentException - if adding a window to a containerpublic 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.remove in class Container
comp - the component to be removedNullPointerException - if comp is nullpublic void setLayout(LayoutManager manager)
LayoutManager. Overridden to conditionally forward the call to the contentPane. Refer to RootPaneContainer for more information.@BeanProperty(bound=false, hidden=true, description="the RootPane object for this window.") public JRootPane getRootPane()
rootPane object for this window.getRootPane in interface RootPaneContainer
rootPane property for this windowprotected void setRootPane(JRootPane root)
rootPane object for this window. This method is called by the constructor.root - the new rootPane propertypublic Container getContentPane()
Container which is the contentPane for this window.getContentPane in interface RootPaneContainer
contentPane property@BeanProperty(bound=false, hidden=true, description="The client area of the window where child components are normally inserted.") 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
public JLayeredPane getLayeredPane()
layeredPane object for this window.getLayeredPane in interface RootPaneContainer
layeredPane property@BeanProperty(bound=false, hidden=true, description="The pane which holds the various window layers.") public void setLayeredPane(JLayeredPane layeredPane)
layeredPane property. This method is called by the constructor.setLayeredPane in interface RootPaneContainer
layeredPane - the new layeredPane objectIllegalComponentStateException - (a runtime exception) if the content pane parameter is null
public Component getGlassPane()
glassPane Component for this window.getGlassPane in interface RootPaneContainer
glassPane property@BeanProperty(bound=false, hidden=true, description="A transparent pane used for menu rendering.") public void setGlassPane(Component glassPane)
glassPane property. This method is called by the constructor.setGlassPane in interface RootPaneContainer
glassPane - the glassPane object for this window@BeanProperty(bound=false) public Graphics getGraphics()
null if this component is currently not displayable.getGraphics in class Component
null if it has nonepublic 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.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
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/JWindow.html