OverlayLayout (Java Platform SE 6) (original) (raw)

javax.swing

Class OverlayLayout

java.lang.Object javax.swing.OverlayLayout

All Implemented Interfaces:

LayoutManager, LayoutManager2, Serializable

public class OverlayLayout

extends Object

implements LayoutManager2, Serializable

A layout manager to arrange components over the top of each other. The requested size of the container will be the largest requested size of the children, taking alignment needs into consideration. The alignment is based upon what is needed to properly fit the children in the allocation area. The children will be placed such that their alignment points are all on top of each other.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeansTM has been added to the java.beans package. Please see XMLEncoder.

OverlayLayout

public OverlayLayout(Container target)

Constructs a layout manager that performs overlay arrangement of the children. The layout manager created is dedicated to the given container.

Parameters:

target - the container to do layout against

getTarget

public final Container getTarget()

Returns the container that uses this layout manager.

Returns:

the container that uses this layout manager

Since:

1.6

invalidateLayout

public void invalidateLayout(Container target)

Indicates a child has changed its layout related information, which causes any cached calculations to be flushed.

Specified by:

[invalidateLayout](../../java/awt/LayoutManager2.html#invalidateLayout%28java.awt.Container%29) in interface [LayoutManager2](../../java/awt/LayoutManager2.html "interface in java.awt")

Parameters:

target - the container

addLayoutComponent

public void addLayoutComponent(String name, Component comp)

Adds the specified component to the layout. Used by this class to know when to invalidate layout.

Specified by:

[addLayoutComponent](../../java/awt/LayoutManager.html#addLayoutComponent%28java.lang.String, java.awt.Component%29) in interface [LayoutManager](../../java/awt/LayoutManager.html "interface in java.awt")

Parameters:

name - the name of the component

comp - the the component to be added

removeLayoutComponent

public void removeLayoutComponent(Component comp)

Removes the specified component from the layout. Used by this class to know when to invalidate layout.

Specified by:

[removeLayoutComponent](../../java/awt/LayoutManager.html#removeLayoutComponent%28java.awt.Component%29) in interface [LayoutManager](../../java/awt/LayoutManager.html "interface in java.awt")

Parameters:

comp - the component to remove

addLayoutComponent

public void addLayoutComponent(Component comp, Object constraints)

Adds the specified component to the layout, using the specified constraint object. Used by this class to know when to invalidate layout.

Specified by:

[addLayoutComponent](../../java/awt/LayoutManager2.html#addLayoutComponent%28java.awt.Component, java.lang.Object%29) in interface [LayoutManager2](../../java/awt/LayoutManager2.html "interface in java.awt")

Parameters:

comp - the component to be added

constraints - where/how the component is added to the layout.

preferredLayoutSize

public Dimension preferredLayoutSize(Container target)

Returns the preferred dimensions for this layout given the components in the specified target container. Recomputes the layout if it has been invalidated. Factors in the current inset setting returned by getInsets().

Specified by:

[preferredLayoutSize](../../java/awt/LayoutManager.html#preferredLayoutSize%28java.awt.Container%29) in interface [LayoutManager](../../java/awt/LayoutManager.html "interface in java.awt")

Parameters:

target - the component which needs to be laid out

Returns:

a Dimension object containing the preferred dimensions

See Also:

minimumLayoutSize(java.awt.Container)

minimumLayoutSize

public Dimension minimumLayoutSize(Container target)

Returns the minimum dimensions needed to lay out the components contained in the specified target container. Recomputes the layout if it has been invalidated, and factors in the current inset setting.

Specified by:

[minimumLayoutSize](../../java/awt/LayoutManager.html#minimumLayoutSize%28java.awt.Container%29) in interface [LayoutManager](../../java/awt/LayoutManager.html "interface in java.awt")

Parameters:

target - the component which needs to be laid out

Returns:

a Dimension object containing the minimum dimensions

See Also:

preferredLayoutSize(java.awt.Container)

maximumLayoutSize

public Dimension maximumLayoutSize(Container target)

Returns the maximum dimensions needed to lay out the components contained in the specified target container. Recomputes the layout if it has been invalidated, and factors in the inset setting returned by getInset.

Specified by:

[maximumLayoutSize](../../java/awt/LayoutManager2.html#maximumLayoutSize%28java.awt.Container%29) in interface [LayoutManager2](../../java/awt/LayoutManager2.html "interface in java.awt")

Parameters:

target - the component that needs to be laid out

Returns:

a Dimension object containing the maximum dimensions

See Also:

preferredLayoutSize(java.awt.Container)

getLayoutAlignmentX

public float getLayoutAlignmentX(Container target)

Returns the alignment along the x axis for the container.

Specified by:

[getLayoutAlignmentX](../../java/awt/LayoutManager2.html#getLayoutAlignmentX%28java.awt.Container%29) in interface [LayoutManager2](../../java/awt/LayoutManager2.html "interface in java.awt")

Parameters:

target - the container

Returns:

the alignment >= 0.0f && <= 1.0f

getLayoutAlignmentY

public float getLayoutAlignmentY(Container target)

Returns the alignment along the y axis for the container.

Specified by:

[getLayoutAlignmentY](../../java/awt/LayoutManager2.html#getLayoutAlignmentY%28java.awt.Container%29) in interface [LayoutManager2](../../java/awt/LayoutManager2.html "interface in java.awt")

Parameters:

target - the container

Returns:

the alignment >= 0.0f && <= 1.0f

layoutContainer

public void layoutContainer(Container target)

Called by the AWT when the specified container needs to be laid out.

Specified by:

[layoutContainer](../../java/awt/LayoutManager.html#layoutContainer%28java.awt.Container%29) in interface [LayoutManager](../../java/awt/LayoutManager.html "interface in java.awt")

Parameters:

target - the container to lay out

Throws:

[AWTError](../../java/awt/AWTError.html "class in java.awt") - if the target isn't the container specified to the constructor

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Scripting on this page tracks web page traffic, but does not change the content in any way.