net.sf.magicproject.ui.layout
Class SectorLayout

java.lang.Object
  net.sf.magicproject.ui.layout.SectorLayout

All Implemented Interfaces:

java.awt.LayoutManager, java.awt.LayoutManager2, java.io.Serializable

public class SectorLayout
extends java.lang.Object
implements java.awt.LayoutManager2, java.io.Serializable

Since:

0.91

Author:

Fabrice Daugan

See Also:

Serialized Form

Constructor Summary

SectorLayout(int hgap, int vgap, java.util.List<ZoneSector> sectors)
Constructs a border layout with the specified gaps between components.

SectorLayout(java.util.List<ZoneSector> sectors)
Constructs a new border layout with no gaps between components.

Method Summary

void	addLayoutComponent(java.awt.Component comp, java.lang.Object constraints)
void	addLayoutComponent(java.lang.String name, java.awt.Component comp)
int	getHgap() Returns the horizontal gap between components.
float	getLayoutAlignmentX(java.awt.Container parent) Returns the alignment along the x axis.
float	getLayoutAlignmentY(java.awt.Container parent) Returns the alignment along the y axis.
int	getVgap() Returns the vertical gap between components.
void	invalidateLayout(java.awt.Container target) Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.
void	layoutContainer(java.awt.Container target) Lays out the container argument using this border layout.
java.awt.Dimension	maximumLayoutSize(java.awt.Container target) Returns the maximum dimensions for this layout given the components in the specified target container.
java.awt.Dimension	minimumLayoutSize(java.awt.Container target) Determines the minimum size of the target container using this layout manager.
java.awt.Dimension	preferredLayoutSize(java.awt.Container target) Determines the preferred size of the target container using this layout manager, based on the components in the container.
void	removeLayoutComponent(java.awt.Component comp)
void	setHgap(int hgap) Sets the horizontal gap between components.
void	setVgap(int vgap) Sets the vertical gap between components.
java.lang.String	toString() Returns a string representation of the state of this border layout.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SectorLayout

public SectorLayout(java.util.List<ZoneSector> sectors)

Constructs a new border layout with no gaps between components.

Parameters:

sectors - defined sectors.

SectorLayout

public SectorLayout(int hgap,
                    int vgap,
                    java.util.List<ZoneSector> sectors)

Constructs a border layout with the specified gaps between components. The horizontal gap is specified by hgap and the vertical gap is specified by vgap.

Parameters:

hgap - the horizontal gap.

vgap - the vertical gap.

sectors - defined sectors.

Method Detail

getHgap

public int getHgap()

Returns the horizontal gap between components.

Returns:

the horizontal gap.

Since:

JDK1.1

setHgap

public void setHgap(int hgap)

Sets the horizontal gap between components.

Parameters:

hgap - the horizontal gap between components

Since:

JDK1.1

getVgap

public int getVgap()

Returns the vertical gap between components.

Returns:

the vertical gap.

Since:

JDK1.1

setVgap

public void setVgap(int vgap)

Sets the vertical gap between components.

Parameters:

vgap - the vertical gap between components

Since:

JDK1.1

addLayoutComponent

public void addLayoutComponent(java.awt.Component comp,
                               java.lang.Object constraints)

Specified by:

addLayoutComponent in interface java.awt.LayoutManager2

addLayoutComponent

public void addLayoutComponent(java.lang.String name,
                               java.awt.Component comp)

Specified by:

addLayoutComponent in interface java.awt.LayoutManager

removeLayoutComponent

public void removeLayoutComponent(java.awt.Component comp)

Specified by:

removeLayoutComponent in interface java.awt.LayoutManager

minimumLayoutSize

public java.awt.Dimension minimumLayoutSize(java.awt.Container target)

Determines the minimum size of the target container using this layout manager.

This method is called when a container calls its getMinimumSize method. Most applications do not call this method directly.

Specified by:

minimumLayoutSize in interface java.awt.LayoutManager

Parameters:

target - the container in which to do the layout.

Returns:

the minimum dimensions needed to lay out the subcomponents of the specified container.

See Also:

Container, preferredLayoutSize(java.awt.Container), Container.getMinimumSize()

preferredLayoutSize

public java.awt.Dimension preferredLayoutSize(java.awt.Container target)

Determines the preferred size of the target container using this layout manager, based on the components in the container.

Most applications do not call this method directly. This method is called when a container calls its getPreferredSize method.

Specified by:

preferredLayoutSize in interface java.awt.LayoutManager

Parameters:

target - the container in which to do the layout.

Returns:

the preferred dimensions to lay out the subcomponents of the specified container.

See Also:

Container, minimumLayoutSize(java.awt.Container), Container.getPreferredSize()

maximumLayoutSize

public java.awt.Dimension maximumLayoutSize(java.awt.Container target)

Returns the maximum dimensions for this layout given the components in the specified target container.

Specified by:

maximumLayoutSize in interface java.awt.LayoutManager2

Parameters:

target - the component which needs to be laid out

Returns:

the maximum dimensions for this layout

See Also:

Container, minimumLayoutSize(java.awt.Container), preferredLayoutSize(java.awt.Container)

getLayoutAlignmentX

public float getLayoutAlignmentX(java.awt.Container parent)

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 java.awt.LayoutManager2

Parameters:

parent -

Returns:

the alignment along the x axis.

getLayoutAlignmentY

public float getLayoutAlignmentY(java.awt.Container parent)

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 java.awt.LayoutManager2

Parameters:

parent -

Returns:

the alignment along the y axis.

invalidateLayout

public void invalidateLayout(java.awt.Container target)

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

Specified by:

invalidateLayout in interface java.awt.LayoutManager2

Parameters:

target -

layoutContainer

public void layoutContainer(java.awt.Container target)

Lays out the container argument using this border layout.

This method actually reshapes the components in the specified container in order to satisfy the constraints of this SectorLayout object. The NORTH and SOUTH components, if any, are placed at the top and bottom of the container, respectively. The WEST and EAST components are then placed on the left and right, respectively. Finally, the CENTER object is placed in any remaining space in the middle.

Most applications do not call this method directly. This method is called when a container calls its doLayout method.

Specified by:

layoutContainer in interface java.awt.LayoutManager

Parameters:

target - the container in which to do the layout.

See Also:

Container, Container.doLayout()

toString

public java.lang.String toString()

Returns a string representation of the state of this border layout.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this border layout.