net.sf.jguiraffe.gui.platform.swing.layout

Class SwingPercentLayoutAdapter

java.lang.Object

net.sf.jguiraffe.gui.platform.swing.layout.SwingPercentLayoutAdapter

All Implemented Interfaces:

LayoutManager, LayoutManager2, Serializable, PercentLayoutPlatformAdapter

public class SwingPercentLayoutAdapter
extends Object
implements LayoutManager2, PercentLayoutPlatformAdapter, Serializable

Implementation of a Swing-specific adapter class for the percent layout manager.

This class implements the percent layout manager for swing. It implements the LayoutManager2 interface and can be used as a standard Swing layout.

Version:

$Id: SwingPercentLayoutAdapter.java 205 2012-01-29 18:29:57Z oheger $

Author:

Oliver Heger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SwingPercentLayoutAdapter(PercentLayoutBase percentLayout) Creates a new instance of SwingPercentLayouAdaptert and sets the associated percent layout.

Method Summary

Modifier and Type	Method and Description
void	addLayoutComponent(Component comp, Object constraints) Adds a component to this layout.
void	addLayoutComponent(String name, Component comp) Adds a component to this layout manager using the given name as constraints object.
Object	getComponent(int index) Returns the component with the given index.
int	getComponentCount() Returns the number of components in this layout.
Object	getConstraints(int index) Returns the constraints for the component with the given index.
float	getLayoutAlignmentX(Container container) Returns the layout alignment in X direction.
float	getLayoutAlignmentY(Container container) Returns the layout alignment in Y direction.
int	getMinimumComponentSize(Object component, boolean vert) Returns the minimum size of the specified component in the given axis.
PercentLayoutBase	getPercentLayout() Returns a reference to the associated percent layout object.
int	getPreferredComponentSize(Object component, boolean vert) Returns the preferred size of the specified component in the given axis.
UnitSizeHandler	getSizeHandler() Returns the size handler used by this layout.
void	invalidateLayout(Container container) Invalidates this layout.
void	layoutContainer(Container container) Determines the coordinates and sizes of all components that belong to this layout.
Dimension	maximumLayoutSize(Container container) Returns the maximum layout size.
Dimension	minimumLayoutSize(Container container) Returns the minimum size of this layout.
Dimension	preferredLayoutSize(Container container) Returns the preferred size of this layout.
void	removeLayoutComponent(Component c) Removes the specified component from the layout manager.
void	setComponentBounds(Object component, Rectangle bounds) Initializes the bounds for the specified component.

Methods inherited from class java.lang.Object

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

Constructor Detail

SwingPercentLayoutAdapter

public SwingPercentLayoutAdapter(PercentLayoutBase percentLayout)

Creates a new instance of SwingPercentLayouAdaptert and sets the associated percent layout.

Parameters:

percentLayout - the percent layout object (must not be null)

Throws:

IllegalArgumentException - if the PercentLayoutBase object is null

Method Detail

getPercentLayout

public PercentLayoutBase getPercentLayout()

Returns a reference to the associated percent layout object.

Returns:

the percent layout object

getLayoutAlignmentX

public float getLayoutAlignmentX(Container container)

Returns the layout alignment in X direction.

Specified by:

getLayoutAlignmentX in interface LayoutManager2

Parameters:

container - the associated container

Returns:

the layout alignment in X direction

getLayoutAlignmentY

public float getLayoutAlignmentY(Container container)

Returns the layout alignment in Y direction.

Specified by:

getLayoutAlignmentY in interface LayoutManager2

Parameters:

container - the associated container

Returns:

the layout alignment in Y direction

invalidateLayout

public void invalidateLayout(Container container)

Invalidates this layout. Clears all cached values.

Specified by:

invalidateLayout in interface LayoutManager2

Parameters:

container - the associated container

maximumLayoutSize

public Dimension maximumLayoutSize(Container container)

Returns the maximum layout size. For this layout type there is no upper limit.

Specified by:

maximumLayoutSize in interface LayoutManager2

Parameters:

container - the container

Returns:

the maximum layout size

addLayoutComponent

public void addLayoutComponent(Component comp,
                               Object constraints)

Adds a component to this layout.

Specified by:

addLayoutComponent in interface LayoutManager2

Parameters:

comp - the component to add

constraints - the constraints

addLayoutComponent

public void addLayoutComponent(String name,
                               Component comp)

Adds a component to this layout manager using the given name as constraints object.

Specified by:

addLayoutComponent in interface LayoutManager

Parameters:

name - the name

comp - the component

removeLayoutComponent

public void removeLayoutComponent(Component c)

Removes the specified component from the layout manager.

Specified by:

removeLayoutComponent in interface LayoutManager

Parameters:

c - the component to remove

layoutContainer

public void layoutContainer(Container container)

Determines the coordinates and sizes of all components that belong to this layout.

Specified by:

layoutContainer in interface LayoutManager

Parameters:

container - the associated container

minimumLayoutSize

public Dimension minimumLayoutSize(Container container)

Returns the minimum size of this layout. For this layout type this equals the preferred layout size.

Specified by:

minimumLayoutSize in interface LayoutManager

Parameters:

container - the associated container

Returns:

the minimum layout size

preferredLayoutSize

public Dimension preferredLayoutSize(Container container)

Returns the preferred size of this layout.

Specified by:

preferredLayoutSize in interface LayoutManager

Parameters:

container - the associated container

Returns:

the preferred layout size

getSizeHandler

public UnitSizeHandler getSizeHandler()

Returns the size handler used by this layout. This happens to be a swing size handler.

Specified by:

getSizeHandler in interface PercentLayoutPlatformAdapter

Returns:

the size handler

getComponentCount

public int getComponentCount()

Returns the number of components in this layout.

Specified by:

getComponentCount in interface PercentLayoutPlatformAdapter

Returns:

the number of components

getComponent

public Object getComponent(int index)

Returns the component with the given index.

Specified by:

getComponent in interface PercentLayoutPlatformAdapter

Parameters:

index - the index

Returns:

the component with this index

getConstraints

public Object getConstraints(int index)

Returns the constraints for the component with the given index.

Specified by:

getConstraints in interface PercentLayoutPlatformAdapter

Parameters:

index - the index

Returns:

the constraints for the specified component

getMinimumComponentSize

public int getMinimumComponentSize(Object component,
                                   boolean vert)

Returns the minimum size of the specified component in the given axis.

Specified by:

getMinimumComponentSize in interface PercentLayoutPlatformAdapter

Parameters:

component - the component

vert - the flag for the axis

Returns:

the minimum component size

getPreferredComponentSize

public int getPreferredComponentSize(Object component,
                                     boolean vert)

Returns the preferred size of the specified component in the given axis.

Specified by:

getPreferredComponentSize in interface PercentLayoutPlatformAdapter

Parameters:

component - the component

vert - the flag for the axis

Returns:

the preferred component size

setComponentBounds

public void setComponentBounds(Object component,
                               Rectangle bounds)

Initializes the bounds for the specified component.

Specified by:

setComponentBounds in interface PercentLayoutPlatformAdapter

Parameters:

component - the component

bounds - the new bounds