|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectnet.rim.device.api.lbs.maps.MapDimensions
public class MapDimensions
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.
| 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 |
|---|
public MapDimensions()
public MapDimensions(int pixelWidth,
int pixelHeight)
pixelWidth - The width of the field (in pixels).pixelHeight - The height of the field (in pixels).
public MapDimensions(MapPoint center,
int pixelWidth,
int pixelHeight,
int zoom,
int rotation)
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).
NullPointerException - if center is null.public MapDimensions(MapDimensions clone)
clone - The object to copy information from.| Method Detail |
|---|
public int hashCode()
Objectjava.util.Hashtable.
The general contract of hashCode is:
hashCode method on each of
the two objects must produce the same integer result.
Object.equals(java.lang.Object)
method, then calling the hashCode method on each of the
two objects must produce distinct integer results. However, the
programmer should be aware that producing distinct integer results
for unequal objects may improve the performance of hashtables.
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.)
hashCode in class ObjectObject.hashCode()public boolean equals(Object obj)
Object
The equals method implements an equivalence relation:
x,
x.equals(x) should return true.
x and
y, x.equals(y) should return
true if and only if y.equals(x) returns
true.
x,
y, and z, if x.equals(y)
returns true and y.equals(z) returns
true, then x.equals(z) should return
true.
x
and y, multiple invocations of x.equals(y)
consistently return true or consistently return
false, provided no information used in
equals comparisons on the object is modified.
x,
x.equals(null) should return false.
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).
equals in class Objectobj - the reference object with which to compare.
true if this object is the same as the obj
argument; false otherwise.Object.equals(Object)public MapPoint getCentre()
MapDimensions.getCenter() instead
public MapPoint getCenter()
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. Create a copy of
the MapPoint to ensure the values will not change.
public void setCentre(MapPoint center)
MapDimensions.setCenter(MapPoint) instead
public void setCenter(MapPoint center)
center - The coordinates for the center of the map.
NullPointerException - if center is null.public int getRotation()
public void setRotation(int rotation)
rotation - The rotation value of the map.public int getPixelWidth()
public void setPixelWidth(int pixelWidth)
pixelWidth - The width of the field (in pixels).public int getPixelHeight()
public void setPixelHeight(int pixelHeight)
pixelHeight - The height of the field (in pixels).public int getZoom()
public void setZoom(int zoom)
zoom - The zoom level of the field.public LatLonRectangle getBoundingBox()
BoxableNote: 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.
getBoundingBox in interface Boxablenull if
there is no bounding box.Boxable.getBoundingBox()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
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