org.jdesktop.swingx
Class StackLayout

java.lang.Object
  org.jdesktop.swingx.StackLayout

All Implemented Interfaces:

LayoutManager, LayoutManager2

public class StackLayout
extends Object
implements LayoutManager2

StackLayout is a Swing layout aimed to act as the layers stack of most popuplar graphics editing tools like The GIMP or Photoshop. While similar to CardLayout, this layout displays all the components of the container. If you are using non-rectangular components (i.e. transparent) you will see them from top to bottom of the stack.

When using this layout, each component can be added in the container either on top of the stack or at the bootom:

 JPanel panel = new JPanel(new StackLayout());
 panel.add(new JLabel("On top"),    StackLayout.TOP);
 panel.add(new JLabel("At bottom"), StackLayout.BOTTOM);
 

If you don't specify the constraint, the component will be added at the top of the components stack.

All the components managed by this layout will be given the same size as the container itself. The minimum, maximum and preferred size of the container are based upon the largest minimum, maximum and preferred size of the children components.

StackLayout works only with JSE 1.5 and Java SE 6 and greater.

Field Summary

static String	BOTTOM Use this constraint to add a component at the bottom of the stack.
static String	TOP Use this contrainst to add a component at the top of the stack.

Constructor Summary

StackLayout()

Method Summary

void	addLayoutComponent(Component comp, Object constraints) Adds the specified component to the layout, using the specified constraint object.
void	addLayoutComponent(String name, Component comp) If the layout manager uses a per-component string, adds the component comp to the layout, associating it with the string specified by name.
float	getLayoutAlignmentX(Container target) Returns the alignment along the x axis.
float	getLayoutAlignmentY(Container target) Returns the alignment along the y axis.
void	invalidateLayout(Container target) Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.
void	layoutContainer(Container parent) Lays out the specified container.
Dimension	maximumLayoutSize(Container target) Calculates the maximum size dimensions for the specified container, given the components it contains.
Dimension	minimumLayoutSize(Container parent) Calculates the minimum size dimensions for the specified container, given the components it contains.
Dimension	preferredLayoutSize(Container parent) Calculates the preferred size dimensions for the specified container, given the components it contains.
void	removeLayoutComponent(Component comp) Removes the specified component from the layout.

Methods inherited from class java.lang.Object

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

Field Detail

BOTTOM

public static final String BOTTOM

Use this constraint to add a component at the bottom of the stack.

See Also:

Constant Field Values

TOP

public static final String TOP

Use this contrainst to add a component at the top of the stack.

See Also:

Constant Field Values

Constructor Detail

StackLayout

public StackLayout()

Method Detail

addLayoutComponent

public void addLayoutComponent(Component comp,
                               Object constraints)

Adds the specified component to the layout, using the specified constraint object.

Specified by:

addLayoutComponent in interface LayoutManager2

Parameters:

comp - the component to be added

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

addLayoutComponent

public void addLayoutComponent(String name,
                               Component comp)

If the layout manager uses a per-component string, adds the component comp to the layout, associating it with the string specified by name.

Specified by:

addLayoutComponent in interface LayoutManager

Parameters:

name - the string to be associated with the component

comp - the component to be added

removeLayoutComponent

public void removeLayoutComponent(Component comp)

Removes the specified component from the layout.

Specified by:

removeLayoutComponent in interface LayoutManager

Parameters:

comp - the component to be removed

getLayoutAlignmentX

public float getLayoutAlignmentX(Container target)

Returns the alignment along the x axis. This specifies how the component would like to be aligned relative to other components. The value should be a number between 0 and 1 where 0 represents alignment along the origin, 1 is aligned the furthest away from the origin, 0.5 is centered, etc.

Specified by:

getLayoutAlignmentX in interface LayoutManager2

getLayoutAlignmentY

public float getLayoutAlignmentY(Container target)

Returns the alignment along the y axis. This specifies how the component would like to be aligned relative to other components. The value should be a number between 0 and 1 where 0 represents alignment along the origin, 1 is aligned the furthest away from the origin, 0.5 is centered, etc.

Specified by:

getLayoutAlignmentY in interface LayoutManager2

invalidateLayout

public void invalidateLayout(Container target)

Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.

Specified by:

invalidateLayout in interface LayoutManager2

preferredLayoutSize

public Dimension preferredLayoutSize(Container parent)

Calculates the preferred size dimensions for the specified container, given the components it contains.

Specified by:

preferredLayoutSize in interface LayoutManager

Parameters:

parent - the container to be laid out

See Also:

LayoutManager.minimumLayoutSize(java.awt.Container)

minimumLayoutSize

public Dimension minimumLayoutSize(Container parent)

Calculates the minimum size dimensions for the specified container, given the components it contains.

Specified by:

minimumLayoutSize in interface LayoutManager

Parameters:

parent - the component to be laid out

See Also:

LayoutManager.preferredLayoutSize(java.awt.Container)

maximumLayoutSize

public Dimension maximumLayoutSize(Container target)

Calculates the maximum size dimensions for the specified container, given the components it contains.

Specified by:

maximumLayoutSize in interface LayoutManager2

See Also:

Component.getMaximumSize(), LayoutManager

layoutContainer

public void layoutContainer(Container parent)

Lays out the specified container.

Specified by:

layoutContainer in interface LayoutManager

Parameters:

parent - the container to be laid out