com.partnersoft.maps.model

Class MapSpaceLegend

java.lang.Object

com.partnersoft.maps.model.MapSpaceLegend

All Implemented Interfaces:

Coggable

public class MapSpaceLegend
extends java.lang.Object
implements Coggable

A global legend for a MapSpace. Each MapSpaceLegend establishes a defined name, background, and zooms for the MapSets in the MapSpace. Each MapSet must then provide individual Legends that correspond to the name of this MapSpaceLegend and that define how the data in the MapSet is to be drawn.

Copyright 2005-2009 Partner Software, Inc.

Author:

Paul Reavis

Field Summary

Fields

Modifier and Type	Field and Description
int	backgroundColor
java.lang.String	backgroundColorName
double	centerX
double	centerY
int	indicationColor
java.lang.String	indicationColorName
java.lang.String	name
int	selectionColor
java.lang.String	selectionColorName
double[]	zoomArray
java.util.List	zooms

Constructor Summary

Constructors

Constructor and Description
MapSpaceLegend()
MapSpaceLegend(Cog state)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBackgroundColor()
XyPoint	getCenter()
double	getCenterX()
double	getCenterY()
java.lang.String	getName()
java.util.List	getZooms()
boolean	hasDarkBackground()
void	setBackgroundColor(java.lang.String argBackgroundColorName)
void	setCenterX(double argCenterX)
void	setCenterY(double argCenterY)
void	setName(java.lang.String argName)
void	setZooms(java.util.List argZooms)
Cog	toCog() Returns the complete internal state of this object in the form of a Cog.

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

backgroundColorName

public java.lang.String backgroundColorName

indicationColorName

public java.lang.String indicationColorName

selectionColorName

public java.lang.String selectionColorName

zooms

public java.util.List zooms

centerX

public double centerX

centerY

public double centerY

backgroundColor

public transient int backgroundColor

indicationColor

public transient int indicationColor

selectionColor

public transient int selectionColor

zoomArray

public transient double[] zoomArray

Constructor Detail

MapSpaceLegend

public MapSpaceLegend()

MapSpaceLegend

public MapSpaceLegend(Cog state)

Method Detail

toCog

public Cog toCog()

Description copied from interface: Coggable

Returns the complete internal state of this object in the form of a Cog.

Specified by:

toCog in interface Coggable

Returns:

Cog representing the internal state of this object

getName

public java.lang.String getName()

setName

public void setName(java.lang.String argName)

getBackgroundColor

public java.lang.String getBackgroundColor()

setBackgroundColor

public void setBackgroundColor(java.lang.String argBackgroundColorName)

getZooms

public java.util.List getZooms()

setZooms

public void setZooms(java.util.List argZooms)

getCenter

public XyPoint getCenter()

getCenterX

public double getCenterX()

setCenterX

public void setCenterX(double argCenterX)

getCenterY

public double getCenterY()

setCenterY

public void setCenterY(double argCenterY)

hasDarkBackground

public boolean hasDarkBackground()