net.java.html.leaflet

Class Path

java.lang.Object

net.java.html.leaflet.ILayer

net.java.html.leaflet.Path

Direct Known Subclasses:

Circle, PolyLine

public abstract class Path
extends ILayer

An abstract class that contains options and constants shared between vector overlays (Polygon, Polyline, Circle).

Method Summary

Modifier and Type	Method and Description
Path	addEventListener(Event.Type type, EventListener listener) Adds a event listener to a particular event type of the object.
Path	addMouseListener(MouseEvent.Type type, MouseListener listener) Adds a mouse listener to a particular mouse event type of the object.
Path	addPopupListener(PopupEvent.Type type, PopupListener listener) Adds a popup listener to a particular popup event type of the object.
Path	addTo(Map map) Adds the layer to the map.
Path	bindPopup(Popup popup) Binds a given popup object to the path.
Path	bindPopup(Popup popup, PopupOptions options) Binds a given popup object with the given options to the path.
Path	bindPopup(String html) Binds a popup with a particular HTML content to a click on this path.
Path	bringToBack() Brings the layer to the bottom of all path layers.
Path	bringToFront() Brings the layer to the top of all path layers.
Path	clearAllEventListeners() Removes all listeners to all events on the object.
Path	closePopup() Closes the path's bound popup if it is opened.
LatLngBounds	getBounds() Returns the LatLngBounds of the path.
Path	openPopup() Opens the popup previously bound by the bindPopup method in the given point, or in one of the path's points if not specified.
Path	redraw() Redraws the layer.
Path	removeEventListener(Event.Type type, EventListener listener) Removes a event listener to a particular event type of the object.
Path	removeMouseListener(MouseEvent.Type type, MouseListener listener) Removes a mouse listener to a particular mouse event type of the object.
Path	removePopupListener(PopupEvent.Type type, PopupListener listener) Removes a popup listener to a particular popup event type of the object.
Path	setStyle(PathOptions options) Changes the appearance of a Path based on the options in the PathOptions object.
Path	unbindPopup() Unbinds the popup previously bound to the path with bindPopup.

Methods inherited from class java.lang.Object

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

Method Detail

addMouseListener

public Path 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 Path 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 ADD and REMOVE are supported.

listener - The registered listener.

Returns:

The map object.

addPopupListener

public Path 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 Path 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 Path 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 ADD and REMOVE are supported.

listener - The registered listener.

Returns:

The map object.

removePopupListener

public Path 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 Path clearAllEventListeners()

Removes all listeners to all events on the object.

Returns:

The map object.

addTo

public Path addTo(Map map)

Adds the layer to the map.

Parameters:

map - The map

Returns:

this

setStyle

public Path setStyle(PathOptions options)

Changes the appearance of a Path based on the options in the PathOptions object.

Parameters:

options - path configuration options

Returns:

this

getBounds

public LatLngBounds getBounds()

Returns the LatLngBounds of the path.

Returns:

LatLngBounds of the path

bringToFront

public Path bringToFront()

Brings the layer to the top of all path layers.

Returns:

this

bringToBack

public Path bringToBack()

Brings the layer to the bottom of all path layers.

Returns:

this

redraw

public Path redraw()

Redraws the layer. Sometimes useful after you changed the coordinates that the path uses.

Returns:

this

bindPopup

public Path bindPopup(String html)

Binds a popup with a particular HTML content to a click on this path.

Parameters:

html - poup HTML content

Returns:

this

bindPopup

public Path bindPopup(Popup popup)

Binds a given popup object to the path.

Parameters:

popup - popup object

Returns:

this

bindPopup

public Path bindPopup(Popup popup,
                      PopupOptions options)

Binds a given popup object with the given options to the path.

Parameters:

popup - popup object

options - popup configuration object

Returns:

this

unbindPopup

public Path unbindPopup()

Unbinds the popup previously bound to the path with bindPopup.

Returns:

this

openPopup

public Path openPopup()

Opens the popup previously bound by the bindPopup method in the given point, or in one of the path's points if not specified.

Returns:

this

closePopup

public Path closePopup()

Closes the path's bound popup if it is opened.

Returns:

this