com.esri.aims.mtier.model.map.layer.renderer.symbol
Class RasterShieldSymbol

java.lang.Object
  extended by com.esri.aims.mtier.model.map.layer.renderer.symbol.Symbol
      extended by com.esri.aims.mtier.model.map.layer.renderer.symbol.RasterShieldSymbol
All Implemented Interfaces:
Serializable

public class RasterShieldSymbol
extends Symbol

This object is a user-specified image and is used as a custom shield to identify roads or other line features. The RasterShieldSymbol extends the Symbol object.

See Also:
Serialized Form

Field Summary
static String ALLLOWER
           
static String ALLUPPER
           
static String BOLD
           
static String BOLDITALIC
           
static String FULL
           
static String ITALIC
           
static String NONE
           
static String NUMERICONLY
           
static String OUTLINE
           
static String REGULAR
           
static String TITLECAPS
           
static String UNDERLINE
           
 
Constructor Summary
RasterShieldSymbol()
          Constructs an instance of a RasterShieldSymbol object.
 
Method Summary
 String getFont()
          Returns the RasterShieldSymbol's font value.
 String getFontColor()
          Returns the RasterShieldSymbol's font color value.
 long getFontSize()
          Returns the RasterShieldSymbol's fontsize value.
 String getFontStyle()
          Returns the RasterShieldSymbols font style value.
 String getImage()
          Returns the RasterShieldSymbol's image value.
 String getLabelMode()
          Returns the RasterShieldSymbol's label mode value.
 String getPrintMode()
          Returns the RasterShieldSymbol's print mode value.
 String getShadow()
          Returns the RasterShieldSymbol's shadow color value.
 String getTextPosition()
          Returns the RasterShieldSymbol's text position value.
 double getTransparency()
          Returns the RasterShieldSymbol's transparency value.
 String getType()
          Returns the type of symbol, "RasterShield".
 String getURL()
          Returns the RasterShieldSymbol's URL value.
 boolean isAntialiasing()
          Returns True if RasterShieldSymbol's antialiasing value is set.
 void setAntialiasing(boolean value)
          Sets the RasterShieldSymbol's antialiasing value.
 void setFont(String value)
          Sets the RasterShieldSymbol's font value.
 void setFontColor(String value)
          Sets the RasterShieldSymbol's font color value.
 void setFontSize(long value)
          Sets the RasterShieldSymbol's fontsize value.
 void setFontStyle(String value)
          Sets the RasterShieldSymbol's font style value.
 void setImage(String value)
          Sets the RasterShieldSymbol's image value.
 void setLabelMode(String value)
          Sets the RasterShieldSymbol's label mode value.
 void setPrintMode(String value)
          Sets the RasterShieldSymbol's print mode value.
 void setShadow(String value)
          Sets the RasterShieldSymbol's shadow color value.
 void setTextPosition(String value)
          Sets the RasterShieldSymbol' text position value.
 void setTransparency(double value)
          Sets the RasterShieldSymbol's transparency value.
 void setURL(String value)
          Sets the RasterShieldSymbol's URL value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

REGULAR

public static final String REGULAR
See Also:
Constant Field Values

BOLD

public static final String BOLD
See Also:
Constant Field Values

ITALIC

public static final String ITALIC
See Also:
Constant Field Values

UNDERLINE

public static final String UNDERLINE
See Also:
Constant Field Values

OUTLINE

public static final String OUTLINE
See Also:
Constant Field Values

BOLDITALIC

public static final String BOLDITALIC
See Also:
Constant Field Values

FULL

public static final String FULL
See Also:
Constant Field Values

NUMERICONLY

public static final String NUMERICONLY
See Also:
Constant Field Values

TITLECAPS

public static final String TITLECAPS
See Also:
Constant Field Values

ALLUPPER

public static final String ALLUPPER
See Also:
Constant Field Values

ALLLOWER

public static final String ALLLOWER
See Also:
Constant Field Values

NONE

public static final String NONE
See Also:
Constant Field Values
Constructor Detail

RasterShieldSymbol

public RasterShieldSymbol()
Constructs an instance of a RasterShieldSymbol object. Example:
RasterShieldSymbol rasterShield = new RasterShieldSymbol();

Method Detail

getType

public String getType()
Returns the type of symbol, "RasterShield".

Specified by:
getType in class Symbol
Returns:
String

setTransparency

public void setTransparency(double value)
Sets the RasterShieldSymbol's transparency value. Example:
rasterShield.setTransparency(1.0);

Parameters:
value - the transparency value.
See Also:
getTransparency()

setAntialiasing

public void setAntialiasing(boolean value)
Sets the RasterShieldSymbol's antialiasing value. Note that the time to generate a map may significantly increase when this property is set to True. Example:
rasterShield.setAntialiasing(true);

Parameters:
value - the antialiasing value that is used to make edges of labels and symbols smoother. When set to True, antialiasing is active.
See Also:
isAntialiasing()

setFont

public void setFont(String value)
Sets the RasterShieldSymbol's font value. Example:
rasterShield.setFont("arial");

Parameters:
value - the font value.
See Also:
getFont()

setFontSize

public void setFontSize(long value)
Sets the RasterShieldSymbol's fontsize value. Example:
rasterShield.setFontSize(15);

Parameters:
value - the font size value.
See Also:
getFontSize()

setFontColor

public void setFontColor(String value)
Sets the RasterShieldSymbol's font color value. Example:
rasterShield.setFontColor("255,0,0");

Parameters:
value - the font color value.
See Also:
getFontColor()

setShadow

public void setShadow(String value)
Sets the RasterShieldSymbol's shadow color value. Example:
rasterShield.setShadow("100,100,100");

Parameters:
value - the shadow color value.
See Also:
getShadow()

setPrintMode

public void setPrintMode(String value)
Sets the RasterShieldSymbol's print mode value. Example:
rasterShield.setPrintMode(rasterShield.ALLLOWER);

Parameters:
value - the print mode value.
See Also:
getPrintMode()

setLabelMode

public void setLabelMode(String value)
Sets the RasterShieldSymbol's label mode value. Example:
rasterShield.setLabelMode(rasterShield.FULL);

Parameters:
value - the label mode value.
See Also:
getLabelMode()

setTextPosition

public void setTextPosition(String value)
Sets the RasterShieldSymbol' text position value. Example:
rasterShield.setTextPosition("0,0");

Parameters:
value - the text position value.
See Also:
getTextPosition()

setImage

public void setImage(String value)
Sets the RasterShieldSymbol's image value. Example:
rasterShield.setImage("C:/ArcIMS/image/shield.jpg");

Parameters:
value - the image value.
See Also:
getImage()

setFontStyle

public void setFontStyle(String value)
Sets the RasterShieldSymbol's font style value. Example:
rasterShield.setFontStyle(rasterShield.BOLD);

Parameters:
value - the font style.
See Also:
getFontStyle()

setURL

public void setURL(String value)
Sets the RasterShieldSymbol's URL value. Example:
rasterShield.setURL("http://www.mapper.com/images/shield.jpg");

Parameters:
value - the url value.
See Also:
getURL()

getTransparency

public double getTransparency()
Returns the RasterShieldSymbol's transparency value. Example:
double transparency = rasterShield.getTransparency();

Returns:
double
See Also:
setTransparency(double)

isAntialiasing

public boolean isAntialiasing()
Returns True if RasterShieldSymbol's antialiasing value is set. Example:
 if(rasterShield.isAntialiasing() == true){
  rasterShield.setAntialiasing(false);
 }
 

Returns:
boolean
See Also:
setAntialiasing(boolean)

getFont

public String getFont()
Returns the RasterShieldSymbol's font value. Example:
String font = rasterShield.getFont();

Returns:
String
See Also:
setFont(java.lang.String)

getFontSize

public long getFontSize()
Returns the RasterShieldSymbol's fontsize value. Example:
long size = rasterShield.getFontSize();

Returns:
long
See Also:
setFontSize(long)

getFontColor

public String getFontColor()
Returns the RasterShieldSymbol's font color value. Example:
String color = rasterShield.getFontColor();

Returns:
String
See Also:
setFontColor(java.lang.String)

getShadow

public String getShadow()
Returns the RasterShieldSymbol's shadow color value. Example:
String shadow = rasterShield.getShadow();

Returns:
String
See Also:
setShadow(java.lang.String)

getPrintMode

public String getPrintMode()
Returns the RasterShieldSymbol's print mode value. Example:
String printMode = rasterShield.getPrintMode();

Returns:
String
See Also:
setPrintMode(java.lang.String)

getLabelMode

public String getLabelMode()
Returns the RasterShieldSymbol's label mode value. Example:
String labelMode = rasterShield.getLabelMode();

Returns:
String
See Also:
setLabelMode(java.lang.String)

getTextPosition

public String getTextPosition()
Returns the RasterShieldSymbol's text position value. Example:
String textPosition = rasterShield.getTextPosition();

Returns:
String
See Also:
setTextPosition(java.lang.String)

getImage

public String getImage()
Returns the RasterShieldSymbol's image value. Example:
String image = rasterShield.getImage();

Returns:
String
See Also:
setImage(java.lang.String)

getFontStyle

public String getFontStyle()
Returns the RasterShieldSymbols font style value. Example:
String style = rasterShield.getFontStyle();

Returns:
String
See Also:
setFontStyle(java.lang.String)

getURL

public String getURL()
Returns the RasterShieldSymbol's URL value. Example:
String url = rasterShield.getURL();

Returns:
String
See Also:
setURL(java.lang.String)