Class MQMapState

Object
   |
   +--MQObject
         |
         +--MQMapState

class MQMapState

extends MQObject

Defines the characteristics of a map. It includes such information as the map name, the coverage name, the latitude/longitude of the map Center, the map scale, and the image size.
See:

- MQLatLng
- MQPoint

Field Detail

m_MQLatLng

<private> MQLatLng m_MQLatLng

Value to represent the Center point of the map

MQMapState

MQMapState()

Constructs a new MQMapState object.

See:
- MQLatLng
- MQPoint

equals

Boolean equals(<MQMapState> comparator)

Compares this object to the specified object. The result is true if and only if the argument is not null and is a MapState object that has same attributes as this object.

Parameters:
comparator - the object to compare this MapState against.

Returns:
true if the MapState objects are equal; false otherwise.

getCenter

MQLatLng getCenter()

Returns the Center point of the map associated with this MapState object.

Returns:
The Center point of this MapState object.

getClassName

String getClassName()

Returns the text name of this class.

Returns:
The text name of this class.

getCoverageName

void getCoverageName()

Returns the coverage name of the map associated with this MapState object.

Returns:
The coverage name of this MapState object.

getHeightInches

= int getHeightInches()

Returns the height of the generated map in inches.

Returns:
the height of the generated map in inches.

getHeightPixels

void getHeightPixels(<int> dpi)

Returns the height of the generated map in pixels.

Parameters:
dpi - int value specifying the DPI used to convert image size from inches to pixels.

getMapName

void getMapName()

Returns the map name of the map associated with this MapState object.

Returns:
The map name of the map associated with this MapState object.

getMapScale

Object getMapScale()

Returns the scale of the map associated with this MapState object.

Returns:
The scale of this MapState object.

getObjectVersion

int getObjectVersion()

Returns the version of this class.

Returns:
The version of this class.

getWidthInches

= int getWidthInches()

Returns the width of the generated map in inches.

Returns:
the width of the generated map in inches.

getWidthPixels

void getWidthPixels(<int> dpi)

Returns the width of the generated map in pixels.

Parameters:
dpi - int value specifying the DPI used to convert image size from inches to pixels.

Returns:
the width of the generated map in pixels.

initObject

void initObject()

Initializes object.

loadXml

void loadXml(<String> strXml)

Assigns the xml that relates to this object.

Parameters:
strXml - the xml to be assigned.

saveXml

String saveXml()

Build an xml string that represents this object. Because this is a complex object we need to completely rebuild the xml string.

Returns:
The xml string.

setCenter

void setCenter(<MQLatLng> latLng)

Sets the Center point of the map associated with this MapState object.

Parameters:
latLng - The Center point for the map associated with this MapState object.

setCoverageName

void setCoverageName(<String> strCovId)

Sets the coverage name for the map associated with this MapState object.

Parameters:
strCovId - The coverage name of the map associated with this MapState object.

setHeightInches

void setHeightInches(<Double> dHeight)

Sets the height of the generated map in inches.

Parameters:
dHeight - double value specifying the height of the map in inches.

setHeightPixels

void setHeightPixels(<int> iHeight, <int> dpi)

Sets the height of the generated map in pixels.

Parameters:
iHeight - int value specifying the height of the map in pixels.
dpi - int value specifying the DPI of the image, used to convert from inches to pixels.

setMapName

void setMapName(<String> strName)

Sets the map name of the map associated with this MapState object.

Parameters:
strName - The map name for the map associated with this MapState object.

setMapScale

void setMapScale(<int> nNewScale)

Sets the scale of the map associated with this MapState object.

Parameters:
nNewScale - The new scale value for the map associated with this MapState object.

setWidthInches

void setWidthInches(<Double> dWidth)

Sets the width of the generated map in inches.

Parameters:
dWidth - double value specifying the width of the map in inches.

setWidthPixels

void setWidthPixels(<int> iWidth, <int> dpi)

Sets the width of the generated map in pixels.

Parameters:
iWidth - int value specifying the width of the map in pixels.
dpi - int value specifying the DPI of the image, used to convert from inches to pixels.