com.esri.aims.mtier.model.acetate
Class NorthArrow

java.lang.Object
  com.esri.aims.mtier.model.acetate.Object
      com.esri.aims.mtier.model.acetate.NorthArrow

All Implemented Interfaces:

AcetateElement, MapSurroundings, Serializable

public class NorthArrow
extends Object
implements MapSurroundings, Serializable

Defines a NorthArrow object to be drawn as an acetate layer. The NorthArrow object extends the Object class in the Acetate package.

See Also:

Serialized Form

Field Summary

static String	STYLE1
static String	STYLE2
static String	STYLE3
static String	STYLE4
static String	STYLE5
static String	STYLE6
static String	STYLE7
static String	STYLE8

Constructor Summary

NorthArrow()
Constructs an instance of a NorthArrow object.

Method Summary

double	getAngle() Returns the angle associated with this NorthArrow object.
String	getArrowType() Returns the arrow type associated with this NorthArrow object.
String	getOutline() Returns the outline color associated with this NorthArrow object.
String	getShadow() Returns the shadow color associated with this NorthArrow object.
int	getSize() Returns the size associated with this NorthArrow object.
double	getTransparency() Returns the transparency value associated with this NorthArrow object.
String	getType() Returns the acetate object type as 'NorthArrow'.
double	getX() Returns the x-coordinate location of this NorthArrow object.
double	getY() Returns the y-coordinate location of this NorthArrow object.
boolean	isAntialiasing() Returns True if the antialiasing value is set to true.
boolean	isOverlap() Returns True, if the NorthArrow object's overlap value is set to "True".
void	setAngle(double value) Set's the angle of the north arrow in degrees.
void	setAntialiasing(boolean value) Sets the antialiasing value for this NorthArrow object.
void	setArrowType(String value) Sets the arrow type value for this NorthArrow object.
void	setOutline(String value) Sets the outline color for this NorthArrow object.
void	setOverlap(boolean value) Sets if labels can overlap this NorthArrow object.
void	setShadow(String value) Sets the shadow color for this NorthArrow object.
void	setSize(int value) Sets the given value as size for this NorthArrow object.
void	setTransparency(double value) Sets the percentage of transparency for this object.
void	setX(double value) Sets the x-coordinate location for this object.
void	setY(double value) Sets the y-coordinate location for this NorthArrow object.

Methods inherited from class java.lang.Object

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

Field Detail

STYLE1

public static final String STYLE1

See Also:

Constant Field Values

STYLE2

public static final String STYLE2

See Also:

Constant Field Values

STYLE3

public static final String STYLE3

See Also:

Constant Field Values

STYLE4

public static final String STYLE4

See Also:

Constant Field Values

STYLE5

public static final String STYLE5

See Also:

Constant Field Values

STYLE6

public static final String STYLE6

See Also:

Constant Field Values

STYLE7

public static final String STYLE7

See Also:

Constant Field Values

STYLE8

public static final String STYLE8

See Also:

Constant Field Values

Constructor Detail

NorthArrow

public NorthArrow()

Constructs an instance of a NorthArrow object.

Example:

NorthArrow nortArrow = new NorthArrow();

Method Detail

getType

public String getType()

Returns the acetate object type as 'NorthArrow'.

Example:

String type = northArrow.getType();

Specified by:

getType in interface MapSurroundings

Specified by:

getType in class Object

Returns:

String

setTransparency

public void setTransparency(double value)

Sets the percentage of transparency for this object.

Example:

northArrow.setTransparency(1.0);

Parameters:

value - the transparency value

See Also:

getTransparency()

getTransparency

public double getTransparency()

Returns the transparency value associated with this NorthArrow object.

Example:

double transparency = northArrow.getTransparency();

Returns:

the transparency value

See Also:

setTransparency(double)

setOverlap

public void setOverlap(boolean value)

Sets if labels can overlap this NorthArrow object. When true, labels can overlap. When false, labels will not overlap the object. If labels are not drawing as expected, check if overlap is set to false for this object or any other symbol in the service.

northArrow.setOverlap(true);

Parameters:

value - the overlap value.

See Also:

isOverlap()

isOverlap

public boolean isOverlap()

Returns True, if the NorthArrow object's overlap value is set to "True".

Example:

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

Returns:

boolean

See Also:

setOverlap(boolean)

setX

public void setX(double value)

Sets the x-coordinate location for this object.

Example:

northArrow.setX(-125.0);

Parameters:

value - the x-coordinate location

See Also:

getX()

getX

public double getX()

Returns the x-coordinate location of this NorthArrow object.

Example:

double x = northArrow.getX();

Returns:

double

See Also:

setX(double)

setY

public void setY(double value)

Sets the y-coordinate location for this NorthArrow object.

Example:

northArrow.setY(45.0);

Parameters:

value - the y-coordinate location

See Also:

getY()

getY

public double getY()

Returns the y-coordinate location of this NorthArrow object.

Example:

double y = northArrow.getY();

Returns:

double

See Also:

setY(double)

setShadow

public void setShadow(String value)

Sets the shadow color for this NorthArrow object.

Example:

northArrow.setShadow("125,0,0");

Parameters:

value - the shadow color value.

See Also:

getShadow()

getShadow

public String getShadow()

Returns the shadow color associated with this NorthArrow object.

Example:

String shadow = northArrow.getShadow();

Returns:

String

See Also:

setShadow(java.lang.String)

setArrowType

public void setArrowType(String value)

Sets the arrow type value for this NorthArrow object.

Example:

northArrow.setArrowType(northArrow.STYLE1);

Parameters:

value - the arrow type value.

See Also:

getArrowType()

getArrowType

public String getArrowType()

Returns the arrow type associated with this NorthArrow object.

Example:

String arrowtype = northArrow.getArrowType();

Returns:

String

See Also:

setArrowType(java.lang.String)

setSize

public void setSize(int value)

Sets the given value as size for this NorthArrow object.

Example:

northArrow.setSize(25);

Parameters:

value - the size value

See Also:

getSize()

getSize

public int getSize()

Returns the size associated with this NorthArrow object.

int size = northArrow.getSize();

Returns:

int

See Also:

setSize(int)

setAngle

public void setAngle(double value)

Set's the angle of the north arrow in degrees. Zero degree points to the north and values increase moving clockwise.

Example:

northArrow.setAngle(45.0);

Parameters:

value - the angle value.

See Also:

getAngle()

getAngle

public double getAngle()

Returns the angle associated with this NorthArrow object.

double angle = northArrow.getAngle();

Returns:

double

See Also:

setAngle(double)

setOutline

public void setOutline(String value)

Sets the outline color for this NorthArrow object.

Example:

northArrow.setOutline("0,0,0");

Parameters:

value - the color value.

See Also:

getOutline()

getOutline

public String getOutline()

Returns the outline color associated with this NorthArrow object.

Example:

String outline = northArrow.getOutline();

Returns:

String

See Also:

setOutline(java.lang.String)

setAntialiasing

public void setAntialiasing(boolean value)

Sets the antialiasing value for this NorthArrow object. This property is used to make the edges ofthe object smoother. This property is active when set to True. Note that the time to generate a map may significantly increase when this property is set to True.

Example:

northArrow.setAntialiasing(true);

Parameters:

value - the antialiasing value.

See Also:

isAntialiasing()

isAntialiasing

public boolean isAntialiasing()

Returns True if the antialiasing value is set to true.

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

Returns:

boolean

See Also:

setAntialiasing(boolean)