com.partnersoft.v3x.apps.MapBrowser
Class MapBrowserConfig

java.lang.Object
  com.partnersoft.v3x.apps.MapBrowser.MapBrowserConfig

All Implemented Interfaces:

java.io.Serializable

public class MapBrowserConfig
extends java.lang.Object
implements java.io.Serializable

Configuration for the map browser.

See Also:

Serialized Form

Constructor Summary

MapBrowserConfig()

Method Summary

java.lang.String	getBackgroundColor() Name of color to use as background.
java.util.ArrayList	getBirdseyeScales() Specifies the zoom level to be presented in the birdseye map for each zoom level of the regular map.
java.util.ArrayList	getContents()
int	getDetailZoom() Specifies the zoom level presented by the software if a find item is selected or if a job is opened.
java.lang.String	getFindItemColorName()
java.lang.String	getForegroundColor() Not currently used.
Coord3D	getInitialCoord() The coordinate used for centering the key map.
double	getInitialScale() Specifies the scale in mapping units per pixel of the key map.
java.util.ArrayList	getLegends() Specifies legends for each source.
CustomerMapNomenclature	getNomenclature() Customer nomenclature used for "hover" feature.
int	getNumberOfZooms() Specifies the number of zoom levels.
java.lang.String	getPrintingBackgroundColor() Name of color to use as background when printing.
java.util.Map	getRoverLegends()
java.util.ArrayList	getScales() Specifies the mapping units per pixel for each zoom level.
java.util.ArrayList	getSources() Specifies the directories containing the configuration tofs for each map set.
boolean	getToggleZoomingAtDetail()
java.lang.String	getViewDataColorName()
int	getZoomFactor() Specifies the factor for zoom between zoom levels.
boolean	requiresColorInversion()
void	setBackgroundColor(java.lang.String newColor)
void	setBirdseyeScales(java.util.ArrayList newScales)
void	setContents(java.util.ArrayList newContents) Not currently used.
void	setDetailZoom(int newDetailZoom)
void	setFindItemColorName(java.lang.String newName)
void	setForegroundColor(java.lang.String newColor)
void	setInitialCoord(Coord3D newInitialCoord)
void	setInitialScale(double newInitialScale)
void	setLegends(java.util.ArrayList newLegends)
void	setNomenclature(CustomerMapNomenclature clat)
void	setNumberOfZooms(int newNum)
void	setRoverLegends(java.util.Map newLegends)
void	setScales(java.util.ArrayList newScales)
void	setSources(java.util.ArrayList newSources)
void	setToggleZoomingAtDetail(boolean tizit)
void	setViewDataColorName(java.lang.String newName)
void	setZoomFactor(int newNum)

Methods inherited from class java.lang.Object

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

Constructor Detail

MapBrowserConfig

public MapBrowserConfig()

Method Detail

requiresColorInversion

public boolean requiresColorInversion()

getScales

public java.util.ArrayList getScales()

Specifies the mapping units per pixel for each zoom level. The program sets the number of zooms to be equal to the number of entries in the scales list. Scales are given as a float indicating the width and height of a pixel (assumed square). If this is defined, then initialScale, numberOfZooms, and zoomFactor are ignored.

setScales

public void setScales(java.util.ArrayList newScales)

getSources

public java.util.ArrayList getSources()

Specifies the directories containing the configuration tofs for each map set. Multiple directories can be specified if there are multiple map sets. Each directory must contain a file named MapDataSource.tof. This is an ordered list; the order specifies the rendering order of the sources - the first is drawn first, followed by the second, etc. Later sources overlay earlier ones.

setSources

public void setSources(java.util.ArrayList newSources)

getLegends

public java.util.ArrayList getLegends()

Specifies legends for each source. These are String paths to TOF files, which should generally be relative, and are searched for in the following order: relative to the map source directory, relative to the file containing this object (generally MapControl.tof), and relative to the Partner install directory. This list is optional to provide backwards compatibility, but if present should be the same length as the sources list. Entries corresponding to raster sources should be set to null - this currently only works for tiled rover sets.

setLegends

public void setLegends(java.util.ArrayList newLegends)

getContents

public java.util.ArrayList getContents()

setContents

public void setContents(java.util.ArrayList newContents)

Not currently used.

getBirdseyeScales

public java.util.ArrayList getBirdseyeScales()

Specifies the zoom level to be presented in the birdseye map for each zoom level of the regular map. A -1 entry specifies to not present a birdseye map. There should be at least as many entries in the birdseyeScales list as there are zoom levels.

setBirdseyeScales

public void setBirdseyeScales(java.util.ArrayList newScales)

getInitialCoord

public Coord3D getInitialCoord()

The coordinate used for centering the key map. The map will be centered on this point when the program is started or when the user zooms out to the highest zoom.

setInitialCoord

public void setInitialCoord(Coord3D newInitialCoord)

getInitialScale

public double getInitialScale()

Specifies the scale in mapping units per pixel of the key map. Not used if the scales property is specified.

setInitialScale

public void setInitialScale(double newInitialScale)

getDetailZoom

public int getDetailZoom()

Specifies the zoom level presented by the software if a find item is selected or if a job is opened.

setDetailZoom

public void setDetailZoom(int newDetailZoom)

getNumberOfZooms

public int getNumberOfZooms()

Specifies the number of zoom levels. Not used if the scales property is specified.

setNumberOfZooms

public void setNumberOfZooms(int newNum)

getZoomFactor

public int getZoomFactor()

Specifies the factor for zoom between zoom levels. Not used if the scales property is specified.

setZoomFactor

public void setZoomFactor(int newNum)

setBackgroundColor

public void setBackgroundColor(java.lang.String newColor)

getBackgroundColor

public java.lang.String getBackgroundColor()

Name of color to use as background. Some sources provide their own background as well (e.g. opaque raster sets) but this is the background color used wherever there is no data or transparent areas for all sources. Default is "black".

getPrintingBackgroundColor

public java.lang.String getPrintingBackgroundColor()

Name of color to use as background when printing.

setForegroundColor

public void setForegroundColor(java.lang.String newColor)

getForegroundColor

public java.lang.String getForegroundColor()

Not currently used.

getNomenclature

public CustomerMapNomenclature getNomenclature()

Customer nomenclature used for "hover" feature.

setNomenclature

public void setNomenclature(CustomerMapNomenclature clat)

getToggleZoomingAtDetail

public boolean getToggleZoomingAtDetail()

setToggleZoomingAtDetail

public void setToggleZoomingAtDetail(boolean tizit)

getFindItemColorName

public java.lang.String getFindItemColorName()

setFindItemColorName

public void setFindItemColorName(java.lang.String newName)

getViewDataColorName

public java.lang.String getViewDataColorName()

setViewDataColorName

public void setViewDataColorName(java.lang.String newName)

getRoverLegends

public java.util.Map getRoverLegends()

setRoverLegends

public void setRoverLegends(java.util.Map newLegends)