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

java.lang.Object
  extended by net.rim.device.api.lbs.maps.model.AbstractMappable
      extended by net.rim.device.api.lbs.maps.model.MapPolyLine
          extended by net.rim.device.api.lbs.maps.model.MapSimplePolygon
              extended by net.rim.device.api.lbs.maps.model.MapComplexPolygon
All Implemented Interfaces:
Boxable, Mappable, Persistable
Direct Known Subclasses:
GsPolygon

public class MapComplexPolygon
extends MapSimplePolygon
implements Persistable

Represents a polygon that is composed of an outer boundary, which is defined as an ordered series of MapPoint elements, and inner boundaries that are represented by 0 or more MapSimplePolygon elements.

Error checking is not performed to detect the following invalid situations:

Rendering behavior in all of these situations is undefined.

Since:
BlackBerry API 7.0.0

Constructor Summary
MapComplexPolygon()
          Constructs a new MapComplexPolygon instance.
MapComplexPolygon(MapPoint[] outerBoundary)
          Constructs a new MapComplexPolygon instance with the given MapPoint elements as its outer boundary.
MapComplexPolygon(MapPoint[] outerBoundary, MapSimplePolygon[] innerBoundaries)
          Constructs a new MapComplexPolygon instance with the given MapPoint elements as the outer boundary and the given MapSimplePolygon elements as the inner boundaries.
 
Method Summary
 void addInnerBoundary(MapSimplePolygon innerBoundary)
          Adds an inner boundary to this complex polygon.
 boolean equals(Object obj)
          Indicates whether some other object is "equal to" this one.
 Vector getInnerBoundaries()
          Retrieves the inner boundaries for this complex polygon.
 int hashCode()
          Returns a hash code value for the object.
 void removeAllInnerBoundaries()
          Removes all inner boundaries from this complex polygon.
 boolean removeInnerBoundary(MapSimplePolygon innerBoundary)
          Removes the given inner boundary from this complex polygon, if it exists.
 
Methods inherited from class net.rim.device.api.lbs.maps.model.MapPolyLine
addPoint, getBoundingBox, getPoint, insertPointAt, removeAllPoints, removePoint, removePointAt, setPointAt, size
 
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, toString, wait, wait, wait
 



Constructor Detail

MapComplexPolygon

public MapComplexPolygon()
Constructs a new MapComplexPolygon instance.

Since:
BlackBerry API 7.0.0

MapComplexPolygon

public MapComplexPolygon(MapPoint[] outerBoundary)
Constructs a new MapComplexPolygon instance with the given MapPoint elements as its outer boundary.

Parameters:
outerBoundary - The MapPoint elements that define the outer boundary.
Since:
BlackBerry API 7.0.0

MapComplexPolygon

public MapComplexPolygon(MapPoint[] outerBoundary,
                         MapSimplePolygon[] innerBoundaries)
Constructs a new MapComplexPolygon instance with the given MapPoint elements as the outer boundary and the given MapSimplePolygon elements as the inner boundaries.

Parameters:
outerBoundary - The MapPoint elements that define the outer boundary.
innerBoundaries - The MapSimplePolygon elements representing the inner boundaries.
Since:
BlackBerry API 7.0.0


Method Detail

addInnerBoundary

public void addInnerBoundary(MapSimplePolygon innerBoundary)
Adds an inner boundary to this complex polygon.

Parameters:
innerBoundary - The inner boundary to add to this complex polygon.
Since:
BlackBerry API 7.0.0

removeInnerBoundary

public boolean removeInnerBoundary(MapSimplePolygon innerBoundary)
Removes the given inner boundary from this complex polygon, if it exists.

Parameters:
innerBoundary - The inner boundary to remove.
Returns:
true if the inner boundary was part of this complex polygon, false otherwise.
Since:
BlackBerry API 7.0.0

removeAllInnerBoundaries

public void removeAllInnerBoundaries()
Removes all inner boundaries from this complex polygon.

Since:
BlackBerry API 7.0.0

getInnerBoundaries

public Vector getInnerBoundaries()
Retrieves the inner boundaries for this complex polygon.

Returns:
A Vector of MapSimplePolygon objects representing the inner boundaries.
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:

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 MapPolyLine
Returns:
a hash code value for this object.
See Also:
Object.equals(java.lang.Object), Hashtable
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:

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 MapPolyLine
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:
Boolean.hashCode(), Hashtable
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