net.rim.device.api.lbs.maps
Interface Boxable

All Known Subinterfaces:
DynamicMappable, Mappable, GsElement
All Known Implementing Classes:
LatLonRectangle, MapDimensions, AbstractMappable, MapComplexPolygon, MapImage, MapLine, MapLocation, MapMarker, MapPoint, MapPolyLine, MapSimplePolygon, PeerPoint, GsFolder, GsImage, GsLine, GsMarker, GsPoint, GsPolyLine, GsPolygon, GsRoot, MappableVector

public interface Boxable

Provides an interface that can be implemented to retrieve a bounding box for a specified set of location coordinates (latitude and longitude). This bounding box represents a rectangular area that the mappable item occupies on the map.

Since:
BlackBerry API 7.0.0

Method Summary
 LatLonRectangle getBoundingBox()
          Retrieves the latitude and longitude-based bounding box of this mappable item.
 



Method Detail

getBoundingBox

LatLonRectangle getBoundingBox()
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.

Returns:
The axis-aligned bounding box or null if there is no bounding box.
Since:
BlackBerry API 7.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