org.trianacode.gui.components.map

Class MapLayout

java.lang.Object

org.trianacode.gui.components.map.MapLayout

All Implemented Interfaces:

java.awt.LayoutManager, TaskLayoutDetails

public class MapLayout
extends java.lang.Object
implements java.awt.LayoutManager, TaskLayoutDetails

The layout manager responsible for positioning components on the map.

Constructor Summary

Constructors

Constructor and Description
MapLayout(java.awt.Dimension mapsize) Constructs a map layout for the specified mapsize
MapLayout(java.awt.Dimension mapsize, double compfactor) Constructs a map layout for the specified mapsize

Method Summary

Methods

Modifier and Type	Method and Description
void	addLayoutComponent(java.lang.String name, java.awt.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.
int	getLeftBorder()
java.awt.Point	getMapPoint(java.lang.String location)
java.awt.Dimension	getMapsize()
TDimension	getTaskDimensions()
int	getTopBorder()
boolean	isMapPoint(java.lang.String location)
void	layoutContainer(java.awt.Container parent) Lays out the specified container.
java.awt.Dimension	minimumLayoutSize(java.awt.Container parent) Calculates the minimum size dimensions for the specified container, given the components it contains.
java.awt.Dimension	preferredLayoutSize(java.awt.Container parent) Calculates the preferred size dimensions for the specified container, given the components it contains.
void	removeLayoutComponent(java.awt.Component comp) Removes the specified component from the layout.
void	setMapPoint(java.lang.String location, java.awt.Point point) Sets the poin on the map for the specified location
void	setMapSize(java.awt.Dimension mapsize) Sets the map size used by this layout manager

Methods inherited from class java.lang.Object

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

Constructor Detail

MapLayout

public MapLayout(java.awt.Dimension mapsize)

Constructs a map layout for the specified mapsize

MapLayout

public MapLayout(java.awt.Dimension mapsize,
         double compfactor)

Constructs a map layout for the specified mapsize

Parameters:

compfactor - a scale factor for the components (default = 1).

Method Detail

setMapSize

public void setMapSize(java.awt.Dimension mapsize)

Sets the map size used by this layout manager

getMapsize

public java.awt.Dimension getMapsize()

Returns:

the current map size

setMapPoint

public void setMapPoint(java.lang.String location,
               java.awt.Point point)

Sets the poin on the map for the specified location

getMapPoint

public java.awt.Point getMapPoint(java.lang.String location)

Returns:

the point (0<=x<=1, 0<=y<=1) on the map for the specified location

isMapPoint

public boolean isMapPoint(java.lang.String location)

Returns:

true if there is a point registered for the specified location

getLeftBorder

public int getLeftBorder()

Specified by:

getLeftBorder in interface TaskLayoutDetails

Returns:

the size of the left border of the workspace

getTopBorder

public int getTopBorder()

Specified by:

getTopBorder in interface TaskLayoutDetails

Returns:

the size of the right border of the workspace

getTaskDimensions

public TDimension getTaskDimensions()

Specified by:

getTaskDimensions in interface TaskLayoutDetails

Returns:

the dimensions of a standard triana task

addLayoutComponent

public void addLayoutComponent(java.lang.String name,
                      java.awt.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 java.awt.LayoutManager

Parameters:

name - the string to be associated with the component

comp - the component to be added

removeLayoutComponent

public void removeLayoutComponent(java.awt.Component comp)

Removes the specified component from the layout.

Specified by:

removeLayoutComponent in interface java.awt.LayoutManager

Parameters:

comp - the component to be removed

minimumLayoutSize

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

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

Specified by:

minimumLayoutSize in interface java.awt.LayoutManager

Parameters:

parent - the component to be laid out

See Also:

preferredLayoutSize(java.awt.Container)

preferredLayoutSize

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

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

Specified by:

preferredLayoutSize in interface java.awt.LayoutManager

Parameters:

parent - the container to be laid out

See Also:

minimumLayoutSize(java.awt.Container)

layoutContainer

public void layoutContainer(java.awt.Container parent)

Lays out the specified container.

Specified by:

layoutContainer in interface java.awt.LayoutManager

Parameters:

parent - the container to be laid out