com.partnersoft.v3x.apps.MapBrowser.rover
Class RoverLegend

java.lang.Object
  com.partnersoft.v3x.apps.MapBrowser.rover.RoverLegend

All Implemented Interfaces:

java.io.Serializable

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

Describes the visual legend for drawing a rover tile set onscreen.

See Also:

Serialized Form

Field Summary

java.awt.Color	backgroundColor
FontSpecification[]	fontSpecs
java.util.ArrayList	goedelNames
java.awt.Color	hiliteColor
java.awt.Color	hiliteTransColor
java.awt.Color	indicatorColor
java.awt.Color	indicatorTransColor
RoverRenderLegendItem[]	legendItemArray
java.awt.Color[]	lineColors
java.awt.Stroke[]	lineStrokes
RoverIconRotations[]	pointIcons
boolean	showTileBorders
boolean	showTileNames

Constructor Summary

RoverLegend()

Method Summary

java.lang.String	getBackgroundColorName()
FontSpecification	getDefaultTextStyle() Default FontSpecification to use if none defined for a text style.
java.lang.String	getImageLibraryName()
java.util.ArrayList	getLegendItems()
java.util.Map	getLineColorNames()
java.util.Map	getPointIconNames()
boolean	getShowTileBorders()
boolean	getShowTileNames()
java.util.Map	getTextStyles() FontSpecifications for each text style, indexed by style name.
void	initializeForRendering(java.io.File baseDir, java.util.ArrayList goedelNames)
RoverLegendItem	legendItemFor(float scale)
void	reinitializeForRendering()
RoverRenderLegendItem	renderLegendItemFor(float scale)
RoverRenderLegendItem	renderLegendItemFor(Scale scale)
void	setBackgroundColorName(java.lang.String newName)
void	setDefaultTextStyle(FontSpecification newStyle)
void	setHiliteColorName(java.lang.String newName)
void	setImageLibraryName(java.lang.String newName)
void	setLegendItems(java.util.ArrayList newItems)
void	setLineColorNames(java.util.Map newNames)
void	setPointIconNames(java.util.Map newNames)
void	setShowTileBorders(boolean tizit)
void	setShowTileNames(boolean tizit)
void	setTextStyles(java.util.Map newStyles)
static java.lang.String	trimJustification(java.lang.String textStyleName) Trims the -left, -right, -center from text style names.
java.util.Set	visibleStyles() Returns all styles visible in at least one LOD.
java.util.ArrayList	visibleStylesByLOD() Returns all styles visible by LOD.
java.util.Set	visibleStylesForLOD(int lod) Returns all styles visible in the given LOD.

Methods inherited from class java.lang.Object

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

Field Detail

backgroundColor

public java.awt.Color backgroundColor

showTileNames

public boolean showTileNames

showTileBorders

public boolean showTileBorders

legendItemArray

public RoverRenderLegendItem[] legendItemArray

pointIcons

public RoverIconRotations[] pointIcons

lineColors

public java.awt.Color[] lineColors

lineStrokes

public java.awt.Stroke[] lineStrokes

fontSpecs

public FontSpecification[] fontSpecs

goedelNames

public java.util.ArrayList goedelNames

hiliteColor

public java.awt.Color hiliteColor

indicatorColor

public java.awt.Color indicatorColor

hiliteTransColor

public java.awt.Color hiliteTransColor

indicatorTransColor

public java.awt.Color indicatorTransColor

Constructor Detail

RoverLegend

public RoverLegend()

Method Detail

trimJustification

public static java.lang.String trimJustification(java.lang.String textStyleName)

Trims the -left, -right, -center from text style names.

reinitializeForRendering

public void reinitializeForRendering()

initializeForRendering

public void initializeForRendering(java.io.File baseDir,
                                   java.util.ArrayList goedelNames)

renderLegendItemFor

public RoverRenderLegendItem renderLegendItemFor(Scale scale)

renderLegendItemFor

public RoverRenderLegendItem renderLegendItemFor(float scale)

legendItemFor

public RoverLegendItem legendItemFor(float scale)

visibleStylesForLOD

public java.util.Set visibleStylesForLOD(int lod)

Returns all styles visible in the given LOD.

visibleStylesByLOD

public java.util.ArrayList visibleStylesByLOD()

Returns all styles visible by LOD.

visibleStyles

public java.util.Set visibleStyles()

Returns all styles visible in at least one LOD.

setLegendItems

public void setLegendItems(java.util.ArrayList newItems)

getLegendItems

public java.util.ArrayList getLegendItems()

getBackgroundColorName

public java.lang.String getBackgroundColorName()

setBackgroundColorName

public void setBackgroundColorName(java.lang.String newName)

getShowTileBorders

public boolean getShowTileBorders()

setShowTileBorders

public void setShowTileBorders(boolean tizit)

getShowTileNames

public boolean getShowTileNames()

setShowTileNames

public void setShowTileNames(boolean tizit)

setPointIconNames

public void setPointIconNames(java.util.Map newNames)

setLineColorNames

public void setLineColorNames(java.util.Map newNames)

getPointIconNames

public java.util.Map getPointIconNames()

getLineColorNames

public java.util.Map getLineColorNames()

getImageLibraryName

public java.lang.String getImageLibraryName()

setImageLibraryName

public void setImageLibraryName(java.lang.String newName)

getTextStyles

public java.util.Map getTextStyles()

FontSpecifications for each text style, indexed by style name.

setTextStyles

public void setTextStyles(java.util.Map newStyles)

getDefaultTextStyle

public FontSpecification getDefaultTextStyle()

Default FontSpecification to use if none defined for a text style. If you define this, you don't have to define all the text styles in the textStyles property.

setDefaultTextStyle

public void setDefaultTextStyle(FontSpecification newStyle)

setHiliteColorName

public void setHiliteColorName(java.lang.String newName)