net.staniscia.rca.swing.view.widget

Class PercentLayout

java.lang.Object

net.staniscia.rca.swing.view.widget.PercentLayout

All Implemented Interfaces:

LayoutManager, LayoutManager2

 class PercentLayout
extends Object
implements LayoutManager2

PercentLayout.
Constraint based layout which allow the space to be splitted using percentages. The following are allowed when adding components to container:

• container.add(component);
  in this case, the component will be sized to its preferred size
• container.add(component, "100");
  in this case, the component will have a width (or height) of 100
• container.add(component, "25%");
  in this case, the component will have a width (or height) of 25 % of the container width (or height)
  
• container.add(component, "*");
  in this case, the component will take the remaining space. if several components use the "*" constraint the space will be divided among the components.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	PercentLayout.Constraint
(package private) static class	PercentLayout.NumberConstraint
(package private) static class	PercentLayout.PercentConstraint

Field Summary

Fields

Modifier and Type	Field and Description
private int	gap
static int	HORIZONTAL Useful constant to layout the components horizontally (from top to bottom).
private Hashtable	m_ComponentToConstraint
private int	orientation
private static PercentLayout.Constraint	PREFERRED_SIZE
private static PercentLayout.Constraint	REMAINING_SPACE
static int	VERTICAL Useful constant to layout the components vertically (from left to right).

Constructor Summary

Constructors

Constructor and Description
PercentLayout() Creates a new HORIZONTAL PercentLayout with a gap of 0.
PercentLayout(int orientation, int gap)

Method Summary

Methods

Modifier and Type	Method and Description
void	addLayoutComponent(Component component, Object constraints)
void	addLayoutComponent(String name, Component comp) Adds the specified component with the specified name to the layout.
PercentLayout.Constraint	getConstraint(Component component)
int	getGap()
float	getLayoutAlignmentX(Container target) Returns the alignment along the x axis.
float	getLayoutAlignmentY(Container target) Returns the alignment along the y axis.
int	getOrientation()
void	invalidateLayout(Container target) Invalidates the layout, indicating that if the layout manager has cached information net should be discarded.
void	layoutContainer(Container parent)
Dimension	maximumLayoutSize(Container parent) Returns the maximum size of this component.
Dimension	minimumLayoutSize(Container parent) Calculates the minimum size dimensions for the specified panel given the components in the specified parent container.
Dimension	preferredLayoutSize(Container parent)
void	removeLayoutComponent(Component comp) Removes the specified component from the layout.
void	setConstraint(Component component, Object constraints)
void	setGap(int gap)
void	setOrientation(int orientation)

Methods inherited from class java.lang.Object

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

Field Detail

HORIZONTAL

public static final int HORIZONTAL

Useful constant to layout the components horizontally (from top to bottom).

See Also:

Constant Field Values

VERTICAL

public static final int VERTICAL

Useful constant to layout the components vertically (from left to right).

See Also:

Constant Field Values

REMAINING_SPACE

private static final PercentLayout.Constraint REMAINING_SPACE

PREFERRED_SIZE

private static final PercentLayout.Constraint PREFERRED_SIZE

orientation

private int orientation

gap

private int gap

m_ComponentToConstraint

private Hashtable m_ComponentToConstraint

Constructor Detail

PercentLayout

public PercentLayout()

Creates a new HORIZONTAL PercentLayout with a gap of 0.

PercentLayout

public PercentLayout(int orientation,
             int gap)

Method Detail

setGap

public void setGap(int gap)

getGap

public int getGap()

setOrientation

public void setOrientation(int orientation)

getOrientation

public int getOrientation()

getConstraint

public PercentLayout.Constraint getConstraint(Component component)

setConstraint

public void setConstraint(Component component,
                 Object constraints)

addLayoutComponent

public void addLayoutComponent(Component component,
                      Object constraints)

Specified by:

addLayoutComponent in interface LayoutManager2

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 net should be discarded.

Specified by:

invalidateLayout in interface LayoutManager2

addLayoutComponent

public void addLayoutComponent(String name,
                      Component comp)

Adds the specified component with the specified name to the layout.

Specified by:

addLayoutComponent in interface LayoutManager

Parameters:

name - the component name

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 ot be removed

minimumLayoutSize

public Dimension minimumLayoutSize(Container parent)

Calculates the minimum size dimensions for the specified panel given the components in the specified parent container.

Specified by:

minimumLayoutSize in interface LayoutManager

Parameters:

parent - the component to be laid out

See Also:

preferredLayoutSize(java.awt.Container)

maximumLayoutSize

public Dimension maximumLayoutSize(Container parent)

Returns the maximum size of this component.

Specified by:

maximumLayoutSize in interface LayoutManager2

See Also:

Component.getMinimumSize(), Component.getPreferredSize(), LayoutManager

preferredLayoutSize

public Dimension preferredLayoutSize(Container parent)

Specified by:

preferredLayoutSize in interface LayoutManager

layoutContainer

public void layoutContainer(Container parent)

Specified by:

layoutContainer in interface LayoutManager