jp.sf.mapswidgets
Class Icon

java.lang.Object
  extended by jp.sf.mapswidgets.Icon
All Implemented Interfaces:
java.lang.Cloneable

public final class Icon
extends java.lang.Object
implements java.lang.Cloneable

Instances of this class represent the image used to display a marker on the map.

See Google Maps API documentation [Class Reference > GIcon].

See Also:
Marker

Constructor Summary
Icon()
          Construct a new instance of this class.
Icon(Icon copyFrom)
          Construct a new instance of this class given the icon.
Icon(java.lang.String imageURL, Size imageSize, java.lang.String shadowImageURL, Size shadowImageSize, Point offsetOfMarker)
          Construct a new instance of this class given the mandatory values.
 
Method Summary
 int[] getClickArea()
          Get the click area to capture non-IE browsers click events.
 java.lang.String getClickAreImageURL()
          Get the click area image URL to capture IE click events.
 Size getImageSize()
          Get the image size.
 java.lang.String getImageURL()
          Get the image URL.
 Point getOffsetOfInfoWindow()
          Get the offset of the marker info window.
 Point getOffsetOfMarker()
          Get the offset of the marker.
 java.lang.String getPrintImageURL()
          Get the print image URL.
 java.lang.String getPrintImageURLForMozilla()
          Get the print image URL for Firefox/Mozilla.
 java.lang.String getPrintShadowImageURL()
          Get the print shadow image URL.
 Size getShadowImageSize()
          Get the shadow image size.
 java.lang.String getShadowImageURL()
          Get the shadow image URL.
 void setClickArea(int[] clickArea)
          Set the click area to capture non-IE browsers click events.
 void setClickAreImageURL(java.lang.String clickAreImageURL)
          Set the click area image URL to capture IE click events.
 void setImageSize(Size imageSize)
          Set the image size.
 void setImageURL(java.lang.String imageURL)
          Set the image URL.
 void setOffsetOfInfoWindow(Point offsetOfInfoWindow)
          Set the offset of the marker info window.
 void setOffsetOfMarker(Point offsetOfMarker)
          Set the offset of the marker.
 void setPrintImageURL(java.lang.String printImageURL)
          Set the print image URL.
 void setPrintImageURLForMozilla(java.lang.String printImageURLForMozilla)
          Set the print image URL for Firefox/Mozilla.
 void setPrintShadowImageURL(java.lang.String printShadowImageURL)
          Set the print shadow image URL.
 void setShadowImageSize(Size shadowImageSize)
          Set the shadow image size.
 void setShadowImageURL(java.lang.String shadowImageURL)
          Set the shadow image URL.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Icon

public Icon()
Construct a new instance of this class.


Icon

public Icon(Icon copyFrom)
Construct a new instance of this class given the icon.

Parameters:
copyFrom - the base icon

Icon

public Icon(java.lang.String imageURL,
            Size imageSize,
            java.lang.String shadowImageURL,
            Size shadowImageSize,
            Point offsetOfMarker)
Construct a new instance of this class given the mandatory values.

Parameters:
imageURL - the icon image URL
imageSize - the icon image size
shadowImageURL - the shadow icon image URL
shadowImageSize - the shadow icon image size
offsetOfMarker - the offset of the marker
Method Detail

getClickArea

public int[] getClickArea()
Get the click area to capture non-IE browsers click events.

See Google Maps API documentation [Class Reference > GIcon > imageMap].

Returns:
the click area

getClickAreImageURL

public java.lang.String getClickAreImageURL()
Get the click area image URL to capture IE click events.

See Google Maps API documentation [Class Reference > GIcon > transparent].

Returns:
the click area image URL

getImageSize

public Size getImageSize()
Get the image size.

See Google Maps API documentation [Class Reference > GIcon > iconSize].

Returns:
the image size

getImageURL

public java.lang.String getImageURL()
Get the image URL.

See Google Maps API documentation [Class Reference > GIcon > image].

Returns:
the image URL

getOffsetOfInfoWindow

public Point getOffsetOfInfoWindow()
Get the offset of the marker info window.

See Google Maps API documentation [Class Reference > GIcon > iconWindowAnchor].

Returns:
the offset of the marker info window

getOffsetOfMarker

public Point getOffsetOfMarker()
Get the offset of the marker.

See Google Maps API documentation [Class Reference > GIcon > iconAnchor].

Returns:
the offset of the marker

getPrintImageURL

public java.lang.String getPrintImageURL()
Get the print image URL.

See Google Maps API documentation [Class Reference > GIcon > printImage].

Returns:
the print image URL

getPrintImageURLForMozilla

public java.lang.String getPrintImageURLForMozilla()
Get the print image URL for Firefox/Mozilla.

See Google Maps API documentation [Class Reference > GIcon > mozPrintImage].

Returns:
the print image URL for Firefox/Mozilla

getPrintShadowImageURL

public java.lang.String getPrintShadowImageURL()
Get the print shadow image URL.

See Google Maps API documentation [Class Reference > GIcon > printShadow].

Returns:
the print shadow image URL

getShadowImageSize

public Size getShadowImageSize()
Get the shadow image size.

See Google Maps API documentation [Class Reference > GIcon > shadowSize].

Returns:
the shadow image size

getShadowImageURL

public java.lang.String getShadowImageURL()
Get the shadow image URL.

See Google Maps API documentation [Class Reference > GIcon > shadow].

Returns:
the shadow image URL

setClickArea

public void setClickArea(int[] clickArea)
Set the click area to capture non-IE browsers click events.

See Google Maps API documentation [Class Reference > GIcon > imageMap].

Parameters:
clickArea - the click area

setClickAreImageURL

public void setClickAreImageURL(java.lang.String clickAreImageURL)
Set the click area image URL to capture IE click events.

This image should be a 24-bit PNG version of the main icon image with 1% opacity, but the same shape and size as the main icon.

See Google Maps API documentation [Class Reference > GIcon > transparent].

Parameters:
clickAreImageURL - the click area image URL

setImageSize

public void setImageSize(Size imageSize)
Set the image size.

See Google Maps API documentation [Class Reference > GIcon > iconSize].

Parameters:
imageSize - the image size

setImageURL

public void setImageURL(java.lang.String imageURL)
Set the image URL.

See Google Maps API documentation [Class Reference > GIcon > image].

Parameters:
imageURL - the image URL

setOffsetOfInfoWindow

public void setOffsetOfInfoWindow(Point offsetOfInfoWindow)
Set the offset of the marker info window.

See Google Maps API documentation [Class Reference > GIcon > iconWindowAnchor].

Parameters:
offsetOfInfoWindow - the offset of the marker info window

setOffsetOfMarker

public void setOffsetOfMarker(Point offsetOfMarker)
Set the offset of the marker.

See Google Maps API documentation [Class Reference > GIcon > iconAnchor].

Parameters:
offsetOfMarker - the offset of the marker

setPrintImageURL

public void setPrintImageURL(java.lang.String printImageURL)
Set the print image URL.

See Google Maps API documentation [Class Reference > GIcon > printImage].

Parameters:
printImageURL - the print image URL

setPrintImageURLForMozilla

public void setPrintImageURLForMozilla(java.lang.String printImageURLForMozilla)
Set the print image URL for Firefox/Mozilla.

See Google Maps API documentation [Class Reference > GIcon > mozPrintImage].

Parameters:
printImageURLForMozilla - the print image URL for Firefox/Mozilla

setPrintShadowImageURL

public void setPrintShadowImageURL(java.lang.String printShadowImageURL)
Set the print shadow image URL.

See Google Maps API documentation [Class Reference > GIcon > printShadow].

Parameters:
printShadowImageURL - the print shadow image URL

setShadowImageSize

public void setShadowImageSize(Size shadowImageSize)
Set the shadow image size.

See Google Maps API documentation [Class Reference > GIcon > shadowSize].

Parameters:
shadowImageSize - the shadow image size

setShadowImageURL

public void setShadowImageURL(java.lang.String shadowImageURL)
Set the shadow image URL.

See Google Maps API documentation [Class Reference > GIcon > shadow].

Parameters:
shadowImageURL - the shadow image URL