net.java.html.leaflet

Class Marker

java.lang.Object

net.java.html.leaflet.ILayer

net.java.html.leaflet.Marker

public final class Marker
extends ILayer

Class representing a marker on a map

Constructor Summary

Constructors

Constructor and Description
Marker(LatLng latLng) Instantiates a Marker object given a geographical point.
Marker(LatLng latLng, MarkerOptions options) Instantiates a Marker object given a geographical point and an options object.

Method Summary

Modifier and Type	Method and Description
Marker	addDragEndListener(DragEndEvent.Type type, DragEndListener listener) Adds a drag end listener to a particular drag end event type of the object.
Marker	addEventListener(Event.Type type, EventListener listener) Adds a event listener to a particular event type of the object.
Marker	addMouseListener(MouseEvent.Type type, MouseListener listener) Adds a mouse listener to a particular mouse event type of the object.
Marker	addPopupListener(PopupEvent.Type type, PopupListener listener) Adds a popup listener to a particular popup event type of the object.
void	addTo(Map map) Adds the marker to the map.
Marker	bindPopup(Popup popup) Binds a popup to a click on this marker.
Marker	bindPopup(Popup popup, PopupOptions options) Binds a popup with a particular popup configuration options to a click on this marker.
Marker	bindPopup(String html) Binds a popup with a particular HTML content to a click on this marker.
Marker	clearAllEventListeners() Removes all listeners to all events on the object.
Marker	closePopup() Closes the bound popup of the marker if it's opened.
LatLng	getLatLng() Returns the current geographical position of the marker.
Popup	getPopup() Returns the popup previously bound by the bindPopup method.
Marker	openPopup() Opens the popup previously bound by the bindPopup method.
Marker	removeDragEndListener(DragEndEvent.Type type, DragEndListener listener) Removes a drag end listener to a particular drag end event type of the object.
Marker	removeEventListener(Event.Type type, EventListener listener) Removes a event listener to a particular event type of the object.
Marker	removeMouseListener(MouseEvent.Type type, MouseListener listener) Removes a mouse listener to a particular mouse event type of the object.
Marker	removePopupListener(PopupEvent.Type type, PopupListener listener) Removes a popup listener to a particular popup event type of the object.
void	setIcon(Icon icon) Changes the marker icon.
void	setLatLng(LatLng latlng) Changes the marker position to the given point.
void	setOpacity(double opacity) Changes the opacity of the marker.
Marker	setPopupContent(String html) Sets an HTML content of the popup of this marker.
void	setZIndexOffset(double offset) Changes the zIndex offset of the marker.
Marker	togglePopup() Toggles the popup previously bound by the bindPopup method.
Marker	unbindPopup() Unbinds the popup previously bound to the marker with bindPopup.
void	update() Updates the marker position.

Methods inherited from class java.lang.Object

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

Constructor Detail

Marker

public Marker(LatLng latLng)

Instantiates a Marker object given a geographical point.

Parameters:

latLng - geographical location

Marker

public Marker(LatLng latLng,
              MarkerOptions options)

Instantiates a Marker object given a geographical point and an options object.

Parameters:

latLng - geographical location

options - marker configuration options

Method Detail

addMouseListener

public Marker addMouseListener(MouseEvent.Type type,
                               MouseListener listener)

Adds a mouse listener to a particular mouse event type of the object.

Parameters:

type - The mouse event type. The types CLICK, DBLCLICK, MOUSEDOWN, MOUSEOVER, MOUSEOUT, and CONTEXTMENU are supported.

listener - The registered listener.

Returns:

The map object.

addEventListener

public Marker addEventListener(Event.Type type,
                               EventListener listener)

Adds a event listener to a particular event type of the object.

Parameters:

type - The event type. The types DRAGSTART, DRAG, MOVE, ADD and REMOVE are supported.

listener - The registered listener.

Returns:

The map object.

addDragEndListener

public Marker addDragEndListener(DragEndEvent.Type type,
                                 DragEndListener listener)

Adds a drag end listener to a particular drag end event type of the object.

Parameters:

type - The drag end event type. The type DRAGEND is supported.

listener - The registered listener.

Returns:

The map object.

addPopupListener

public Marker addPopupListener(PopupEvent.Type type,
                               PopupListener listener)

Adds a popup listener to a particular popup event type of the object.

Parameters:

type - The popup event type. The types POPUPOPEN and POPUPCLOSE are supported.

listener - The registered listener.

Returns:

The map object.

removeMouseListener

public Marker removeMouseListener(MouseEvent.Type type,
                                  MouseListener listener)

Removes a mouse listener to a particular mouse event type of the object.

Parameters:

type - The mouse event type. The types CLICK, DBLCLICK, MOUSEDOWN, MOUSEOVER, MOUSEOUT, and CONTEXTMENU are supported.

listener - The registered listener.

Returns:

The map object.

removeEventListener

public Marker removeEventListener(Event.Type type,
                                  EventListener listener)

Removes a event listener to a particular event type of the object.

Parameters:

type - The event type. The types DRAGSTART, DRAG, MOVE, ADD and REMOVE are supported.

listener - The registered listener.

Returns:

The map object.

removeDragEndListener

public Marker removeDragEndListener(DragEndEvent.Type type,
                                    DragEndListener listener)

Removes a drag end listener to a particular drag end event type of the object.

Parameters:

type - The drag end event type. The type DRAGEND is supported.

listener - The registered listener.

Returns:

The map object.

removePopupListener

public Marker removePopupListener(PopupEvent.Type type,
                                  PopupListener listener)

Removes a popup listener to a particular popup event type of the object.

Parameters:

type - The popup event type. The types POPUPOPEN and POPUPCLOSE are supported.

listener - The registered listener.

Returns:

The map object.

clearAllEventListeners

public Marker clearAllEventListeners()

Removes all listeners to all events on the object.

Returns:

The map object.

addTo

public void addTo(Map map)

Adds the marker to the map.

Parameters:

map - The map

getLatLng

public LatLng getLatLng()

Returns the current geographical position of the marker.

Returns:

location of the marker

setLatLng

public void setLatLng(LatLng latlng)

Changes the marker position to the given point.

Parameters:

latlng - location of the marker

setIcon

public void setIcon(Icon icon)

Changes the marker icon.

Parameters:

icon - marker icon

setZIndexOffset

public void setZIndexOffset(double offset)

Changes the zIndex offset of the marker.

Parameters:

offset - zIndex offset of the marker

setOpacity

public void setOpacity(double opacity)

Changes the opacity of the marker.

Parameters:

opacity - opacity of the marker

update

public void update()

Updates the marker position.

bindPopup

public Marker bindPopup(String html)

Binds a popup with a particular HTML content to a click on this marker. You can also open the bound popup with the Marker openPopup method.

Parameters:

html - HTML content of the popup

Returns:

this

bindPopup

public Marker bindPopup(Popup popup)

Binds a popup to a click on this marker. You can also open the bound popup with the Marker openPopup method.

Parameters:

popup - popup object

Returns:

this

bindPopup

public Marker bindPopup(Popup popup,
                        PopupOptions options)

Binds a popup with a particular popup configuration options to a click on this marker. You can also open the bound popup with the Marker openPopup method.

Parameters:

popup - popup object

options - popup configuration options

Returns:

this

unbindPopup

public Marker unbindPopup()

Unbinds the popup previously bound to the marker with bindPopup.

Returns:

this

openPopup

public Marker openPopup()

Opens the popup previously bound by the bindPopup method.

Returns:

this

getPopup

public Popup getPopup()

Returns the popup previously bound by the bindPopup method.

Returns:

this

closePopup

public Marker closePopup()

Closes the bound popup of the marker if it's opened.

Returns:

this

togglePopup

public Marker togglePopup()

Toggles the popup previously bound by the bindPopup method.

Returns:

this

setPopupContent

public Marker setPopupContent(String html)

Sets an HTML content of the popup of this marker.

Parameters:

html - HTML content of the popup

Returns:

this