com.esri.sde.sdk.client
Class SeShapeAnno

java.lang.Object
  com.esri.sde.sdk.client.SeShapeAnno

public class SeShapeAnno
extends java.lang.Object

Client side annotation utility functions

Field Summary

static int	SE_ANNO_ALIGN_AUTOMATIC
static int	SE_ANNO_ALIGN_CENTER
static int	SE_ANNO_ALIGN_DEFAULT
static int	SE_ANNO_ALIGN_LEFT
static int	SE_ANNO_ALIGN_RIGHT
static int	SE_ANNO_CENTER_CENTER
static int	SE_ANNO_CENTER_LEFT
static int	SE_ANNO_CENTER_RIGHT
static int	SE_ANNO_LOWER_CENTER
static int	SE_ANNO_LOWER_LEFT
static int	SE_ANNO_LOWER_RIGHT
static int	SE_ANNO_UPPER_CENTER
static int	SE_ANNO_UPPER_LEFT
static int	SE_ANNO_UPPER_RIGHT

Constructor Summary

SeShapeAnno()
Creates annotation object with default values.

Method Summary

java.lang.Object	duplicate() Creates a copy of annotation object.
int	getAlignment() Returns the alignment of a specific annotation.
double	getGapRatio() Returns the annotation gap ratio.
double	getHeight() Returns the annotation height.
int	getJustification() Returns the annotation justification.
SeShape	getLeader() Returns the annotation leader shape.
int	getLevel() Returns the annotation level.
SeShape	getPlacement() Returns the annotation placement shape.
int	getSymbol() Returns the annotation symbol.
java.lang.String	getText() Returns the annotation text.
double	getXOffset() Returns the annotation x offset.
double	getYOffset() Returns the annotation y offset.
void	setAlignment(int alignment) Sets the alignment type forannotation.
void	setGapRatio(double gapRatio) Sets the annotation gap ratio.
void	setHeight(double height) Sets the annotation height.
void	setJustification(int justification) Sets the annotation justification.
void	setLeader(SeShape leader) Sets the annotation leader shape.
void	setLevel(int level) Sets the annotation level.
void	setPlacement(SeShape pShape) Sets the annotation placement shape.
void	setSymbol(int symbol) Sets the annotation symbol.
void	setText(java.lang.String text) Sets the annotation text.
void	setXOffset(double offset) Sets the annotation x offset.
void	setYOffset(double offset) Sets the annotation y offset.

Methods inherited from class java.lang.Object

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

Field Detail

SE_ANNO_UPPER_LEFT

public static final int SE_ANNO_UPPER_LEFT

See Also:

Constant Field Values

SE_ANNO_UPPER_CENTER

public static final int SE_ANNO_UPPER_CENTER

See Also:

Constant Field Values

SE_ANNO_UPPER_RIGHT

public static final int SE_ANNO_UPPER_RIGHT

See Also:

Constant Field Values

SE_ANNO_CENTER_LEFT

public static final int SE_ANNO_CENTER_LEFT

See Also:

Constant Field Values

SE_ANNO_CENTER_CENTER

public static final int SE_ANNO_CENTER_CENTER

See Also:

Constant Field Values

SE_ANNO_CENTER_RIGHT

public static final int SE_ANNO_CENTER_RIGHT

See Also:

Constant Field Values

SE_ANNO_LOWER_LEFT

public static final int SE_ANNO_LOWER_LEFT

See Also:

Constant Field Values

SE_ANNO_LOWER_CENTER

public static final int SE_ANNO_LOWER_CENTER

See Also:

Constant Field Values

SE_ANNO_LOWER_RIGHT

public static final int SE_ANNO_LOWER_RIGHT

See Also:

Constant Field Values

SE_ANNO_ALIGN_DEFAULT

public static final int SE_ANNO_ALIGN_DEFAULT

See Also:

Constant Field Values

SE_ANNO_ALIGN_LEFT

public static final int SE_ANNO_ALIGN_LEFT

See Also:

Constant Field Values

SE_ANNO_ALIGN_RIGHT

public static final int SE_ANNO_ALIGN_RIGHT

See Also:

Constant Field Values

SE_ANNO_ALIGN_CENTER

public static final int SE_ANNO_ALIGN_CENTER

See Also:

Constant Field Values

SE_ANNO_ALIGN_AUTOMATIC

public static final int SE_ANNO_ALIGN_AUTOMATIC

See Also:

Constant Field Values

Constructor Detail

SeShapeAnno

public SeShapeAnno()

Creates annotation object with default values.

Method Detail

duplicate

public java.lang.Object duplicate()
                           throws SeException

Creates a copy of annotation object.

Returns:

SeShapeAnno

Throws:

SeException

getAlignment

public int getAlignment()

Returns the alignment of a specific annotation. The alignment values are: SE_ANNO_ALIGN_DEFAULT SE_ANNO_ALIGN_LEFT SE_ANNO_ALIGN_RIGHT SE_ANNO_ALIGN_CENTER SE_ANNO_ALIGN_AUTOMATIC

Returns:

int

setAlignment

public void setAlignment(int alignment)
                  throws SeException

Sets the alignment type forannotation. The alignment values are: SE_ANNO_ALIGN_DEFAULT SE_ANNO_ALIGN_LEFT SE_ANNO_ALIGN_RIGHT SE_ANNO_ALIGN_CENTER SE_ANNO_ALIGN_AUTOMATIC

Parameters:

alignment - the annotation alignment value.

Throws:

SeException

getJustification

public int getJustification()

Returns the annotation justification. The alignment values are: SE_ANNO_UPPER_LEFT SE_ANNO_UPPER_CENTER SE_ANNO_UPPER_RIGHT SE_ANNO_CENTER_LEFT SE_ANNO_CENTER_CENTER SE_ANNO_CENTER_RIGTH SE_ANNO_LOWER_LEFT SE_ANNO_LOWER_CENTER SE_ANNO_LOWER_RIGHT

Returns:

int

setJustification

public void setJustification(int justification)

Sets the annotation justification. The alignment values are: SE_ANNO_UPPER_LEFT SE_ANNO_UPPER_CENTER SE_ANNO_UPPER_RIGHT SE_ANNO_CENTER_LEFT SE_ANNO_CENTER_CENTER SE_ANNO_CENTER_RIGTH SE_ANNO_LOWER_LEFT SE_ANNO_LOWER_CENTER SE_ANNO_LOWER_RIGHT

Parameters:

justification - the annotation justification

getLeader

public SeShape getLeader()
                  throws SeException

Returns the annotation leader shape.

Returns:

SeShape

Throws:

SeException

setLeader

public void setLeader(SeShape leader)

Sets the annotation leader shape.

Parameters:

leader - the leader shape.

getPlacement

public SeShape getPlacement()
                     throws SeException

Returns the annotation placement shape.

Returns:

SeShape

Throws:

SeException

setPlacement

public void setPlacement(SeShape pShape)

Sets the annotation placement shape.

Parameters:

pShape - the placement shape.

getLevel

public int getLevel()

Returns the annotation level.

Returns:

int

setLevel

public void setLevel(int level)

Sets the annotation level.

Parameters:

level - the annotation level

getXOffset

public double getXOffset()

Returns the annotation x offset.

Returns:

double

setXOffset

public void setXOffset(double offset)

Sets the annotation x offset.

Parameters:

offset - the annotation x offset.

getYOffset

public double getYOffset()

Returns the annotation y offset.

Returns:

double

setYOffset

public void setYOffset(double offset)

Sets the annotation y offset.

Parameters:

offset - the annotation y offset.

getText

public java.lang.String getText()

Returns the annotation text.

Returns:

double

setText

public void setText(java.lang.String text)

Sets the annotation text.

Parameters:

text - the annotation text.

getGapRatio

public double getGapRatio()

Returns the annotation gap ratio.

Returns:

double

setGapRatio

public void setGapRatio(double gapRatio)

Sets the annotation gap ratio.

Parameters:

gapRatio - the annotation gap ration

getHeight

public double getHeight()

Returns the annotation height.

Returns:

double

setHeight

public void setHeight(double height)

Sets the annotation height.

Parameters:

height - the annotation height.

getSymbol

public int getSymbol()

Returns the annotation symbol.

Returns:

int

setSymbol

public void setSymbol(int symbol)

Sets the annotation symbol.

Parameters:

symbol - the annotation symbol.