Class JLayeredPane

javax.swing.JLayeredPane

All Implemented Interfaces:: ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:: JDesktopPane

@JavaBean(defaultProperty="accessibleContext") public class JLayeredPane extends JComponent implements Accessible

JLayeredPane adds depth to a JFC/Swing container, allowing components to overlap each other when needed. An Integer object specifies each component's depth in the container, where higher-numbered components sit "on top" of other components. For task-oriented documentation and examples of using layered panes see How to Use a Layered Pane, a section in The Java Tutorial.

Example:

The following text describes this image.

For convenience, JLayeredPane divides the depth-range into several different layers. Putting a component into one of those layers makes it easy to ensure that components overlap properly, without having to worry about specifying numbers for specific depths:

DEFAULT_LAYER: The standard layer, where most components go. This the bottommost layer.
PALETTE_LAYER: The palette layer sits over the default layer. Useful for floating toolbars and palettes, so they can be positioned above other components.
MODAL_LAYER: The layer used for modal dialogs. They will appear on top of any toolbars, palettes, or standard components in the container.
POPUP_LAYER: The popup layer displays above dialogs. That way, the popup windows associated with combo boxes, tooltips, and other help text will appear above the component, palette, or dialog that generated them.
DRAG_LAYER: When dragging a component, reassigning it to the drag layer ensures that it is positioned over every other component in the container. When finished dragging, it can be reassigned to its normal layer.

The JLayeredPane methods moveToFront(Component), moveToBack(Component) and setPosition can be used to reposition a component within its layer. The setLayer method can also be used to change the component's current layer.

Details

JLayeredPane manages its list of children like Container, but allows for the definition of a several layers within itself. Children in the same layer are managed exactly like the normal Container object, with the added feature that when children components overlap, children in higher layers display above the children in lower layers.

Each layer is a distinct integer number. The layer attribute can be set on a Component by passing an Integer object during the add call.
For example:

    layeredPane.add(child, JLayeredPane.DEFAULT_LAYER);
or
    layeredPane.add(child, Integer.valueOf(10));

The layer attribute can also be set on a Component by calling

    layeredPaneParent.setLayer(child, 10)

on the JLayeredPane that is the parent of component. The layer should be set before adding the child to the parent.

Higher number layers display above lower number layers. So, using numbers for the layers and letters for individual components, a representative list order would look like this:

      5a, 5b, 5c, 2a, 2b, 2c, 1a

where the leftmost components are closest to the top of the display.

A component can be moved to the top or bottom position within its layer by calling moveToFront or moveToBack.

The position of a component within a layer can also be specified directly. Valid positions range from 0 up to one less than the number of components in that layer. A value of -1 indicates the bottommost position. A value of 0 indicates the topmost position. Unlike layer numbers, higher position values are lower in the display.

Note: This sequence (defined by java.awt.Container) is the reverse of the layer numbering sequence. Usually though, you will use moveToFront, moveToBack, and setLayer.

Here are some examples using the method add(Component, layer, position): Calling add(5x, 5, -1) results in:

      5a, 5b, 5c, 5x, 2a, 2b, 2c, 1a

Calling add(5z, 5, 2) results in:

      5a, 5b, 5z, 5c, 5x, 2a, 2b, 2c, 1a

Calling add(3a, 3, 7) results in:

      5a, 5b, 5z, 5c, 5x, 3a, 2a, 2b, 2c, 1a

Using normal paint/event mechanics results in 1a appearing at the bottom and 5a being above all other components.

Note: that these layers are simply a logical construct and LayoutManagers will affect all child components of this container without regard for layer settings.

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.

Since:: 1.2

Nested Class Summary

Modifier and Type	Class	Description
`protected class`	`JLayeredPane.AccessibleJLayeredPane`	This class implements accessibility support for the `JLayeredPane` class.

Nested classes/interfaces declared in class JComponent

JComponent.AccessibleJComponent

Modifier and Type	Class	Description
`class`	`JComponent.AccessibleJComponent`	Inner class of JComponent used to provide default support for accessibility.

Nested classes/interfaces declared in class Container

Container.AccessibleAWTContainer

Modifier and Type	Class	Description
`protected class`	`Container.AccessibleAWTContainer`	Inner class of Container used to provide default support for accessibility.

Nested classes/interfaces declared in class Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Modifier and Type	Class	Description
`protected class`	`Component.AccessibleAWTComponent`	Inner class of Component used to provide default support for accessibility.
`static enum`	`Component.BaselineResizeBehavior`	Enumeration of the common ways the baseline of a component can change as the size changes.
`protected class`	`Component.BltBufferStrategy`	Inner class for blitting offscreen surfaces to a component.
`protected class`	`Component.FlipBufferStrategy`	Inner class for flipping buffers on a component.

Field Summary

Modifier and Type	Field	Description
`static final Integer`	`DEFAULT_LAYER`	Convenience object defining the Default layer.
`static final Integer`	`DRAG_LAYER`	Convenience object defining the Drag layer.
`static final Integer`	`FRAME_CONTENT_LAYER`	Convenience object defining the Frame Content layer.
`static final String`	`LAYER_PROPERTY`	Bound property
`static final Integer`	`MODAL_LAYER`	Convenience object defining the Modal layer.
`static final Integer`	`PALETTE_LAYER`	Convenience object defining the Palette layer.
`static final Integer`	`POPUP_LAYER`	Convenience object defining the Popup layer.

Fields declared in class JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Modifier and Type	Field	Description
`protected EventListenerList`	`listenerList`	A list of event listeners for this component.
`static final String`	`TOOL_TIP_TEXT_KEY`	The comment to display when the cursor is over the component, also known as a "value tip", "flyover help", or "flyover label".
`protected ComponentUI`	`ui`	The look and feel delegate for this component.
`static final int`	`UNDEFINED_CONDITION`	Constant used by some of the APIs to mean that no condition is defined.
`static final int`	`WHEN_ANCESTOR_OF_FOCUSED_COMPONENT`	Constant used for `registerKeyboardAction` that means that the command should be invoked when the receiving component is an ancestor of the focused component or is itself the focused component.
`static final int`	`WHEN_FOCUSED`	Constant used for `registerKeyboardAction` that means that the command should be invoked when the component has the focus.
`static final int`	`WHEN_IN_FOCUSED_WINDOW`	Constant used for `registerKeyboardAction` that means that the command should be invoked when the receiving component is in the window that has the focus or is itself the focused component.

Fields declared in class Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Modifier and Type	Field	Description
`protected AccessibleContext`	`accessibleContext`	The `AccessibleContext` associated with this `Component`.
`static final float`	`BOTTOM_ALIGNMENT`	Ease-of-use constant for `getAlignmentY`.
`static final float`	`CENTER_ALIGNMENT`	Ease-of-use constant for `getAlignmentY` and `getAlignmentX`.
`static final float`	`LEFT_ALIGNMENT`	Ease-of-use constant for `getAlignmentX`.
`static final float`	`RIGHT_ALIGNMENT`	Ease-of-use constant for `getAlignmentX`.
`static final float`	`TOP_ALIGNMENT`	Ease-of-use constant for `getAlignmentY()`.

Fields declared in interface ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Modifier and Type	Field	Description
`static final int`	`ABORT`	This flag in the infoflags argument to imageUpdate indicates that an image which was being tracked asynchronously was aborted before production was complete.
`static final int`	`ALLBITS`	This flag in the infoflags argument to imageUpdate indicates that a static image which was previously drawn is now complete and can be drawn again in its final form.
`static final int`	`ERROR`	This flag in the infoflags argument to imageUpdate indicates that an image which was being tracked asynchronously has encountered an error.
`static final int`	`FRAMEBITS`	This flag in the infoflags argument to imageUpdate indicates that another complete frame of a multi-frame image which was previously drawn is now available to be drawn again.
`static final int`	`HEIGHT`	This flag in the infoflags argument to imageUpdate indicates that the height of the base image is now available and can be taken from the height argument to the imageUpdate callback method.
`static final int`	`PROPERTIES`	This flag in the infoflags argument to imageUpdate indicates that the properties of the image are now available.
`static final int`	`SOMEBITS`	This flag in the infoflags argument to imageUpdate indicates that more pixels needed for drawing a scaled variation of the image are available.
`static final int`	`WIDTH`	This flag in the infoflags argument to imageUpdate indicates that the width of the base image is now available and can be taken from the width argument to the imageUpdate callback method.

Constructor Summary

Constructor	Description
`JLayeredPane()`	Create a new JLayeredPane

Method Summary

Modifier and Type	Method	Description
`AccessibleContext`	`getAccessibleContext()`	Gets the AccessibleContext associated with this JLayeredPane.
`int`	`getComponentCountInLayer(int layer)`	Returns the number of children currently in the specified layer.
`Component[]`	`getComponentsInLayer(int layer)`	Returns an array of the components in the specified layer.
`protected Hashtable<Component, Integer>`	`getComponentToLayer()`	Returns the hashtable that maps components to layers.
`int`	`getIndexOf(Component c)`	Returns the index of the specified Component.
`int`	`getLayer(Component c)`	Returns the layer attribute for the specified Component.
`static int`	`getLayer(JComponent c)`	Gets the layer property for a JComponent, it does not cause any side effects like setLayer().
`static JLayeredPane`	`getLayeredPaneAbove(Component c)`	Convenience method that returns the first JLayeredPane which contains the specified component.
`protected Integer`	`getObjectForLayer(int layer)`	Returns the Integer object associated with a specified layer.
`int`	`getPosition(Component c)`	Get the relative position of the component within its layer.
`int`	`highestLayer()`	Returns the highest layer value from all current children.
`protected int`	`insertIndexForLayer(int layer, int position)`	Primitive method that determines the proper location to insert a new child based on layer and position requests.
`boolean`	`isOptimizedDrawingEnabled()`	Returns false if components in the pane can overlap, which makes optimized drawing impossible.
`int`	`lowestLayer()`	Returns the lowest layer value from all current children.
`void`	`moveToBack(Component c)`	Moves the component to the bottom of the components in its current layer (position -1).
`void`	`moveToFront(Component c)`	Moves the component to the top of the components in its current layer (position 0).
`void`	`paint(Graphics g)`	Paints this JLayeredPane within the specified graphics context.
`protected String`	`paramString()`	Returns a string representation of this JLayeredPane.
`static void`	`putLayer(JComponent c, int layer)`	Sets the layer property on a JComponent.
`void`	`remove(int index)`	Remove the indexed component from this pane.
`void`	`removeAll()`	Removes all the components from this container.
`void`	`setLayer(Component c, int layer)`	Sets the layer attribute on the specified component, making it the bottommost component in that layer.
`void`	`setLayer(Component c, int layer, int position)`	Sets the layer attribute for the specified component and also sets its position within that layer.
`void`	`setPosition(Component c, int position)`	Moves the component to `position` within its current layer, where 0 is the topmost position within the layer and -1 is the bottommost position.

Methods declared in class JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUI, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Modifier and Type	Method	Description
`void`	`addAncestorListener(AncestorListener listener)`	Registers `listener` so that it will receive `AncestorEvents` when it or any of its ancestors move or are made visible or invisible.
`void`	`addNotify()`	Notifies this component that it now has a parent component.
`void`	`addVetoableChangeListener(VetoableChangeListener listener)`	Adds a `VetoableChangeListener` to the listener list.
`void`	`computeVisibleRect(Rectangle visibleRect)`	Returns the `Component`'s "visible rect rectangle" - the intersection of the visible rectangles for this component and all of its ancestors.
`boolean`	`contains(int x, int y)`	Gives the UI delegate an opportunity to define the precise shape of this component for the sake of mouse processing.
`JToolTip`	`createToolTip()`	Returns the instance of `JToolTip` that should be used to display the tooltip.
`void`	`disable()`	Deprecated. As of JDK version 1.1, replaced by `java.awt.Component.setEnabled(boolean)`.
`void`	`enable()`	Deprecated. As of JDK version 1.1, replaced by `java.awt.Component.setEnabled(boolean)`.
`void`	`firePropertyChange(String propertyName, boolean oldValue, boolean newValue)`	Support for reporting bound property changes for boolean properties.
`void`	`firePropertyChange(String propertyName, int oldValue, int newValue)`	Support for reporting bound property changes for integer properties.
`protected void`	`fireVetoableChange(String propertyName, Object oldValue, Object newValue)`	Supports reporting constrained property changes.
`ActionListener`	`getActionForKeyStroke(KeyStroke aKeyStroke)`	Returns the object that will perform the action registered for a given keystroke.
`final ActionMap`	`getActionMap()`	Returns the `ActionMap` used to determine what `Action` to fire for particular `KeyStroke` binding.
`float`	`getAlignmentX()`	Overrides `Container.getAlignmentX` to return the horizontal alignment.
`float`	`getAlignmentY()`	Overrides `Container.getAlignmentY` to return the vertical alignment.
`AncestorListener[]`	`getAncestorListeners()`	Returns an array of all the ancestor listeners registered on this component.
`boolean`	`getAutoscrolls()`	Gets the `autoscrolls` property.
`int`	`getBaseline(int width, int height)`	Returns the baseline.
`Component.BaselineResizeBehavior`	`getBaselineResizeBehavior()`	Returns an enum indicating how the baseline of the component changes as the size changes.
`Border`	`getBorder()`	Returns the border of this component or `null` if no border is currently set.
`Rectangle`	`getBounds(Rectangle rv)`	Stores the bounds of this component into "return value" `rv` and returns `rv`.
`final Object`	`getClientProperty(Object key)`	Returns the value of the property with the specified key.
`protected Graphics`	`getComponentGraphics(Graphics g)`	Returns the graphics object used to paint this component.
`JPopupMenu`	`getComponentPopupMenu()`	Returns `JPopupMenu` that assigned for this component.
`int`	`getConditionForKeyStroke(KeyStroke aKeyStroke)`	Returns the condition that determines whether a registered action occurs in response to the specified keystroke.
`int`	`getDebugGraphicsOptions()`	Returns the state of graphics debugging.
`static Locale`	`getDefaultLocale()`	Returns the default locale used to initialize each JComponent's locale property upon creation.
`FontMetrics`	`getFontMetrics(Font font)`	Gets the `FontMetrics` for the specified `Font`.
`Graphics`	`getGraphics()`	Returns this component's graphics context, which lets you draw on a component.
`int`	`getHeight()`	Returns the current height of this component.
`boolean`	`getInheritsPopupMenu()`	Returns true if the JPopupMenu should be inherited from the parent.
`final InputMap`	`getInputMap()`	Returns the `InputMap` that is used when the component has focus.
`final InputMap`	`getInputMap(int condition)`	Returns the `InputMap` that is used during `condition`.
`InputVerifier`	`getInputVerifier()`	Returns the input verifier for this component.
`Insets`	`getInsets()`	If a border has been set on this component, returns the border's insets; otherwise calls `super.getInsets`.
`Insets`	`getInsets(Insets insets)`	Returns an `Insets` object containing this component's inset values.
`<T extends EventListener> T[]`	`getListeners(Class<T> listenerType)`	Returns an array of all the objects currently registered as `FooListener`s upon this `JComponent`.
`Point`	`getLocation(Point rv)`	Stores the x,y origin of this component into "return value" `rv` and returns `rv`.
`Dimension`	`getMaximumSize()`	If the maximum size has been set to a non-`null` value just returns it.
`Dimension`	`getMinimumSize()`	If the minimum size has been set to a non-`null` value just returns it.
`Component`	`getNextFocusableComponent()`	Deprecated. As of 1.4, replaced by `FocusTraversalPolicy`.
`Point`	`getPopupLocation(MouseEvent event)`	Returns the preferred location to display the popup menu in this component's coordinate system.
`Dimension`	`getPreferredSize()`	If the `preferredSize` has been set to a non-`null` value just returns it.
`KeyStroke[]`	`getRegisteredKeyStrokes()`	Returns the `KeyStrokes` that will initiate registered actions.
`JRootPane`	`getRootPane()`	Returns the `JRootPane` ancestor for this component.
`Dimension`	`getSize(Dimension rv)`	Stores the width/height of this component into "return value" `rv` and returns `rv`.
`Point`	`getToolTipLocation(MouseEvent event)`	Returns the tooltip location in this component's coordinate system.
`String`	`getToolTipText()`	Returns the tooltip string that has been set with `setToolTipText`.
`String`	`getToolTipText(MouseEvent event)`	Returns the string to be used as the tooltip for event.
`Container`	`getTopLevelAncestor()`	Returns the top-level ancestor of this component (the containing `Window`) or `null` if this component has not been added to any container.
`TransferHandler`	`getTransferHandler()`	Gets the `transferHandler` property.
`ComponentUI`	`getUI()`	Returns the look and feel delegate that renders this component.
`String`	`getUIClassID()`	Returns the `UIDefaults` key used to look up the name of the `swing.plaf.ComponentUI` class that defines the look and feel for this component.
`boolean`	`getVerifyInputWhenFocusTarget()`	Returns the value that indicates whether the input verifier for the current focus owner will be called before this component requests focus.
`VetoableChangeListener[]`	`getVetoableChangeListeners()`	Returns an array of all the vetoable change listeners registered on this component.
`Rectangle`	`getVisibleRect()`	Returns the `Component`'s "visible rectangle" - the intersection of this component's visible rectangle, `new Rectangle(0, 0, getWidth(), getHeight())`, and all of its ancestors' visible rectangles.
`int`	`getWidth()`	Returns the current width of this component.
`int`	`getX()`	Returns the current x coordinate of the component's origin.
`int`	`getY()`	Returns the current y coordinate of the component's origin.
`void`	`grabFocus()`	Requests that this Component get the input focus, and that this Component's top-level ancestor become the focused Window.
`void`	`hide()`	Deprecated.
`boolean`	`isDoubleBuffered()`	Returns whether this component should use a buffer to paint.
`static boolean`	`isLightweightComponent(Component c)`	Returns true if this component is lightweight, that is, if it doesn't have a native window system peer.
`boolean`	`isManagingFocus()`	Deprecated. As of 1.4, replaced by `Component.setFocusTraversalKeys(int, Set)` and `Container.setFocusCycleRoot(boolean)`.
`boolean`	`isOpaque()`	Returns true if this component is completely opaque.
`final boolean`	`isPaintingForPrint()`	Returns `true` if the current painting operation on this component is part of a `print` operation.
`protected boolean`	`isPaintingOrigin()`	Returns `true` if a paint triggered on a child component should cause painting to originate from this Component, or one of its ancestors.
`boolean`	`isPaintingTile()`	Returns true if the component is currently painting a tile.
`boolean`	`isRequestFocusEnabled()`	Returns `true` if this `JComponent` should get focus; otherwise returns `false`.
`boolean`	`isValidateRoot()`	If this method returns true, `revalidate` calls by descendants of this component will cause the entire tree beginning with this root to be validated.
`protected void`	`paintBorder(Graphics g)`	Paints the component's border.
`protected void`	`paintChildren(Graphics g)`	Paints this component's children.
`protected void`	`paintComponent(Graphics g)`	Calls the UI delegate's paint method, if the UI delegate is non-`null`.
`void`	`paintImmediately(int x, int y, int w, int h)`	Paints the specified region in this component and all of its descendants that overlap the region, immediately.
`void`	`paintImmediately(Rectangle r)`	Paints the specified region now.
`void`	`print(Graphics g)`	Invoke this method to print the component to the specified `Graphics`.
`void`	`printAll(Graphics g)`	Invoke this method to print the component.
`protected void`	`printBorder(Graphics g)`	Prints the component's border.
`protected void`	`printChildren(Graphics g)`	Prints this component's children.
`protected void`	`printComponent(Graphics g)`	This is invoked during a printing operation.
`protected void`	`processComponentKeyEvent(KeyEvent e)`	Processes any key events that the component itself recognizes.
`protected boolean`	`processKeyBinding(KeyStroke ks, KeyEvent e, int condition, boolean pressed)`	Invoked to process the key bindings for `ks` as the result of the `KeyEvent` `e`.
`protected void`	`processKeyEvent(KeyEvent e)`	Overrides `processKeyEvent` to process events.
`protected void`	`processMouseEvent(MouseEvent e)`	Processes mouse events occurring on this component by dispatching them to any registered `MouseListener` objects, refer to `Component.processMouseEvent(MouseEvent)` for a complete description of this method.
`protected void`	`processMouseMotionEvent(MouseEvent e)`	Processes mouse motion events, such as MouseEvent.MOUSE_DRAGGED.
`final void`	`putClientProperty(Object key, Object value)`	Adds an arbitrary key/value "client property" to this component.
`void`	`registerKeyboardAction(ActionListener anAction, String aCommand, KeyStroke aKeyStroke, int aCondition)`	This method is now obsolete, please use a combination of `getActionMap()` and `getInputMap()` for similar behavior.
`void`	`registerKeyboardAction(ActionListener anAction, KeyStroke aKeyStroke, int aCondition)`	This method is now obsolete, please use a combination of `getActionMap()` and `getInputMap()` for similar behavior.
`void`	`removeAncestorListener(AncestorListener listener)`	Unregisters `listener` so that it will no longer receive `AncestorEvents`.
`void`	`removeNotify()`	Notifies this component that it no longer has a parent component.
`void`	`removeVetoableChangeListener(VetoableChangeListener listener)`	Removes a `VetoableChangeListener` from the listener list.
`void`	`repaint(long tm, int x, int y, int width, int height)`	Adds the specified region to the dirty region list if the component is showing.
`void`	`repaint(Rectangle r)`	Adds the specified region to the dirty region list if the component is showing.
`boolean`	`requestDefaultFocus()`	Deprecated. As of 1.4, replaced by `FocusTraversalPolicy.getDefaultComponent(Container).requestFocus()`
`void`	`requestFocus()`	Requests that this `Component` gets the input focus.
`boolean`	`requestFocus(boolean temporary)`	Requests that this `Component` gets the input focus.
`boolean`	`requestFocusInWindow()`	Requests that this `Component` gets the input focus.
`protected boolean`	`requestFocusInWindow(boolean temporary)`	Requests that this `Component` gets the input focus.
`void`	`resetKeyboardActions()`	Unregisters all the bindings in the first tier `InputMaps` and `ActionMap`.
`void`	`reshape(int x, int y, int w, int h)`	Deprecated. As of JDK 5, replaced by `Component.setBounds(int, int, int, int)`.
`void`	`revalidate()`	Supports deferred automatic layout.
`void`	`scrollRectToVisible(Rectangle aRect)`	Forwards the `scrollRectToVisible()` message to the `JComponent`'s parent.
`final void`	`setActionMap(ActionMap am)`	Sets the `ActionMap` to `am`.
`void`	`setAlignmentX(float alignmentX)`	Sets the horizontal alignment.
`void`	`setAlignmentY(float alignmentY)`	Sets the vertical alignment.
`void`	`setAutoscrolls(boolean autoscrolls)`	Sets the `autoscrolls` property.
`void`	`setBackground(Color bg)`	Sets the background color of this component.
`void`	`setBorder(Border border)`	Sets the border of this component.
`void`	`setComponentPopupMenu(JPopupMenu popup)`	Sets the `JPopupMenu` for this `JComponent`.
`void`	`setDebugGraphicsOptions(int debugOptions)`	Enables or disables diagnostic information about every graphics operation performed within the component or one of its children.
`static void`	`setDefaultLocale(Locale l)`	Sets the default locale used to initialize each JComponent's locale property upon creation.
`void`	`setDoubleBuffered(boolean aFlag)`	Sets whether this component should use a buffer to paint.
`void`	`setEnabled(boolean enabled)`	Sets whether or not this component is enabled.
`void`	`setFocusTraversalKeys(int id, Set<? extends AWTKeyStroke> keystrokes)`	Sets the focus traversal keys for a given traversal operation for this Component.
`void`	`setFont(Font font)`	Sets the font for this component.
`void`	`setForeground(Color fg)`	Sets the foreground color of this component.
`void`	`setInheritsPopupMenu(boolean value)`	Sets whether or not `getComponentPopupMenu` should delegate to the parent if this component does not have a `JPopupMenu` assigned to it.
`final void`	`setInputMap(int condition, InputMap map)`	Sets the `InputMap` to use under the condition `condition` to `map`.
`void`	`setInputVerifier(InputVerifier inputVerifier)`	Sets the input verifier for this component.
`void`	`setMaximumSize(Dimension maximumSize)`	Sets the maximum size of this component to a constant value.
`void`	`setMinimumSize(Dimension minimumSize)`	Sets the minimum size of this component to a constant value.
`void`	`setNextFocusableComponent(Component aComponent)`	Deprecated. As of 1.4, replaced by `FocusTraversalPolicy`
`void`	`setOpaque(boolean isOpaque)`	If true the component paints every pixel within its bounds.
`void`	`setPreferredSize(Dimension preferredSize)`	Sets the preferred size of this component.
`void`	`setRequestFocusEnabled(boolean requestFocusEnabled)`	Provides a hint as to whether or not this `JComponent` should get focus.
`void`	`setToolTipText(String text)`	Registers the text to display in a tool tip.
`void`	`setTransferHandler(TransferHandler newHandler)`	Sets the `TransferHandler`, which provides support for transfer of data into and out of this component via cut/copy/paste and drag and drop.
`protected void`	`setUI(ComponentUI newUI)`	Sets the look and feel delegate for this component.
`void`	`setVerifyInputWhenFocusTarget(boolean verifyInputWhenFocusTarget)`	Sets the value to indicate whether input verifier for the current focus owner will be called before this component requests focus.
`void`	`setVisible(boolean aFlag)`	Makes the component visible or invisible.
`void`	`unregisterKeyboardAction(KeyStroke aKeyStroke)`	This method is now obsolete.
`void`	`update(Graphics g)`	Calls `paint`.
`void`	`updateUI()`	This method is called to update the UI property to a value from the current look and feel.

Methods declared in class Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Modifier and Type	Method	Description
`Component`	`add(Component comp)`	Appends the specified component to the end of this container.
`Component`	`add(Component comp, int index)`	Adds the specified component to this container at the given position.
`void`	`add(Component comp, Object constraints)`	Adds the specified component to the end of this container.
`void`	`add(Component comp, Object constraints, int index)`	Adds the specified component to this container with the specified constraints at the specified index.
`Component`	`add(String name, Component comp)`	Adds the specified component to this container.
`void`	`addContainerListener(ContainerListener l)`	Adds the specified container listener to receive container events from this container.
`protected void`	`addImpl(Component comp, Object constraints, int index)`	Adds the specified component to this container at the specified index.
`void`	`addPropertyChangeListener(PropertyChangeListener listener)`	Adds a PropertyChangeListener to the listener list.
`void`	`addPropertyChangeListener(String propertyName, PropertyChangeListener listener)`	Adds a PropertyChangeListener to the listener list for a specific property.
`void`	`applyComponentOrientation(ComponentOrientation o)`	Sets the `ComponentOrientation` property of this container and all components contained within it.
`boolean`	`areFocusTraversalKeysSet(int id)`	Returns whether the Set of focus traversal keys for the given focus traversal operation has been explicitly defined for this Container.
`int`	`countComponents()`	Deprecated. As of JDK version 1.1, replaced by getComponentCount().
`void`	`deliverEvent(Event e)`	Deprecated. As of JDK version 1.1, replaced by `dispatchEvent(AWTEvent e)`
`void`	`doLayout()`	Causes this container to lay out its components.
`Component`	`findComponentAt(int x, int y)`	Locates the visible child component that contains the specified position.
`Component`	`findComponentAt(Point p)`	Locates the visible child component that contains the specified point.
`Component`	`getComponent(int n)`	Gets the nth component in this container.
`Component`	`getComponentAt(int x, int y)`	Locates the component that contains the x,y position.
`Component`	`getComponentAt(Point p)`	Gets the component that contains the specified point.
`int`	`getComponentCount()`	Gets the number of components in this panel.
`Component[]`	`getComponents()`	Gets all the components in this container.
`int`	`getComponentZOrder(Component comp)`	Returns the z-order index of the component inside the container.
`ContainerListener[]`	`getContainerListeners()`	Returns an array of all the container listeners registered on this container.
`Set<AWTKeyStroke>`	`getFocusTraversalKeys(int id)`	Returns the Set of focus traversal keys for a given traversal operation for this Container.
`FocusTraversalPolicy`	`getFocusTraversalPolicy()`	Returns the focus traversal policy that will manage keyboard traversal of this Container's children, or null if this Container is not a focus cycle root.
`LayoutManager`	`getLayout()`	Gets the layout manager for this container.
`Point`	`getMousePosition(boolean allowChildren)`	Returns the position of the mouse pointer in this `Container`'s coordinate space if the `Container` is under the mouse pointer, otherwise returns `null`.
`Insets`	`insets()`	Deprecated. As of JDK version 1.1, replaced by `getInsets()`.
`void`	`invalidate()`	Invalidates the container.
`boolean`	`isAncestorOf(Component c)`	Checks if the component is contained in the component hierarchy of this container.
`boolean`	`isFocusCycleRoot()`	Returns whether this Container is the root of a focus traversal cycle.
`boolean`	`isFocusCycleRoot(Container container)`	Returns whether the specified Container is the focus cycle root of this Container's focus traversal cycle.
`final boolean`	`isFocusTraversalPolicyProvider()`	Returns whether this container provides focus traversal policy.
`boolean`	`isFocusTraversalPolicySet()`	Returns whether the focus traversal policy has been explicitly set for this Container.
`void`	`layout()`	Deprecated. As of JDK version 1.1, replaced by `doLayout()`.
`void`	`list(PrintStream out, int indent)`	Prints a listing of this container to the specified output stream.
`void`	`list(PrintWriter out, int indent)`	Prints out a list, starting at the specified indentation, to the specified print writer.
`Component`	`locate(int x, int y)`	Deprecated. As of JDK version 1.1, replaced by `getComponentAt(int, int)`.
`Dimension`	`minimumSize()`	Deprecated. As of JDK version 1.1, replaced by `getMinimumSize()`.
`void`	`paintComponents(Graphics g)`	Paints each of the components in this container.
`Dimension`	`preferredSize()`	Deprecated. As of JDK version 1.1, replaced by `getPreferredSize()`.
`void`	`printComponents(Graphics g)`	Prints each of the components in this container.
`protected void`	`processContainerEvent(ContainerEvent e)`	Processes container events occurring on this container by dispatching them to any registered ContainerListener objects.
`protected void`	`processEvent(AWTEvent e)`	Processes events on this container.
`void`	`remove(Component comp)`	Removes the specified component from this container.
`void`	`removeContainerListener(ContainerListener l)`	Removes the specified container listener so it no longer receives container events from this container.
`void`	`setComponentZOrder(Component comp, int index)`	Moves the specified component to the specified z-order index in the container.
`void`	`setFocusCycleRoot(boolean focusCycleRoot)`	Sets whether this Container is the root of a focus traversal cycle.
`void`	`setFocusTraversalPolicy(FocusTraversalPolicy policy)`	Sets the focus traversal policy that will manage keyboard traversal of this Container's children, if this Container is a focus cycle root.
`final void`	`setFocusTraversalPolicyProvider(boolean provider)`	Sets whether this container will be used to provide focus traversal policy.
`void`	`setLayout(LayoutManager mgr)`	Sets the layout manager for this container.
`void`	`transferFocusDownCycle()`	Transfers the focus down one focus traversal cycle.
`void`	`validate()`	Validates this container and all of its subcomponents.
`protected void`	`validateTree()`	Recursively descends the container tree and recomputes the layout for any subtrees marked as needing it (those marked as invalid).

Methods declared in class Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Modifier and Type	Method	Description
`boolean`	`action(Event evt, Object what)`	Deprecated. As of JDK version 1.1, should register this component as ActionListener on component which fires action events.
`void`	`add(PopupMenu popup)`	Adds the specified popup menu to the component.
`void`	`addComponentListener(ComponentListener l)`	Adds the specified component listener to receive component events from this component.
`void`	`addFocusListener(FocusListener l)`	Adds the specified focus listener to receive focus events from this component when this component gains input focus.
`void`	`addHierarchyBoundsListener(HierarchyBoundsListener l)`	Adds the specified hierarchy bounds listener to receive hierarchy bounds events from this component when the hierarchy to which this container belongs changes.
`void`	`addHierarchyListener(HierarchyListener l)`	Adds the specified hierarchy listener to receive hierarchy changed events from this component when the hierarchy to which this container belongs changes.
`void`	`addInputMethodListener(InputMethodListener l)`	Adds the specified input method listener to receive input method events from this component.
`void`	`addKeyListener(KeyListener l)`	Adds the specified key listener to receive key events from this component.
`void`	`addMouseListener(MouseListener l)`	Adds the specified mouse listener to receive mouse events from this component.
`void`	`addMouseMotionListener(MouseMotionListener l)`	Adds the specified mouse motion listener to receive mouse motion events from this component.
`void`	`addMouseWheelListener(MouseWheelListener l)`	Adds the specified mouse wheel listener to receive mouse wheel events from this component.
`Rectangle`	`bounds()`	Deprecated. As of JDK version 1.1, replaced by `getBounds()`.
`int`	`checkImage(Image image, int width, int height, ImageObserver observer)`	Returns the status of the construction of a screen representation of the specified image.
`int`	`checkImage(Image image, ImageObserver observer)`	Returns the status of the construction of a screen representation of the specified image.
`protected AWTEvent`	`coalesceEvents(AWTEvent existingEvent, AWTEvent newEvent)`	Potentially coalesce an event being posted with an existing event.
`boolean`	`contains(Point p)`	Checks whether this component "contains" the specified point, where the point's x and y coordinates are defined to be relative to the coordinate system of this component.
`Image`	`createImage(int width, int height)`	Creates an off-screen drawable image to be used for double buffering.
`Image`	`createImage(ImageProducer producer)`	Creates an image from the specified image producer.
`VolatileImage`	`createVolatileImage(int width, int height)`	Creates a volatile off-screen drawable image to be used for double buffering.
`VolatileImage`	`createVolatileImage(int width, int height, ImageCapabilities caps)`	Creates a volatile off-screen drawable image, with the given capabilities.
`protected final void`	`disableEvents(long eventsToDisable)`	Disables the events defined by the specified event mask parameter from being delivered to this component.
`final void`	`dispatchEvent(AWTEvent e)`	Dispatches an event to this component or one of its sub components.
`void`	`enable(boolean b)`	Deprecated. As of JDK version 1.1, replaced by `setEnabled(boolean)`.
`protected final void`	`enableEvents(long eventsToEnable)`	Enables the events defined by the specified event mask parameter to be delivered to this component.
`void`	`enableInputMethods(boolean enable)`	Enables or disables input method support for this component.
`void`	`firePropertyChange(String propertyName, byte oldValue, byte newValue)`	Reports a bound property change.
`void`	`firePropertyChange(String propertyName, char oldValue, char newValue)`	Reports a bound property change.
`void`	`firePropertyChange(String propertyName, double oldValue, double newValue)`	Reports a bound property change.
`void`	`firePropertyChange(String propertyName, float oldValue, float newValue)`	Reports a bound property change.
`void`	`firePropertyChange(String propertyName, long oldValue, long newValue)`	Reports a bound property change.
`void`	`firePropertyChange(String propertyName, short oldValue, short newValue)`	Reports a bound property change.
`protected void`	`firePropertyChange(String propertyName, Object oldValue, Object newValue)`	Support for reporting bound property changes for Object properties.
`Color`	`getBackground()`	Gets the background color of this component.
`Rectangle`	`getBounds()`	Gets the bounds of this component in the form of a `Rectangle` object.
`ColorModel`	`getColorModel()`	Gets the instance of `ColorModel` used to display the component on the output device.
`ComponentListener[]`	`getComponentListeners()`	Returns an array of all the component listeners registered on this component.
`ComponentOrientation`	`getComponentOrientation()`	Retrieves the language-sensitive orientation that is to be used to order the elements or text within this component.
`Cursor`	`getCursor()`	Gets the cursor set in the component.
`DropTarget`	`getDropTarget()`	Gets the `DropTarget` associated with this `Component`.
`Container`	`getFocusCycleRootAncestor()`	Returns the Container which is the focus cycle root of this Component's focus traversal cycle.
`FocusListener[]`	`getFocusListeners()`	Returns an array of all the focus listeners registered on this component.
`boolean`	`getFocusTraversalKeysEnabled()`	Returns whether focus traversal keys are enabled for this Component.
`Font`	`getFont()`	Gets the font of this component.
`Color`	`getForeground()`	Gets the foreground color of this component.
`GraphicsConfiguration`	`getGraphicsConfiguration()`	Gets the `GraphicsConfiguration` associated with this `Component`.
`HierarchyBoundsListener[]`	`getHierarchyBoundsListeners()`	Returns an array of all the hierarchy bounds listeners registered on this component.
`HierarchyListener[]`	`getHierarchyListeners()`	Returns an array of all the hierarchy listeners registered on this component.
`boolean`	`getIgnoreRepaint()`	Returns whether or not paint messages received from the operating system should be ignored.
`InputContext`	`getInputContext()`	Gets the input context used by this component for handling the communication with input methods when text is entered in this component.
`InputMethodListener[]`	`getInputMethodListeners()`	Returns an array of all the input method listeners registered on this component.
`InputMethodRequests`	`getInputMethodRequests()`	Gets the input method request handler which supports requests from input methods for this component.
`KeyListener[]`	`getKeyListeners()`	Returns an array of all the key listeners registered on this component.
`Locale`	`getLocale()`	Gets the locale of this component.
`Point`	`getLocation()`	Gets the location of this component in the form of a point specifying the component's top-left corner.
`Point`	`getLocationOnScreen()`	Gets the location of this component in the form of a point specifying the component's top-left corner in the screen's coordinate space.
`MouseListener[]`	`getMouseListeners()`	Returns an array of all the mouse listeners registered on this component.
`MouseMotionListener[]`	`getMouseMotionListeners()`	Returns an array of all the mouse motion listeners registered on this component.
`Point`	`getMousePosition()`	Returns the position of the mouse pointer in this `Component`'s coordinate space if the `Component` is directly under the mouse pointer, otherwise returns `null`.
`MouseWheelListener[]`	`getMouseWheelListeners()`	Returns an array of all the mouse wheel listeners registered on this component.
`String`	`getName()`	Gets the name of the component.
`Container`	`getParent()`	Gets the parent of this component.
`PropertyChangeListener[]`	`getPropertyChangeListeners()`	Returns an array of all the property change listeners registered on this component.
`PropertyChangeListener[]`	`getPropertyChangeListeners(String propertyName)`	Returns an array of all the listeners which have been associated with the named property.
`Dimension`	`getSize()`	Returns the size of this component in the form of a `Dimension` object.
`Toolkit`	`getToolkit()`	Gets the toolkit of this component.
`final Object`	`getTreeLock()`	Gets this component's locking object (the object that owns the thread synchronization monitor) for AWT component-tree and layout operations.
`boolean`	`gotFocus(Event evt, Object what)`	Deprecated. As of JDK version 1.1, replaced by processFocusEvent(FocusEvent).
`boolean`	`handleEvent(Event evt)`	Deprecated. As of JDK version 1.1 replaced by processEvent(AWTEvent).
`boolean`	`hasFocus()`	Returns `true` if this `Component` is the focus owner.
`boolean`	`imageUpdate(Image img, int infoflags, int x, int y, int w, int h)`	Repaints the component when the image has changed.
`boolean`	`inside(int x, int y)`	Deprecated. As of JDK version 1.1, replaced by contains(int, int).
`boolean`	`isBackgroundSet()`	Returns whether the background color has been explicitly set for this Component.
`boolean`	`isCursorSet()`	Returns whether the cursor has been explicitly set for this Component.
`boolean`	`isDisplayable()`	Determines whether this component is displayable.
`boolean`	`isEnabled()`	Determines whether this component is enabled.
`boolean`	`isFocusable()`	Returns whether this Component can be focused.
`boolean`	`isFocusOwner()`	Returns `true` if this `Component` is the focus owner.
`boolean`	`isFocusTraversable()`	Deprecated. As of 1.4, replaced by `isFocusable()`.
`boolean`	`isFontSet()`	Returns whether the font has been explicitly set for this Component.
`boolean`	`isForegroundSet()`	Returns whether the foreground color has been explicitly set for this Component.
`boolean`	`isLightweight()`	A lightweight component doesn't have a native toolkit peer.
`boolean`	`isMaximumSizeSet()`	Returns true if the maximum size has been set to a non-`null` value otherwise returns false.
`boolean`	`isMinimumSizeSet()`	Returns whether or not `setMinimumSize` has been invoked with a non-null value.
`boolean`	`isPreferredSizeSet()`	Returns true if the preferred size has been set to a non-`null` value otherwise returns false.
`boolean`	`isShowing()`	Determines whether this component is showing on screen.
`boolean`	`isValid()`	Determines whether this component is valid.
`boolean`	`isVisible()`	Determines whether this component should be visible when its parent is visible.
`boolean`	`keyDown(Event evt, int key)`	Deprecated. As of JDK version 1.1, replaced by processKeyEvent(KeyEvent).
`boolean`	`keyUp(Event evt, int key)`	Deprecated. As of JDK version 1.1, replaced by processKeyEvent(KeyEvent).
`void`	`list()`	Prints a listing of this component to the standard system output stream `System.out`.
`void`	`list(PrintStream out)`	Prints a listing of this component to the specified output stream.
`void`	`list(PrintWriter out)`	Prints a listing to the specified print writer.
`Point`	`location()`	Deprecated. As of JDK version 1.1, replaced by `getLocation()`.
`boolean`	`lostFocus(Event evt, Object what)`	Deprecated. As of JDK version 1.1, replaced by processFocusEvent(FocusEvent).
`boolean`	`mouseDown(Event evt, int x, int y)`	Deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
`boolean`	`mouseDrag(Event evt, int x, int y)`	Deprecated. As of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent).
`boolean`	`mouseEnter(Event evt, int x, int y)`	Deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
`boolean`	`mouseExit(Event evt, int x, int y)`	Deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
`boolean`	`mouseMove(Event evt, int x, int y)`	Deprecated. As of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent).
`boolean`	`mouseUp(Event evt, int x, int y)`	Deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
`void`	`move(int x, int y)`	Deprecated. As of JDK version 1.1, replaced by `setLocation(int, int)`.
`void`	`nextFocus()`	Deprecated. As of JDK version 1.1, replaced by transferFocus().
`void`	`paintAll(Graphics g)`	Paints this component and all of its subcomponents.
`boolean`	`postEvent(Event e)`	Deprecated. As of JDK version 1.1, replaced by dispatchEvent(AWTEvent).
`boolean`	`prepareImage(Image image, int width, int height, ImageObserver observer)`	Prepares an image for rendering on this component at the specified width and height.
`boolean`	`prepareImage(Image image, ImageObserver observer)`	Prepares an image for rendering on this component.
`protected void`	`processComponentEvent(ComponentEvent e)`	Processes component events occurring on this component by dispatching them to any registered `ComponentListener` objects.
`protected void`	`processFocusEvent(FocusEvent e)`	Processes focus events occurring on this component by dispatching them to any registered `FocusListener` objects.
`protected void`	`processHierarchyBoundsEvent(HierarchyEvent e)`	Processes hierarchy bounds events occurring on this component by dispatching them to any registered `HierarchyBoundsListener` objects.
`protected void`	`processHierarchyEvent(HierarchyEvent e)`	Processes hierarchy events occurring on this component by dispatching them to any registered `HierarchyListener` objects.
`protected void`	`processInputMethodEvent(InputMethodEvent e)`	Processes input method events occurring on this component by dispatching them to any registered `InputMethodListener` objects.
`protected void`	`processMouseWheelEvent(MouseWheelEvent e)`	Processes mouse wheel events occurring on this component by dispatching them to any registered `MouseWheelListener` objects.
`void`	`remove(MenuComponent popup)`	Removes the specified popup menu from the component.
`void`	`removeComponentListener(ComponentListener l)`	Removes the specified component listener so that it no longer receives component events from this component.
`void`	`removeFocusListener(FocusListener l)`	Removes the specified focus listener so that it no longer receives focus events from this component.
`void`	`removeHierarchyBoundsListener(HierarchyBoundsListener l)`	Removes the specified hierarchy bounds listener so that it no longer receives hierarchy bounds events from this component.
`void`	`removeHierarchyListener(HierarchyListener l)`	Removes the specified hierarchy listener so that it no longer receives hierarchy changed events from this component.
`void`	`removeInputMethodListener(InputMethodListener l)`	Removes the specified input method listener so that it no longer receives input method events from this component.
`void`	`removeKeyListener(KeyListener l)`	Removes the specified key listener so that it no longer receives key events from this component.
`void`	`removeMouseListener(MouseListener l)`	Removes the specified mouse listener so that it no longer receives mouse events from this component.
`void`	`removeMouseMotionListener(MouseMotionListener l)`	Removes the specified mouse motion listener so that it no longer receives mouse motion events from this component.
`void`	`removeMouseWheelListener(MouseWheelListener l)`	Removes the specified mouse wheel listener so that it no longer receives mouse wheel events from this component.
`void`	`removePropertyChangeListener(PropertyChangeListener listener)`	Removes a PropertyChangeListener from the listener list.
`void`	`removePropertyChangeListener(String propertyName, PropertyChangeListener listener)`	Removes a `PropertyChangeListener` from the listener list for a specific property.
`void`	`repaint()`	Repaints this component.
`void`	`repaint(int x, int y, int width, int height)`	Repaints the specified rectangle of this component.
`void`	`repaint(long tm)`	Repaints the component.
`protected boolean`	`requestFocus(boolean temporary, FocusEvent.Cause cause)`	Requests by the reason of `cause` that this `Component` get the input focus, and that this `Component`'s top-level ancestor become the focused `Window`.
`void`	`requestFocus(FocusEvent.Cause cause)`	Requests by the reason of `cause` that this Component get the input focus, and that this Component's top-level ancestor become the focused Window.
`boolean`	`requestFocusInWindow(FocusEvent.Cause cause)`	Requests by the reason of `cause` that this Component get the input focus, if this Component's top-level ancestor is already the focused Window.
`void`	`resize(int width, int height)`	Deprecated. As of JDK version 1.1, replaced by `setSize(int, int)`.
`void`	`resize(Dimension d)`	Deprecated. As of JDK version 1.1, replaced by `setSize(Dimension)`.
`void`	`setBounds(int x, int y, int width, int height)`	Moves and resizes this component.
`void`	`setBounds(Rectangle r)`	Moves and resizes this component to conform to the new bounding rectangle `r`.
`void`	`setComponentOrientation(ComponentOrientation o)`	Sets the language-sensitive orientation that is to be used to order the elements or text within this component.
`void`	`setCursor(Cursor cursor)`	Sets the cursor image to the specified cursor.
`void`	`setDropTarget(DropTarget dt)`	Associate a `DropTarget` with this component.
`void`	`setFocusable(boolean focusable)`	Sets the focusable state of this Component to the specified value.
`void`	`setFocusTraversalKeysEnabled(boolean focusTraversalKeysEnabled)`	Sets whether focus traversal keys are enabled for this Component.
`void`	`setIgnoreRepaint(boolean ignoreRepaint)`	Sets whether or not paint messages received from the operating system should be ignored.
`void`	`setLocale(Locale l)`	Sets the locale of this component.
`void`	`setLocation(int x, int y)`	Moves this component to a new location.
`void`	`setLocation(Point p)`	Moves this component to a new location.
`void`	`setMixingCutoutShape(Shape shape)`	Sets a 'mixing-cutout' shape for this lightweight component.
`void`	`setName(String name)`	Sets the name of the component to the specified string.
`void`	`setSize(int width, int height)`	Resizes this component so that it has width `width` and height `height`.
`void`	`setSize(Dimension d)`	Resizes this component so that it has width `d.width` and height `d.height`.
`void`	`show()`	Deprecated. As of JDK version 1.1, replaced by `setVisible(boolean)`.
`void`	`show(boolean b)`	Deprecated. As of JDK version 1.1, replaced by `setVisible(boolean)`.
`Dimension`	`size()`	Deprecated. As of JDK version 1.1, replaced by `getSize()`.
`String`	`toString()`	Returns a string representation of this component and its values.
`void`	`transferFocus()`	Transfers the focus to the next component, as though this Component were the focus owner.
`void`	`transferFocusBackward()`	Transfers the focus to the previous component, as though this Component were the focus owner.
`void`	`transferFocusUpCycle()`	Transfers the focus up one focus traversal cycle.

Methods declared in class Object

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

Modifier and Type	Method	Description
`protected Object`	`clone()`	Creates and returns a copy of this object.
`boolean`	`equals(Object obj)`	Indicates whether some other object is "equal to" this one.
`protected void`	`finalize()`	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
`final Class<?>`	`getClass()`	Returns the runtime class of this `Object`.
`int`	`hashCode()`	Returns a hash code value for this object.
`final void`	`notify()`	Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()`	Wakes up all threads that are waiting on this object's monitor.
`final void`	`wait()`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
`final void`	`wait(long timeoutMillis)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis, int nanos)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Field Details

DEFAULT_LAYER

public static final Integer DEFAULT_LAYER

Convenience object defining the Default layer. Equivalent to Integer.valueOf(0).

PALETTE_LAYER

public static final Integer PALETTE_LAYER

Convenience object defining the Palette layer. Equivalent to Integer.valueOf(100).

MODAL_LAYER

public static final Integer MODAL_LAYER

Convenience object defining the Modal layer. Equivalent to Integer.valueOf(200).

POPUP_LAYER

public static final Integer POPUP_LAYER

Convenience object defining the Popup layer. Equivalent to Integer.valueOf(300).

DRAG_LAYER

public static final Integer DRAG_LAYER

Convenience object defining the Drag layer. Equivalent to Integer.valueOf(400).

FRAME_CONTENT_LAYER

public static final Integer FRAME_CONTENT_LAYER

Convenience object defining the Frame Content layer. This layer is normally only use to position the contentPane and menuBar components of JFrame. Equivalent to Integer.valueOf(-30000).

See Also:

LAYER_PROPERTY

public static final String LAYER_PROPERTY

Bound property

See Also:

Constructor Details

JLayeredPane

public JLayeredPane()

Create a new JLayeredPane

Method Details

remove

public void remove(int index)

Remove the indexed component from this pane. This is the absolute index, ignoring layers.

Overrides:

remove in class Container

Parameters:

index - an int specifying the component to remove

See Also:

removeAll

public void removeAll()

Removes all the components from this container.

Overrides:

removeAll in class Container

Since:

1.5

See Also:

isOptimizedDrawingEnabled

@BeanProperty(bound=false) public boolean isOptimizedDrawingEnabled()

Returns false if components in the pane can overlap, which makes optimized drawing impossible. Otherwise, returns true.

Overrides:

isOptimizedDrawingEnabled in class JComponent

Returns:

false if components can overlap, else true

See Also:

putLayer

public static void putLayer(JComponent c, int layer)

Sets the layer property on a JComponent. This method does not cause any side effects like setLayer() (painting, add/remove, etc). Normally you should use the instance method setLayer(), in order to get the desired side-effects (like repainting).

Parameters:

c - the JComponent to move

layer - an int specifying the layer to move it to

See Also:

getLayer

public static int getLayer(JComponent c)

Gets the layer property for a JComponent, it does not cause any side effects like setLayer(). (painting, add/remove, etc) Normally you should use the instance method getLayer().

Parameters:: c - the JComponent to check
Returns:: an int specifying the component's layer

getLayeredPaneAbove

public static JLayeredPane getLayeredPaneAbove(Component c)

Convenience method that returns the first JLayeredPane which contains the specified component. Note that all JFrames have a JLayeredPane at their root, so any component in a JFrame will have a JLayeredPane parent.

Parameters:

c - the Component to check

Returns:

the JLayeredPane that contains the component, or null if no JLayeredPane is found in the component hierarchy

See Also:

setLayer

public void setLayer(Component c, int layer)

Sets the layer attribute on the specified component, making it the bottommost component in that layer. Should be called before adding to parent.

Parameters:: c - the Component to set the layer for; layer - an int specifying the layer to set, where lower numbers are closer to the bottom

setLayer

public void setLayer(Component c, int layer, int position)

Sets the layer attribute for the specified component and also sets its position within that layer.

Parameters:: c - the Component to set the layer for; layer - an int specifying the layer to set, where lower numbers are closer to the bottom; position - an int specifying the position within the layer, where 0 is the topmost position and -1 is the bottommost position

getLayer

public int getLayer(Component c)

Returns the layer attribute for the specified Component.

Parameters:: c - the Component to check
Returns:: an int specifying the component's current layer

getIndexOf

public int getIndexOf(Component c)

Returns the index of the specified Component. This is the absolute index, ignoring layers. Index numbers, like position numbers, have the topmost component at index zero. Larger numbers are closer to the bottom.

Parameters:: c - the Component to check
Returns:: an int specifying the component's index

moveToFront

public void moveToFront(Component c)

Moves the component to the top of the components in its current layer (position 0).

Parameters:

c - the Component to move

See Also:

moveToBack

public void moveToBack(Component c)

Moves the component to the bottom of the components in its current layer (position -1).

Parameters:

c - the Component to move

See Also:

setPosition

public void setPosition(Component c, int position)

Moves the component to position within its current layer, where 0 is the topmost position within the layer and -1 is the bottommost position.

Note: Position numbering is defined by java.awt.Container, and is the opposite of layer numbering. Lower position numbers are closer to the top (0 is topmost), and higher position numbers are closer to the bottom.

Parameters:: c - the Component to move; position - an int in the range -1..N-1, where N is the number of components in the component's current layer

getPosition

public int getPosition(Component c)

Get the relative position of the component within its layer.

Parameters:

c - the Component to check

Returns:

an int giving the component's position, where 0 is the topmost position and the highest index value = the count of components at that layer minus 1

See Also:

highestLayer

public int highestLayer()

Returns the highest layer value from all current children. Returns 0 if there are no children.

Returns:: an int indicating the layer of the topmost component in the pane, or zero if there are no children

lowestLayer

public int lowestLayer()

Returns the lowest layer value from all current children. Returns 0 if there are no children.

Returns:: an int indicating the layer of the bottommost component in the pane, or zero if there are no children

getComponentCountInLayer

public int getComponentCountInLayer(int layer)

Returns the number of children currently in the specified layer.

Parameters:: layer - an int specifying the layer to check
Returns:: an int specifying the number of components in that layer

getComponentsInLayer

public Component[] getComponentsInLayer(int layer)

Returns an array of the components in the specified layer.

Parameters:: layer - an int specifying the layer to check
Returns:: an array of Components contained in that layer

paint

public void paint(Graphics g)

Paints this JLayeredPane within the specified graphics context.

Overrides:

paint in class JComponent

Parameters:

g - the Graphics context within which to paint

See Also:

getComponentToLayer

protected Hashtable<Component, Integer> getComponentToLayer()

Returns the hashtable that maps components to layers.

Returns:: the Hashtable used to map components to their layers

getObjectForLayer

protected Integer getObjectForLayer(int layer)

Returns the Integer object associated with a specified layer.

Parameters:: layer - an int specifying the layer
Returns:: an Integer object for that layer

insertIndexForLayer

protected int insertIndexForLayer(int layer, int position)

Primitive method that determines the proper location to insert a new child based on layer and position requests.

Parameters:

layer - an int specifying the layer

position - an int specifying the position within the layer

Returns:

an int giving the (absolute) insertion-index

See Also:

paramString

protected String paramString()

Returns a string representation of this JLayeredPane. 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 JComponent
Returns:: a string representation of this JLayeredPane.

getAccessibleContext

@BeanProperty(bound=false) public AccessibleContext getAccessibleContext()

Gets the AccessibleContext associated with this JLayeredPane. For layered panes, the AccessibleContext takes the form of an AccessibleJLayeredPane. A new AccessibleJLayeredPane instance is created if necessary.

Specified by:: getAccessibleContext in interface Accessible
Overrides:: getAccessibleContext in class Component
Returns:: an AccessibleJLayeredPane that serves as the AccessibleContext of this JLayeredPane

© 1993, 2025, 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.