OpenJDK 27 · javax.swing.JLayeredPane · APIdia, the JavaDoc alternative

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 java.beans.XMLEncoder.

Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
private Hashtable<Component, Integer>	componentToLayer
public static final Integer	DEFAULT_LAYER Convenience object defining the Default layer.
public static final Integer	DRAG_LAYER Convenience object defining the Drag layer.
public static final Integer	FRAME_CONTENT_LAYER Convenience object defining the Frame Content layer.
public static final String	LAYER_PROPERTY Bound property
public static final Integer	MODAL_LAYER Convenience object defining the Modal layer.
private boolean	optimizedDrawingPossible
public static final Integer	PALETTE_LAYER Convenience object defining the Palette layer.
public static final Integer	POPUP_LAYER Convenience object defining the Popup layer.

Inherited from javax.swing.JComponent:: DEBUG_GRAPHICS_LOADED focusController ivSourceComponent listenerList paintingChild TOOL_TIP_TEXT_KEY ui UNDEFINED_CONDITION WHEN_ANCESTOR_OF_FOCUSED_COMPONENT WHEN_FOCUSED WHEN_IN_FOCUSED_WINDOW

Constructor Summary

Access	Constructor and Description
public	JLayeredPane() Create a new JLayeredPane

Method Summary

Modifier and Type	Method and Description
protected void	addImpl(Component comp, Object constraints, int index) Overrides java.awt.Container.addImpl. Adds the specified component to this container at the specified index.
public AccessibleContext	Returns: an AccessibleJLayeredPane that serves as the AccessibleContext of this JLayeredPane getAccessibleContext() Overrides java.awt.Component.getAccessibleContext. Implements javax.accessibility.Accessible.getAccessibleContext. Gets the AccessibleContext associated with this JLayeredPane.
public int	Returns: an int specifying the number of components in that layer getComponentCountInLayer(int an int specifying the layer to check layer) Returns the number of children currently in the specified layer.
public Component[]	Returns: an array of Components contained in that layer getComponentsInLayer(int an int specifying the layer to check layer) Returns an array of the components in the specified layer.
protected Hashtable<Component, Integer>	Returns: the Hashtable used to map components to their layers getComponentToLayer() Returns the hashtable that maps components to layers.
public int	Returns: an int specifying the component's index getIndexOf(Component the Component to check c) Returns the index of the specified Component.
public static int	Returns: an int specifying the component's layer getLayer(JComponent the JComponent to check c) Gets the layer property for a JComponent, it does not cause any side effects like setLayer().
public int	Returns: an int specifying the component's current layer getLayer(Component the Component to check c) Returns the layer attribute for the specified Component.
public static JLayeredPane	Returns: the JLayeredPane that contains the component, or null if no JLayeredPane is found in the component hierarchy getLayeredPaneAbove(Component the Component to check c) Convenience method that returns the first JLayeredPane which contains the specified component.
protected Integer	Returns: an Integer object for that layer getObjectForLayer(int an int specifying the layer layer) Returns the Integer object associated with a specified layer.
public int	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 getPosition(Component the Component to check c) Get the relative position of the component within its layer.
public int	Returns: an int indicating the layer of the topmost component in the pane, or zero if there are no children highestLayer() Returns the highest layer value from all current children.
protected int	Returns: an int giving the (absolute) insertion-index insertIndexForLayer(int an int specifying the layer layer, int an int specifying the position within the layer position) Primitive method that determines the proper location to insert a new child based on layer and position requests.
private int	Returns: an int giving the (absolute) insertion-index insertIndexForLayer(Component component to ignore when determining index comp, int an int specifying the layer layer, int an int specifying the position within the layer position) This method is an extended version of insertIndexForLayer() to support setLayer which uses Container.setZOrder which does not remove the component from the containment hierarchy though we need to ignore it when calculating the insertion index.
public boolean	Returns: false if components can overlap, else true isOptimizedDrawingEnabled() Overrides javax.swing.JComponent.isOptimizedDrawingEnabled. Returns false if components in the pane can overlap, which makes optimized drawing impossible.
public int	Returns: an int indicating the layer of the bottommost component in the pane, or zero if there are no children lowestLayer() Returns the lowest layer value from all current children.
public void	moveToBack(Component the Component to move c) Moves the component to the bottom of the components in its current layer (position -1).
public void	moveToFront(Component the Component to move c) Moves the component to the top of the components in its current layer (position 0).
public void	paint(Graphics the Graphics context within which to paint g) Overrides javax.swing.JComponent.paint. Paints this JLayeredPane within the specified graphics context.
protected String	Returns: a string representation of this JLayeredPane. paramString() Overrides javax.swing.JComponent.paramString. Returns a string representation of this JLayeredPane.
public static void	putLayer(JComponent the JComponent to move c, int an int specifying the layer to move it to layer) Sets the layer property on a JComponent.
public void	remove(int an int specifying the component to remove index) Overrides java.awt.Container.remove. Remove the indexed component from this pane.
public void	removeAll() Overrides java.awt.Container.removeAll. Removes all the components from this container.
public void	setLayer(Component the Component to set the layer for c, int an int specifying the layer to set, where lower numbers are closer to the bottom layer) Sets the layer attribute on the specified component, making it the bottommost component in that layer.
public void	setLayer(Component the Component to set the layer for c, int an int specifying the layer to set, where lower numbers are closer to the bottom layer, int an int specifying the position within the layer, where 0 is the topmost position and -1 is the bottommost position position) Sets the layer attribute for the specified component and also sets its position within that layer.
public void	setPosition(Component the Component to move c, int an int in the range -1..N-1, where N is the number of components in the component's current layer 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.
private void	validateOptimizedDrawing()

Inherited from javax.swing.JComponent:: _paintImmediately addAncestorListener addNotify addVetoableChangeListener alwaysOnTop checkIfChildObscuredBySibling clientPropertyChanged componentInputMapChanged computeVisibleRect computeVisibleRect compWriteObjectNotify contains createToolTip disable dndDone dropLocationForPoint enable firePropertyChange firePropertyChange firePropertyChange fireVetoableChange getActionForKeyStroke getActionMap getActionMap getAlignmentX getAlignmentY getAncestorListeners getAutoscrolls getBaseline getBaselineResizeBehavior getBorder getBounds getClientProperty getComponentGraphics getComponentPopupMenu getConditionForKeyStroke getCreatedDoubleBuffer getDebugGraphicsOptions getDefaultLocale getFontMetrics getGraphics getGraphicsInvoked getHeight getInheritsPopupMenu getInputMap getInputMap getInputMap getInputVerifier getInsets getInsets getListeners getLocation getManagingFocusBackwardTraversalKeys getManagingFocusForwardTraversalKeys getMaximumSize getMinimumSize getNextFocusableComponent getPopupLocation getPreferredSize getRegisteredKeyStrokes getRootPane getSize getToolTipLocation getToolTipText getToolTipText getTopLevelAncestor getTransferHandler getUI getUIClassID getVerifyInputWhenFocusTarget getVetoableChangeListeners getVisibleRect getWidth getWriteObjCounter getX getY grabFocus hide isDoubleBuffered isLightweightComponent isManagingFocus isOpaque isPainting isPaintingForPrint isPaintingOrigin isPaintingTile isRequestFocusEnabled isValidateRoot paintBorder paintChildren paintComponent paintForceDoubleBuffered paintImmediately paintImmediately paintToOffscreen print printAll printBorder printChildren printComponent processComponentKeyEvent processKeyBinding processKeyBindings processKeyBindingsForAllComponents processKeyEvent processMouseEvent processMouseMotionEvent putClientProperty rectangleIsObscured registerKeyboardAction registerKeyboardAction removeAncestorListener removeNotify removeVetoableChangeListener repaint repaint requestDefaultFocus requestFocus requestFocus requestFocusInWindow requestFocusInWindow resetKeyboardActions reshape revalidate safelyGetGraphics safelyGetGraphics scrollRectToVisible setActionMap setAlignmentX setAlignmentY setAutoscrolls setBackground setBorder setComponentPopupMenu setCreatedDoubleBuffer setDebugGraphicsOptions setDefaultLocale setDoubleBuffered setDropLocation setEnabled setFocusTraversalKeys setFont setForeground setInheritsPopupMenu setInputMap setInputVerifier setMaximumSize setMinimumSize setNextFocusableComponent setOpaque setPaintingChild setPreferredSize setRequestFocusEnabled setToolTipText setTransferHandler setUI setUIProperty setVerifyInputWhenFocusTarget setVisible setWriteObjCounter shouldDebugGraphics superProcessMouseMotionEvent unregisterKeyboardAction update updateUI

Field Detail

componentToLayer	back to summary
private Hashtable<Component, Integer> componentToLayer

DEFAULT_LAYER	back to summary
public static final Integer DEFAULT_LAYER Convenience object defining the Default layer. Equivalent to Integer.valueOf(0).

DRAG_LAYER	back to summary
public static final Integer DRAG_LAYER Convenience object defining the Drag layer. Equivalent to Integer.valueOf(400).

FRAME_CONTENT_LAYER back to summary

FRAME_CONTENT_LAYER	back to summary
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 `JFrame`

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: JFrame

LAYER_PROPERTY	back to summary
public static final String LAYER_PROPERTY Bound property

MODAL_LAYER	back to summary
public static final Integer MODAL_LAYER Convenience object defining the Modal layer. Equivalent to Integer.valueOf(200).

optimizedDrawingPossible	back to summary
private boolean optimizedDrawingPossible

PALETTE_LAYER	back to summary
public static final Integer PALETTE_LAYER Convenience object defining the Palette layer. Equivalent to Integer.valueOf(100).

POPUP_LAYER	back to summary
public static final Integer POPUP_LAYER Convenience object defining the Popup layer. Equivalent to Integer.valueOf(300).

Constructor Detail

JLayeredPane	back to summary
public JLayeredPane() Create a new JLayeredPane

Method Detail

addImpl back to summary

addImpl	back to summary
protected void addImpl(Component comp, Object constraints, int index) Overrides java.awt.Container.addImpl. Doc from java.awt.Container.addImpl. Adds the specified component to this container at the specified index. This method also notifies the layout manager to add the component to this container's layout using the specified constraints object via the `addLayoutComponent` method. The constraints are defined by the particular layout manager being used. For example, the `BorderLayout` class defines five constraints: `BorderLayout.NORTH`, `BorderLayout.SOUTH`, `BorderLayout.EAST`, `BorderLayout.WEST`, and `BorderLayout.CENTER`. The `GridBagLayout` class requires a `GridBagConstraints` object. Failure to pass the correct type of constraints object results in an `IllegalArgumentException`. If the current layout manager implements `LayoutManager2`, then `LayoutManager2#addLayoutComponent(Component, Object)` is invoked on it. If the current layout manager does not implement `LayoutManager2`, and constraints is a `String`, then `LayoutManager#addLayoutComponent(String, Component)` is invoked on it. If the component is not an ancestor of this container and has a non-null parent, it is removed from its current parent before it is added to this container. This is the method to override if a program needs to track every add request to a container as all other add methods defer to this one. An overriding method should usually include a call to the superclass's version of the method: `super.addImpl(comp, constraints, index)` This method changes layout-related information, and therefore, invalidates the component hierarchy. If the container has already been displayed, the hierarchy must be validated thereafter in order to display the added component.

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

Overrides java.awt.Container.addImpl.

Doc from java.awt.Container.addImpl.

Adds the specified component to this container at the specified index. This method also notifies the layout manager to add the component to this container's layout using the specified constraints object via the addLayoutComponent method.

The constraints are defined by the particular layout manager being used. For example, the BorderLayout class defines five constraints: BorderLayout.NORTH, BorderLayout.SOUTH, BorderLayout.EAST, BorderLayout.WEST, and BorderLayout.CENTER.

The GridBagLayout class requires a GridBagConstraints object. Failure to pass the correct type of constraints object results in an IllegalArgumentException.

If the current layout manager implements LayoutManager2, then LayoutManager2#addLayoutComponent(Component, Object) is invoked on it. If the current layout manager does not implement LayoutManager2, and constraints is a String, then LayoutManager#addLayoutComponent(String, Component) is invoked on it.

If the component is not an ancestor of this container and has a non-null parent, it is removed from its current parent before it is added to this container.

This is the method to override if a program needs to track every add request to a container as all other add methods defer to this one. An overriding method should usually include a call to the superclass's version of the method:

super.addImpl(comp, constraints, index)

This method changes layout-related information, and therefore, invalidates the component hierarchy. If the container has already been displayed, the hierarchy must be validated thereafter in order to display the added component.

getAccessibleContext	back to summary
public AccessibleContext getAccessibleContext() Overrides java.awt.Component.getAccessibleContext. Implements javax.accessibility.Accessible.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. Returns:AccessibleContext an AccessibleJLayeredPane that serves as the AccessibleContext of this JLayeredPane Annotations @BeanProperty bound:false

getAccessibleContext

back to summary

public AccessibleContext getAccessibleContext()

Overrides java.awt.Component.getAccessibleContext.

Implements javax.accessibility.Accessible.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.

Returns:AccessibleContext

an AccessibleJLayeredPane that serves as the AccessibleContext of this JLayeredPane

Annotations

@BeanProperty
bound:false

getComponentCountInLayer	back to summary
public int getComponentCountInLayer(int layer) Returns the number of children currently in the specified layer. Parameters layer:int an int specifying the layer to check Returns:int an int specifying the number of components in that layer

getComponentCountInLayer

back to summary

public int getComponentCountInLayer(int layer)

Returns the number of children currently in the specified layer.

Parameters

layer:int: an int specifying the layer to check

Returns:int

an int specifying the number of components in that layer

getComponentsInLayer	back to summary
public Component[] getComponentsInLayer(int layer) Returns an array of the components in the specified layer. Parameters layer:int an int specifying the layer to check Returns:Component[] an array of Components contained in that layer

getComponentsInLayer

back to summary

public Component[] getComponentsInLayer(int layer)

Returns an array of the components in the specified layer.

Parameters

layer:int: an int specifying the layer to check

Returns:Component[]

an array of Components contained in that layer

getComponentToLayer	back to summary
protected Hashtable<Component, Integer> getComponentToLayer() Returns the hashtable that maps components to layers. Returns:Hashtable<Component, Integer> the Hashtable used to map components to their layers

getComponentToLayer

back to summary

protected Hashtable<Component, Integer> getComponentToLayer()

Returns the hashtable that maps components to layers.

Returns:Hashtable<Component, Integer>: the Hashtable used to map components to their layers

getIndexOf	back to summary
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:Component the Component to check Returns:int an int specifying the component's index

getIndexOf

back to summary

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:Component: the Component to check

Returns:int

an int specifying the component's index

getLayer	back to summary
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:JComponent the JComponent to check Returns:int an int specifying the component's layer

getLayer

back to summary

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:JComponent: the JComponent to check

Returns:int

an int specifying the component's layer

getLayer	back to summary
public int getLayer(Component c) Returns the layer attribute for the specified Component. Parameters c:Component the Component to check Returns:int an int specifying the component's current layer

getLayer

back to summary

public int getLayer(Component c)

Returns the layer attribute for the specified Component.

Parameters

c:Component: the Component to check

Returns:int

an int specifying the component's current layer

getLayeredPaneAbove back to summary

getLayeredPaneAbove	back to summary
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:Component the Component to check Returns:JLayeredPane the JLayeredPane that contains the component, or null if no JLayeredPane is found in the component hierarchy See Also `JFrame`, `JRootPane`

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:Component: the Component to check

Returns:JLayeredPane

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

See Also

JFrame, JRootPane

getObjectForLayer	back to summary
protected Integer getObjectForLayer(int layer) Returns the Integer object associated with a specified layer. Parameters layer:int an int specifying the layer Returns:Integer an Integer object for that layer

getObjectForLayer

back to summary

protected Integer getObjectForLayer(int layer)

Returns the Integer object associated with a specified layer.

Parameters

layer:int: an int specifying the layer

Returns:Integer

an Integer object for that layer

getPosition back to summary

getPosition	back to summary
public int getPosition(Component c) Get the relative position of the component within its layer. Parameters c:Component the Component to check Returns:int 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 `getComponentCountInLayer`

public int getPosition(Component c)

Get the relative position of the component within its layer.

Parameters

c:Component: the Component to check

Returns:int

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

getComponentCountInLayer

highestLayer	back to summary
public int highestLayer() Returns the highest layer value from all current children. Returns 0 if there are no children. Returns:int an int indicating the layer of the topmost component in the pane, or zero if there are no children

highestLayer

back to summary

public int highestLayer()

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

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

insertIndexForLayer back to summary

insertIndexForLayer	back to summary
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:int an int specifying the layer position:int an int specifying the position within the layer Returns:int an int giving the (absolute) insertion-index See Also `getIndexOf`

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:int: an int specifying the layer
position:int: an int specifying the position within the layer

Returns:int

an int giving the (absolute) insertion-index

See Also

getIndexOf

insertIndexForLayer back to summary

insertIndexForLayer	back to summary
private int insertIndexForLayer(Component comp, int layer, int position) This method is an extended version of insertIndexForLayer() to support setLayer which uses Container.setZOrder which does not remove the component from the containment hierarchy though we need to ignore it when calculating the insertion index. Parameters comp:Component component to ignore when determining index layer:int an int specifying the layer position:int an int specifying the position within the layer Returns:int an int giving the (absolute) insertion-index See Also `getIndexOf`

private int insertIndexForLayer(Component comp, int layer, int position)

This method is an extended version of insertIndexForLayer() to support setLayer which uses Container.setZOrder which does not remove the component from the containment hierarchy though we need to ignore it when calculating the insertion index.

Parameters

comp:Component: component to ignore when determining index
layer:int: an int specifying the layer
position:int: an int specifying the position within the layer

Returns:int

an int giving the (absolute) insertion-index

See Also

getIndexOf

isOptimizedDrawingEnabled back to summary

isOptimizedDrawingEnabled	back to summary
public boolean isOptimizedDrawingEnabled() Overrides javax.swing.JComponent.isOptimizedDrawingEnabled. Returns false if components in the pane can overlap, which makes optimized drawing impossible. Otherwise, returns true. Returns:boolean false if components can overlap, else true Annotations @BeanProperty bound:false See Also `JComponent#isOptimizedDrawingEnabled`

public boolean isOptimizedDrawingEnabled()

Overrides javax.swing.JComponent.isOptimizedDrawingEnabled.

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

Returns:boolean

false if components can overlap, else true

Annotations

@BeanProperty
bound:false

See Also

JComponent#isOptimizedDrawingEnabled

lowestLayer	back to summary
public int lowestLayer() Returns the lowest layer value from all current children. Returns 0 if there are no children. Returns:int an int indicating the layer of the bottommost component in the pane, or zero if there are no children

lowestLayer

back to summary

public int lowestLayer()

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

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

moveToBack back to summary

moveToBack	back to summary
public void moveToBack(Component c) Moves the component to the bottom of the components in its current layer (position -1). Parameters c:Component the Component to move See Also `setPosition(Component, int)`

public void moveToBack(Component c)

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

Parameters

c:Component: the Component to move

See Also

setPosition(Component, int)

moveToFront back to summary

moveToFront	back to summary
public void moveToFront(Component c) Moves the component to the top of the components in its current layer (position 0). Parameters c:Component the Component to move See Also `setPosition(Component, int)`

public void moveToFront(Component c)

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

Parameters

c:Component: the Component to move

See Also

setPosition(Component, int)

paint	back to summary
public void paint(Graphics g) Overrides javax.swing.JComponent.paint. Paints this JLayeredPane within the specified graphics context. Parameters g:Graphics the Graphics context within which to paint

paint

back to summary

public void paint(Graphics g)

Overrides javax.swing.JComponent.paint.

Paints this JLayeredPane within the specified graphics context.

Parameters

g:Graphics: the Graphics context within which to paint

paramString back to summary

paramString	back to summary
protected String paramString() Overrides javax.swing.JComponent.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`. Returns:String a string representation of this JLayeredPane.

protected String paramString()

Overrides javax.swing.JComponent.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.

Returns:String: a string representation of this JLayeredPane.

putLayer back to summary

putLayer	back to summary
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:JComponent the JComponent to move layer:int an int specifying the layer to move it to See Also `setLayer`

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:JComponent: the JComponent to move
layer:int: an int specifying the layer to move it to

See Also

setLayer

remove back to summary

remove	back to summary
public void remove(int index) Overrides java.awt.Container.remove. Remove the indexed component from this pane. This is the absolute index, ignoring layers. Parameters index:int an int specifying the component to remove See Also `getIndexOf`

public void remove(int index)

Overrides java.awt.Container.remove.

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

Parameters

index:int: an int specifying the component to remove

See Also

getIndexOf

removeAll	back to summary
public void removeAll() Overrides java.awt.Container.removeAll. Removes all the components from this container. Since 1.5

removeAll

back to summary

public void removeAll()

Overrides java.awt.Container.removeAll.

Removes all the components from this container.

Since: 1.5

setLayer	back to summary
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:Component the Component to set the layer for layer:int an int specifying the layer to set, where lower numbers are closer to the bottom

setLayer

back to summary

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:Component: the Component to set the layer for
layer:int: an int specifying the layer to set, where lower numbers are closer to the bottom

setLayer	back to summary
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:Component the Component to set the layer for layer:int an int specifying the layer to set, where lower numbers are closer to the bottom position:int an int specifying the position within the layer, where 0 is the topmost position and -1 is the bottommost position

setLayer

back to summary

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:Component: the Component to set the layer for
layer:int: an int specifying the layer to set, where lower numbers are closer to the bottom
position:int: an int specifying the position within the layer, where 0 is the topmost position and -1 is the bottommost position

setPosition back to summary

setPosition	back to summary
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:Component the Component to move position:int an int in the range -1..N-1, where N is the number of components in the component's current layer

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:Component: the Component to move
position:int: an int in the range -1..N-1, where N is the number of components in the component's current layer

validateOptimizedDrawing	back to summary
private void validateOptimizedDrawing()

public Class JLayeredPane

Details

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class JLayeredPane.AccessibleJLayeredPane

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail