com.esri.aims.mtier.model.envelope
Class Envelope

java.lang.Object
  com.esri.aims.mtier.model.envelope.Envelope

All Implemented Interfaces:

AcetateElement, Shape, Serializable

public class Envelope
extends Object
implements Shape, Serializable

Defines an Envelope object that is used for setting extents of the map, setting spatial queries in a FeatureLayer's Filter object, and displaying individual extents of recordset results.

See Also:

Serialized Form

Field Summary

static String	EXTENTLIMIT
static String	INTIALEXTENT

Constructor Summary

Envelope()
Creates an instance of an Envelope object.

Method Summary

double	getMaxX() Returns the Envelope object's maximum x coordinate value.
double	getMaxY() Returns the Envelope object's maximum y coordinate value.
double	getMinX() Returns the Envelope object's minimum x coordinate value.
double	getMinY() Returns the Envelope object's minimum y coordinate value.
String	getName() Identifies the type of envelope extent in a viewer or map configuration file.
String	getType() Returns a name string that defines the type of this Shape.
boolean	isReaspect() Flag indicating whether the ENVELOPE should be stretched to fit the viewing area in the client.
void	setMaxX(double maxX) Sets the Envelope object's x coordinate value.
void	setMaxY(double maxY) Sets the Envelope object's maximum y coordinate value.
void	setMinX(double minX) Sets the Envelope object's minimum x coordinate value.
void	setMinY(double minY) Sets the Envelope object's minimum y coordinate value.
void	setName(String value) Sets the type of envelope extent.
void	setReaspect(boolean value) Sets the reaspect value.

Methods inherited from class java.lang.Object

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

Field Detail

INTIALEXTENT

public static final String INTIALEXTENT

See Also:

Constant Field Values

EXTENTLIMIT

public static final String EXTENTLIMIT

See Also:

Constant Field Values

Constructor Detail

Envelope

public Envelope()

Creates an instance of an Envelope object. Example:

Envelope env = new Envelope();

Method Detail

setMinX

public void setMinX(double minX)

Sets the Envelope object's minimum x coordinate value. Example:

env.setMinX(-124.00);

Parameters:

minX - is the x minimum value.

See Also:

getMinX()

setMinY

public void setMinY(double minY)

Sets the Envelope object's minimum y coordinate value. Example:

env.setMinY(25.0);

Parameters:

minY - is the y minimum value.

See Also:

getMinY()

setMaxX

public void setMaxX(double maxX)

Sets the Envelope object's x coordinate value. Example:

env.setMaxX(100.00);

Parameters:

maxX - is the X maximum value.

See Also:

getMaxX()

setMaxY

public void setMaxY(double maxY)

Sets the Envelope object's maximum y coordinate value. Example:

env.setMaxY(45.0);

Parameters:

maxY - is the Y maximum value.

See Also:

getMaxY()

getMinX

public double getMinX()

Returns the Envelope object's minimum x coordinate value. Example:

double minx = env.getMinX();

Returns:

double

See Also:

setMinX(double)

getMinY

public double getMinY()

Returns the Envelope object's minimum y coordinate value. Example:

double miny = env.getMinY();

Returns:

double

See Also:

setMinY(double)

getMaxX

public double getMaxX()

Returns the Envelope object's maximum x coordinate value. Example:

double maxx = env.getMaxX();

Returns:

double

See Also:

setMaxX(double)

getMaxY

public double getMaxY()

Returns the Envelope object's maximum y coordinate value. Example:

double maxy = env.getMaxY();

Returns:

double

See Also:

setMaxY(double)

getType

public String getType()

Returns a name string that defines the type of this Shape.

Specified by:

getType in interface Shape

getName

public String getName()

Identifies the type of envelope extent in a viewer or map configuration file.

Returns:

String

setName

public void setName(String value)

Sets the type of envelope extent.

Parameters:

value - String

isReaspect

public boolean isReaspect()

Flag indicating whether the ENVELOPE should be stretched to fit the viewing area in the client. Default is true. By default, the pixel width and height ratio stays the same. By setting reaspect to false, the pixel width and height are stretched. Valid only with Image Services.

Returns:

boolean

setReaspect

public void setReaspect(boolean value)

Sets the reaspect value.

Parameters:

value - boolean