com.mizar.trinidad.components.basemap
Class DecorateBasemapImage

java.lang.Object
  extended by com.mizar.trinidad.components.basemap.DecorateBasemapImage

public abstract class DecorateBasemapImage
extends java.lang.Object


Nested Class Summary
 class DecorateBasemapImage.MarginElement
           
 
Field Summary
static java.lang.String FOOT_NOTE
           
static java.lang.String PLACENAME
           
static java.lang.String SHOW_CORNER_TEXT
           
static java.lang.String SHOW_GRIDLINES
           
static java.lang.String SHOW_NORTH_ARROW
           
static java.lang.String SHOW_SCALAR
           
static java.lang.String WARNING
           
 
Constructor Summary
DecorateBasemapImage()
           
 
Method Summary
 java.lang.String getAlertText()
           
 java.lang.String getFootNoteText()
           
abstract  java.util.Map<java.lang.String,DecorateBasemapImage.MarginElement> getOptionArgs()
           
 java.lang.String getPlaceName()
           
 java.lang.Boolean getShowFootnote()
           
 java.lang.Boolean getShowGridLines()
           
 java.lang.Boolean getShowNorthArrow()
           
 java.lang.Boolean getShowNotice()
           
 java.lang.Boolean getShowScalar()
           
static CustomizedMapImage getTemplate()
           
static boolean run(CustomizedMapImage temp, java.io.File imageFile)
           
static boolean run(CustomizedMapImage temp, java.awt.Image image)
           
static boolean run(CustomizedMapImage temp, java.lang.String imageFilename)
           
 void setAlertText(java.lang.String warningText)
           
 void setFootNoteText(java.lang.String footNoteText)
           
 void setPlaceName(java.lang.String placeName)
           
 void setShowFootnote(java.lang.Boolean showFootnote)
           
 void setShowGridLines(java.lang.Boolean showGridLines)
           
 void setShowNorthArrow(java.lang.Boolean showNorthArrow)
           
 void setShowNotice(java.lang.Boolean showNotice)
           
 void setShowScalar(java.lang.Boolean showScalar)
           
static void setTemplate(CustomizedMapImage template)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PLACENAME

public static java.lang.String PLACENAME

WARNING

public static java.lang.String WARNING

FOOT_NOTE

public static java.lang.String FOOT_NOTE

SHOW_CORNER_TEXT

public static java.lang.String SHOW_CORNER_TEXT

SHOW_GRIDLINES

public static java.lang.String SHOW_GRIDLINES

SHOW_NORTH_ARROW

public static java.lang.String SHOW_NORTH_ARROW

SHOW_SCALAR

public static java.lang.String SHOW_SCALAR
Constructor Detail

DecorateBasemapImage

public DecorateBasemapImage()
Method Detail

run

public static boolean run(CustomizedMapImage temp,
                          java.awt.Image image)
Parameters:
temp - - the decoration template, a subclass of CustomizedMapImage
image - - the image object (Image of the subclass BufferedImage) to add dacoration to, type Image
Returns:
boolean true if successful

run

public static boolean run(CustomizedMapImage temp,
                          java.lang.String imageFilename)
                   throws java.lang.Exception
Parameters:
temp - - the decoration template, a subclass of CustomizedMapImage
imageFilename - - the name of the image file to add dacoration to, type String
Returns:
boolean true if successful
Throws:
java.lang.Exception

run

public static boolean run(CustomizedMapImage temp,
                          java.io.File imageFile)
                   throws java.lang.Exception
Parameters:
temp - - the decoration template, a subclass of CustomizedMapImage
imageFile - - the image file to add dacoration to, type File
Returns:
boolean true if successful
Throws:
java.lang.Exception

setTemplate

public static void setTemplate(CustomizedMapImage template)

getTemplate

public static CustomizedMapImage getTemplate()

getOptionArgs

public abstract java.util.Map<java.lang.String,DecorateBasemapImage.MarginElement> getOptionArgs()

setPlaceName

public void setPlaceName(java.lang.String placeName)

getPlaceName

public java.lang.String getPlaceName()

setAlertText

public void setAlertText(java.lang.String warningText)

getAlertText

public java.lang.String getAlertText()

setFootNoteText

public void setFootNoteText(java.lang.String footNoteText)

getFootNoteText

public java.lang.String getFootNoteText()

setShowNotice

public void setShowNotice(java.lang.Boolean showNotice)

getShowNotice

public java.lang.Boolean getShowNotice()

setShowGridLines

public void setShowGridLines(java.lang.Boolean showGridLines)

getShowGridLines

public java.lang.Boolean getShowGridLines()

setShowNorthArrow

public void setShowNorthArrow(java.lang.Boolean showNorthArrow)

getShowNorthArrow

public java.lang.Boolean getShowNorthArrow()

setShowScalar

public void setShowScalar(java.lang.Boolean showScalar)

getShowScalar

public java.lang.Boolean getShowScalar()

setShowFootnote

public void setShowFootnote(java.lang.Boolean showFootnote)

getShowFootnote

public java.lang.Boolean getShowFootnote()