com.teamdev.jxmaps

Class Icon

java.lang.Object

com.teamdev.jxmaps.MapObject

com.teamdev.jxmaps.Icon

All Implemented Interfaces:

java.lang.Cloneable

public class Icon
extends MapObject

Represents icon object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Icon.Property

Constructor Summary

Constructors

Constructor and Description
Icon() Creates new Icon object.
Icon(Map map) Deprecated.

Method Summary

Modifier and Type	Method and Description
Point	getAnchor() Returns value of anchor property.
Point	getLabelOrigin() Returns value of labelOrigin property.
Point	getOrigin() Returns value of origin property.
Size	getScaledSize() Returns value of scaledSize property.
Size	getSize() Returns value of size property.
java.lang.String	getUrl() Returns value of url property.
void	loadFromFile(java.io.File file) Loads icon image from file.
void	loadFromFile(java.lang.String fileName) Loads icon image from file.
void	loadFromStream(java.io.InputStream stream, java.lang.String imageType) Loads icon image from stream.
void	setAnchor(Point value) Sets new value for anchor property.
void	setLabelOrigin(Point value) Sets new value for labelOrigin property.
void	setOrigin(Point value) Sets new value for origin property.
void	setScaledSize(Size value) Sets new value for scaledSize property.
void	setSize(Size value) Sets new value for size property.
void	setUrl(java.lang.String value) Sets new value for url property.

Methods inherited from class com.teamdev.jxmaps.MapObject

addEventListener, attachObject, cacheProperties, cacheProperties, clone, createJSValue, dispose, fromJSValue, getJSObject, getMap, getProperties, invokeMethod, propertyChanged, removeEventListener, updateProperty

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Icon

public Icon()

Creates new Icon object.

Icon

@Deprecated
public Icon(Map map)

Deprecated.

Creates new Icon object.

Parameters:

map - owner Map object

Method Detail

getAnchor

public Point getAnchor()

Returns value of anchor property.

Represents the position at which to anchor an image in correspondence to the location of the marker on the map. By default, the anchor is located along the center point of the bottom of the image.

Returns:

property value

See Also:

setAnchor(com.teamdev.jxmaps.Point)

setAnchor

public void setAnchor(@Nullable
                      Point value)

Sets new value for anchor property.

Parameters:

value - new property value

See Also:

getAnchor()

getLabelOrigin

public Point getLabelOrigin()

Returns value of labelOrigin property.

Represents the origin of the label relative to the top-left corner of the icon image, if a label is supplied by the marker. By default, the origin is located in the center point of the image.

Returns:

property value

See Also:

setLabelOrigin(com.teamdev.jxmaps.Point)

setLabelOrigin

public void setLabelOrigin(Point value)

Sets new value for labelOrigin property.

Parameters:

value - new property value

See Also:

getLabelOrigin()

getOrigin

public Point getOrigin()

Returns value of origin property.

Represents the position of the image within a sprite, if any. By default, the origin is located at the top left corner of the image (0, 0).

Returns:

property value

See Also:

setOrigin(com.teamdev.jxmaps.Point)

setOrigin

public void setOrigin(@Nullable
                      Point value)

Sets new value for origin property.

Parameters:

value - new property value

See Also:

getOrigin()

getSize

public Size getSize()

Returns value of size property.

Represents the display size of the sprite or image. When using sprites, you must specify the sprite size. If the size is not provided, it will be set when the image loads.

Returns:

property value

See Also:

setSize(com.teamdev.jxmaps.Size)

setSize

public void setSize(@Nullable
                    Size value)

Sets new value for size property.

Parameters:

value - new property value

See Also:

getSize()

getScaledSize

@Nullable
public Size getScaledSize()

Returns value of scaledSize property.

Represents LatLngBounds within which to search. Optional.

Returns:

property value

See Also:

setScaledSize(com.teamdev.jxmaps.Size)

setScaledSize

public void setScaledSize(@Nullable
                          Size value)

Sets new value for scaledSize property.

Parameters:

value - new property value

See Also:

getScaledSize()

getUrl

public java.lang.String getUrl()

Returns value of url property.

Represents the URL of the image or sprite sheet.

Returns:

property value

See Also:

setUrl(java.lang.String)

setUrl

public void setUrl(java.lang.String value)

Sets new value for url property.

Parameters:

value - new property value

See Also:

getUrl()

loadFromStream

public void loadFromStream(java.io.InputStream stream,
                           java.lang.String imageType)

Loads icon image from stream.

Parameters:

stream - source stream.

imageType - type of image. Can be jpeg on png.

See Also:

loadFromFile(java.io.File)

loadFromFile

public void loadFromFile(java.io.File file)
                  throws java.io.FileNotFoundException

Loads icon image from file.

Parameters:

file - source file.

Throws:

java.io.FileNotFoundException

See Also:

loadFromStream(java.io.InputStream, java.lang.String)

loadFromFile

public void loadFromFile(java.lang.String fileName)
                  throws java.io.FileNotFoundException

Loads icon image from file.

Parameters:

fileName - name of input file.

Throws:

java.io.FileNotFoundException

See Also:

loadFromStream(java.io.InputStream, java.lang.String)