net.rim.device.api.lbs.maps.model
Class MapImage

java.lang.Object
  net.rim.device.api.lbs.maps.model.AbstractMappable
      net.rim.device.api.lbs.maps.model.MapPoint
          net.rim.device.api.lbs.maps.model.MapMarker
              net.rim.device.api.lbs.maps.model.MapImage

All Implemented Interfaces:

Comparable, Boxable, Mappable, Persistable

Direct Known Subclasses:

GsImage

public class MapImage
extends MapMarker

Represents a bitmap image for a specified location on a map.

You can specify an image, a thumbnail, or a URI for the location. When you specify a thumbnail, the thumbnail displays directly on the map. When the user clicks on the thumbnail and requests more details, the larger image displays.

Since:

BlackBerry API 7.0.0

Constructor Summary

MapImage()
Constructs a new MapImage instance.

MapImage(double lat, double lon, String iconUri)
Constructs a MapImage instance at the given coordinates which is represented on the map with the icon at the given URI.

MapImage(double lat, double lon, Bitmap bitmap)
Constructs a MapImage instance at the given coordinates with the given bitmap.

MapImage(MapPoint point, String imageURI)
Constructs a MapImage instance at the given map point, using the image at the given URI.

Method Summary
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
Bitmap	getImage() Retrieves the image.
String	getImageURI() Retrieves the URI of the image.
Bitmap	getThumbnail() Retrieves the thumbnail bitmap.
int	hashCode() Returns a hash code value for the object.
void	setImage(Bitmap bitmap) Sets the image.
void	setImageURI(String uri) Sets the URI of the image.
void	setThumbnail(Bitmap thumb) Sets a thumbnail bitmap that displays in the caption when this image has focus.

Methods inherited from class net.rim.device.api.lbs.maps.model.MapMarker

getAnchorOffset, getIconUri, setAnchorOffset, setIconUri

Methods inherited from class net.rim.device.api.lbs.maps.model.MapPoint

compareTo, getBoundingBox, getLat, getLon, setLat, setLon, toCoordinates, toString

Methods inherited from class net.rim.device.api.lbs.maps.model.AbstractMappable

getCommandsByType, getStyleId, isClusterable, match, setStyleId

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MapImage

public MapImage()

Constructs a new MapImage instance.

Since:

BlackBerry API 7.0.0

MapImage

public MapImage(MapPoint point,
                String imageURI)

Constructs a MapImage instance at the given map point, using the image at the given URI.

Parameters:

point - The map point for the location.

imageURI - The image URI for the specified location.

Since:

BlackBerry API 7.0.0

MapImage

public MapImage(double lat,
                double lon,
                Bitmap bitmap)

Constructs a MapImage instance at the given coordinates with the given bitmap.

Parameters:

lat - The latitudinal coordinate for the location.

lon - The longitudinal coordinate for the location.

bitmap - The bitmap image for the specified location.

Since:

BlackBerry API 7.0.0

MapImage

public MapImage(double lat,
                double lon,
                String iconUri)

Constructs a MapImage instance at the given coordinates which is represented on the map with the icon at the given URI.

Parameters:

lat - The latitudinal coordinate for the location.

lon - The longitudinal coordinate for the location.

iconUri - The URI of the icon.

Since:

BlackBerry API 7.0.0

Method Detail

getImage

public Bitmap getImage()

Retrieves the image.

Returns:

The image.

Since:

BlackBerry API 7.0.0

setImage

public void setImage(Bitmap bitmap)

Sets the image.

Parameters:

bitmap - The image to set.

Since:

BlackBerry API 7.0.0

setThumbnail

public void setThumbnail(Bitmap thumb)

Sets a thumbnail bitmap that displays in the caption when this image has focus.

Parameters:

thumb - The thumbnail bitmap to display.

Since:

BlackBerry API 7.0.0

getThumbnail

public Bitmap getThumbnail()

Retrieves the thumbnail bitmap.

Returns:

bitmap The thumbnail bitmap.

Since:

BlackBerry API 7.0.0

setImageURI

public void setImageURI(String uri)

Sets the URI of the image.

Parameters:

uri - The URI of the image.

Since:

BlackBerry API 7.0.0

getImageURI

public String getImageURI()

Retrieves the URI of the image.

Returns:

The URI of the image.

Since:

BlackBerry API 7.0.0

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:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the 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 Java^TM programming language.)

Overrides:

hashCode in class MapMarker

Returns:

a hash code value for this object.

See Also:

Object.hashCode()

Since:

BlackBerry API 7.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:

• It is reflexive: for any reference value x, x.equals(x) should return true.
• It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any reference values 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.
• For any non-null reference value 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).

Overrides:

equals in class MapMarker

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 7.0.0