| java.lang.Object | |
| ↳ | javax.swing.OverlayLayout |
Class Overview
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.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a layout manager that performs overlay
arrangement of the children.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Adds the specified component to the layout.
| |||||||||||
Adds the specified component to the layout, using the specified
constraint object.
| |||||||||||
Returns the alignment along the x axis for the container.
| |||||||||||
Returns the alignment along the y axis for the container.
| |||||||||||
Returns the container that uses this layout manager.
| |||||||||||
Indicates a child has changed its layout related information,
which causes any cached calculations to be flushed.
| |||||||||||
Called by the AWT when the specified container needs to be laid out.
| |||||||||||
Returns the maximum dimensions needed to lay out the components
contained in the specified target container.
| |||||||||||
Returns the minimum dimensions needed to lay out the components
contained in the specified target container.
| |||||||||||
Returns the preferred dimensions for this layout given the components
in the specified target container.
| |||||||||||
Removes the specified component from the layout.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
|
From interface
java.awt.LayoutManager
| |||||||||||
|
From interface
java.awt.LayoutManager2
| |||||||||||
Public Constructors
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 |
|---|
Public Methods
public void addLayoutComponent (String name, Component comp)
Adds the specified component to the layout. Used by this class to know when to invalidate layout.
Parameters
| name | the name of the component |
|---|---|
| comp | the the component to be added |
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.
Parameters
| comp | the component to be added |
|---|---|
| constraints | where/how the component is added to the layout. |
public float getLayoutAlignmentX (Container target)
Returns the alignment along the x axis for the container.
Parameters
| target | the container |
|---|
Returns
- the alignment >= 0.0f && <= 1.0f
public float getLayoutAlignmentY (Container target)
Returns the alignment along the y axis for the container.
Parameters
| target | the container |
|---|
Returns
- the alignment >= 0.0f && <= 1.0f
public final Container getTarget ()
Returns the container that uses this layout manager.
Returns
- the container that uses this layout manager
public void invalidateLayout (Container target)
Indicates a child has changed its layout related information, which causes any cached calculations to be flushed.
Parameters
| target | the container |
|---|
public void layoutContainer (Container target)
Called by the AWT when the specified container needs to be laid out.
Parameters
| target | the container to lay out |
|---|
Throws
| AWTError | if the target isn't the container specified to the constructor |
|---|
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.
Parameters
| target | the component that needs to be laid out |
|---|
Returns
- a
Dimensionobject containing the maximum dimensions
See Also
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.
Parameters
| target | the component which needs to be laid out |
|---|
Returns
- a Dimension object containing the minimum dimensions
See Also
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().
Parameters
| target | the component which needs to be laid out |
|---|
Returns
- a Dimension object containing the preferred dimensions
See Also
public void removeLayoutComponent (Component comp)
Removes the specified component from the layout. Used by this class to know when to invalidate layout.
Parameters
| comp | the component to remove |
|---|