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

java.lang.Object
  com.esri.aims.mtier.model.map.layer.renderer.symbol.Symbol
      com.esri.aims.mtier.model.map.layer.renderer.symbol.RasterMarkerSymbol

All Implemented Interfaces:

Serializable

public class RasterMarkerSymbol
extends Symbol

This object symbolizes point features using the specified raster image. The RasterMarkerSymbol object extends the Symbol object.

See Also:

Serialized Form

Constructor Summary

RasterMarkerSymbol()
Creates an instance of a RasterMarkerSymbol object.

Method Summary

long	getHotSpotX() Returns the RasterMarkerSymbol's hotspot x value.
long	getHotSpotY() Returns the RasterMarkerSymbol's hotspot y value.
String	getImage() Returns the RasterMarkerSymbol's image location.
String	getShadow() Returns the RasterMarkerSymbol's shadow color value.
long	getSizeX() Returns the RasterMarkerSymbol size x value.
long	getSizeY() Returns the RasterMarkerSymbol's size y value.
double	getTransparency() Returns the RasterMarkerSymbol's transparency value.
String	getType() Returns the type of symbol, "RasterMarker".
String	getURL() Returns the RasterMarkerSymbol's URL location.
boolean	isAntialiasing() Returns True, if RasterMarkerSymbol's antialiasing value is set.
boolean	isOverlap() Returns true if the RasterMarkerSymbol's overlap method is set.
boolean	isUseCentroid() Returns true if the RasterMarkerSymbol's usecentroid value is set.
void	setAntialiasing(boolean value) Sets the RasterMarkerSymbol's antialiasing value.
void	setHotSpotX(long value) Sets the RasterMarkerSymbol's hotspot x value.
void	setHotSpotY(long value) Sets the RasterMarkerSymbol's hotspot y value.
void	setImage(String value) Sets the RasterMarkerSymbol's image location.
void	setOverlap(boolean value) Sets the overlap value, which determines if labels can overlap this symbol.
void	setShadow(String value) Sets the RasterMarkerSymbol's shadow color value.
void	setSizeX(long value) Sets the RasterMarkerSymbol's size x value.
void	setSizeY(long value) Sets the RasterMarkerSymbols size y value.
void	setTransparency(double value) Sets the RasterMarkerSymbol's transparency value.
void	setURL(String value) Sets the RasterMarkerSymbol's URL location.
void	setUseCentroid(boolean value) Sets the RasterMarkerSymbols UseCentroid value.

Methods inherited from class java.lang.Object

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

Constructor Detail

RasterMarkerSymbol

public RasterMarkerSymbol()

Creates an instance of a RasterMarkerSymbol object. Example:

 RasterMarkerSymbol rasterMarker = new RasterMarkerSymbol();
 

Method Detail

getType

public String getType()

Returns the type of symbol, "RasterMarker".

Specified by:

getType in class Symbol

Returns:

String

setTransparency

public void setTransparency(double value)

Sets the RasterMarkerSymbol's transparency value. Example:

rasterMarker.setTransparency(1.0);

Parameters:

value - the transparency value.

See Also:

getTransparency()

getTransparency

public double getTransparency()

Returns the RasterMarkerSymbol's transparency value. Example:

double transparency = rasterMarker.getTransparency();

Returns:

double.

See Also:

setTransparency(double)

setUseCentroid

public void setUseCentroid(boolean value)

Sets the RasterMarkerSymbols UseCentroid value. If True, marker is placed in the polygon's center. Example:

rasterMarker.setUseCentroid(true);

Parameters:

value - the UseCentroid value.

See Also:

isUseCentroid()

isUseCentroid

public boolean isUseCentroid()

Returns true if the RasterMarkerSymbol's usecentroid value is set. Example:

 if(rasterMarker.isUseCentroid() == true){
  rasterMarker.setUseCentroid(false);
 }
 

Returns:

boolean

See Also:

setUseCentroid(boolean)

setAntialiasing

public void setAntialiasing(boolean value)

Sets the RasterMarkerSymbol's antialiasing value. Note that the time to generate a map may significantly increase when this property is set to True. Example:

 rasterMarker.setAntialiasing();
 

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()

isAntialiasing

public boolean isAntialiasing()

Returns True, if RasterMarkerSymbol's antialiasing value is set. Example:

 if(rasterMarker.isAntialiasing() == true){
  rasterMarker.setAntialiasing(false);
  }
  

Returns:

boolean

See Also:

setAntialiasing(boolean)

setSizeX

public void setSizeX(long value)

Sets the RasterMarkerSymbol's size x value. Example:

rasterMarker.setSizeX(15);

Parameters:

value - the the sizex value.

See Also:

getSizeX()

getSizeX

public long getSizeX()

Returns the RasterMarkerSymbol size x value. Example:

long sizeX = rasterMarker.getSizeX();

Returns:

long

See Also:

setSizeX(long)

setSizeY

public void setSizeY(long value)

Sets the RasterMarkerSymbols size y value. Example:

rasterMarker.setSizeY(15);

Parameters:

value - the sizey value.

See Also:

getSizeY()

getSizeY

public long getSizeY()

Returns the RasterMarkerSymbol's size y value. Example:

 long sizeY = rasterMarker.getSizeY();
 

Returns:

long.

See Also:

setSizeY(long)

setHotSpotY

public void setHotSpotY(long value)

Sets the RasterMarkerSymbol's hotspot y value. Example:

 rasterMarker.setHotSpotY(10);
 

Parameters:

value - the HotSpotY value.

See Also:

getHotSpotY()

getHotSpotY

public long getHotSpotY()

Returns the RasterMarkerSymbol's hotspot y value. Example: >

 long hotSpotY = rasterMarker.getHotSpotY();
 

Returns:

long

See Also:

setHotSpotY(long)

setHotSpotX

public void setHotSpotX(long value)

Sets the RasterMarkerSymbol's hotspot x value. Example:

 rasterMarker.setHotSpotX(10);
 

Parameters:

value - the hotspotx value.

See Also:

getHotSpotX()

getHotSpotX

public long getHotSpotX()

Returns the RasterMarkerSymbol's hotspot x value. Example:

 long hotSpotX = rasterMarker.getHotSpotX();
 

Returns:

long

See Also:

setHotSpotX(long)

setShadow

public void setShadow(String value)

Sets the RasterMarkerSymbol's shadow color value. Example:

rasterMarker.setShadow("100,100,100");

Parameters:

value - the shadow color value.

See Also:

getShadow()

getShadow

public String getShadow()

Returns the RasterMarkerSymbol's shadow color value. Example:

String shadow = rasterMarker.getShadow();

Returns:

String

See Also:

setShadow(java.lang.String)

setURL

public void setURL(String value)

Sets the RasterMarkerSymbol's URL location. Example:

rasterMarker.setURL("http://www.mapper.com/symbols/marker.jpg");

Parameters:

value - the url location.

See Also:

getURL()

getURL

public String getURL()

Returns the RasterMarkerSymbol's URL location. Example:

String url = rasterMarker.getURL();

Returns:

String

See Also:

setURL(java.lang.String)

setImage

public void setImage(String value)

Sets the RasterMarkerSymbol's image location. Example:

rasterMarker.setImage("C:/ArcIMS/symbols/marker.jpg");

Parameters:

value - the image value.

See Also:

getImage()

getImage

public String getImage()

Returns the RasterMarkerSymbol's image location. Example:

String image = rasterMarker.getImage();

Returns:

String

See Also:

setImage(java.lang.String)

setOverlap

public void setOverlap(boolean value)

Sets the overlap value, which determines if labels can overlap this symbol. When True, labels can overlap. If labels are not drawing as expected, check if overlap is set to False for this symbol or for any other symbol in this service. Example:

rasterMarker.setOverlap(false);

Parameters:

value - the overlap value.

See Also:

isOverlap()

isOverlap

public boolean isOverlap()

Returns true if the RasterMarkerSymbol's overlap method is set. Example:

 if(rasterMarker.isOverlap() == true){
 rasterMarker.setOverlap(false);
 }
 

Returns:

boolean

See Also:

setOverlap(boolean)