net.rim.device.api.lbs.maps
Class MapDimensions

java.lang.Object
  extended by net.rim.device.api.lbs.maps.MapDimensions
All Implemented Interfaces:
Boxable

public class MapDimensions
extends Object
implements Boxable

Represents spatial information for the visible dimensions of the map image. This includes the pixel dimensions of the map, the latitude and longitude of the center of the map, the zoom level, and the rotation factor.

Note: If this MapDimensions is associated with a MapField the preferred way to change the center or zoom is through the MapField's MapAction.

Since:
BlackBerry API 6.0.0

Constructor Summary
MapDimensions()
          Constructs a new MapDimensions instance.
MapDimensions(int pixelWidth, int pixelHeight)
          Constructs a new MapDimensions instance using the width and height of the field.
MapDimensions(MapDimensions clone)
          Constructs a MapDimensions instance copy.
MapDimensions(MapPoint center, int pixelWidth, int pixelHeight, int zoom, int rotation)
          Constructs a new MapDimensions instance using the width, height, zoom and rotation.
 
Method Summary
 boolean equals(Object obj)
          Indicates whether some other object is "equal to" this one.
 LatLonRectangle getBoundingBox()
          Retrieves the latitude and longitude-based bounding box of this mappable item.
 MapPoint getCenter()
          Retrieves the center point of this MapDimensions instance.
 MapPoint getCentre()
          Deprecated. Use MapDimensions.getCenter() instead
 int getPixelHeight()
          Gets the pixel height of the field.
 int getPixelWidth()
          Gets the pixel width of the field.
 int getRotation()
          Gets the rotation of the map.
 int getZoom()
          Gets the zoom level of the field.
 int hashCode()
          Returns a hash code value for the object.
 void setCenter(MapPoint center)
          Sets the coordinates of the center of the map.
 void setCentre(MapPoint center)
          Deprecated. Use MapDimensions.setCenter(MapPoint) instead
 void setPixelHeight(int pixelHeight)
          Sets the pixel height of the field.
 void setPixelWidth(int pixelWidth)
          Sets the pixel width of the field.
 void setRotation(int rotation)
          Sets the rotation of the map.
 void setZoom(int zoom)
          Sets the zoom level of the field.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 



Constructor Detail

MapDimensions

public MapDimensions()
Constructs a new MapDimensions instance.

Since:
BlackBerry API 6.0.0

MapDimensions

public MapDimensions(int pixelWidth,
                     int pixelHeight)
Constructs a new MapDimensions instance using the width and height of the field.

Parameters:
pixelWidth - The width of the field (in pixels).
pixelHeight - The height of the field (in pixels).
Since:
BlackBerry API 6.0.0

MapDimensions

public MapDimensions(MapPoint center,
                     int pixelWidth,
                     int pixelHeight,
                     int zoom,
                     int rotation)
Constructs a new MapDimensions instance using the width, height, zoom and rotation.

Parameters:
center - The latitude/longitude to use as the center of this MapDimensions instance.
pixelWidth - The width of the field (in pixels)
pixelHeight - The height of the field (in pixels)
zoom - Zoom level of the field (value between MapConstants.MIN_ZOOM and MapConstants.MAX_ZOOM.
rotation - Rotation of the field (in degrees between 0-359).
Throws:
NullPointerException - if center is null.
Since:
BlackBerry API 7.0.0

MapDimensions

public MapDimensions(MapDimensions clone)
Constructs a MapDimensions instance copy.

Parameters:
clone - The object to copy information from.
Since:
BlackBerry API 6.0.0


Method Detail

hashCode

public int hashCode()
Description copied from class: Object
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

Overrides:
hashCode in class Object
Returns:
a hash code value for this object.
See Also:
Object.hashCode()
Since:
BlackBerry API 6.0.0

equals

public boolean equals(Object obj)
Description copied from class: Object
Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation:

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).

Overrides:
equals in class Object
Parameters:
obj - the reference object with which to compare.
Returns:
true if this object is the same as the obj argument; false otherwise.
See Also:
Object.equals(Object)
Since:
BlackBerry API 6.0.0

getCentre

public MapPoint getCentre()
Deprecated. Use MapDimensions.getCenter() instead

Since:
BlackBerry API 6.0.0

getCenter

public MapPoint getCenter()
Retrieves the center point of this MapDimensions instance.

Note: Changes to the object returned by this method will modify this MapDimensions instance, and the coordinates of the center point will change if this instance is modified. Use MapPoint.clone() to create a copy of the MapPoint to ensure the values will not change.

Returns:
the center point
Since:
BlackBerry API 7.0.0

setCentre

public void setCentre(MapPoint center)
Deprecated. Use MapDimensions.setCenter(MapPoint) instead

Since:
BlackBerry API 6.0.0

setCenter

public void setCenter(MapPoint center)
Sets the coordinates of the center of the map.

Parameters:
center - The coordinates for the center of the map.
Throws:
NullPointerException - if center is null.
Since:
BlackBerry API 7.0.0

getRotation

public int getRotation()
Gets the rotation of the map. The rotation value is in degrees, clockwise, from North.

Returns:
The rotation value of the map.
Since:
BlackBerry API 6.0.0

setRotation

public void setRotation(int rotation)
Sets the rotation of the map. The rotation value is in degrees, clockwise, from North.

Parameters:
rotation - The rotation value of the map.
Since:
BlackBerry API 6.0.0

getPixelWidth

public int getPixelWidth()
Gets the pixel width of the field.

Returns:
The pixel width of the field.
Since:
BlackBerry API 6.0.0

setPixelWidth

public void setPixelWidth(int pixelWidth)
Sets the pixel width of the field.

Parameters:
pixelWidth - The width of the field (in pixels).
Since:
BlackBerry API 6.0.0

getPixelHeight

public int getPixelHeight()
Gets the pixel height of the field.

Returns:
The height of the field (in pixels).
Since:
BlackBerry API 6.0.0

setPixelHeight

public void setPixelHeight(int pixelHeight)
Sets the pixel height of the field.

Parameters:
pixelHeight - The height of the field (in pixels).
Since:
BlackBerry API 6.0.0

getZoom

public int getZoom()
Gets the zoom level of the field.

Returns:
The zoom level of the field.
Since:
BlackBerry API 6.0.0

setZoom

public void setZoom(int zoom)
Sets the zoom level of the field.

Parameters:
zoom - The zoom level of the field.
Since:
BlackBerry API 6.0.0

getBoundingBox

public LatLonRectangle getBoundingBox()
Description copied from interface: Boxable
Retrieves the latitude and longitude-based bounding box of this mappable item.

Note: It's recommended that for classes that implement Boxable that the bounding box calculation be performed at request time, and not at modification time. When there are multiple modifications to perform, continuous recalculation of the bounding box is unnecessary.

It's also recommended that you cache the bounding box information once it's been calculated because requests for the bounding box may be frequent.

Specified by:
getBoundingBox in interface Boxable
Returns:
The axis-aligned bounding box or null if there is no bounding box.
See Also:
Boxable.getBoundingBox()
Since:
BlackBerry API 6.0.0





Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal