net.java.html.leaflet

Class Circle

java.lang.Object

net.java.html.leaflet.ILayer

net.java.html.leaflet.Path

net.java.html.leaflet.Circle

Direct Known Subclasses:

CircleMarker

public class Circle
extends Path

A class for drawing circle overlays on a map.

Constructor Summary

Constructors

Constructor and Description
Circle(LatLng latlng, double radius) Instantiates a circle object given a geographical point and a radius in meters.
Circle(LatLng latlng, double radius, PathOptions options) Instantiates a circle object given a geographical point, a radius in meters and an options object.

Method Summary

Modifier and Type	Method and Description
Circle	addTo(Map map) Adds the layer to the map.
Circle	bindPopup(Popup popup) Binds a popup to a click on this circle.
Circle	bindPopup(Popup popup, PopupOptions options) Binds a popup with a particular popup configuration options to a click on this circle.
Circle	bindPopup(String html) Binds a popup with a particular HTML content to a click on this circle.
Circle	bringToBack() Brings the layer to the bottom of all path layers.
Circle	bringToFront() Brings the layer to the top of all path layers.
Circle	closePopup() Closes the bound popup of the circle if it's opened.
LatLng	getLatLng() Returns the current geographical position of the circle.
double	getRadius() Returns the current radius of a circle.
Circle	openPopup() Opens the popup previously bound by the bindPopup method.
Circle	redraw() Redraws the layer.
Circle	setLatLng(LatLng latlng) Changes the circle position to the given point.
Circle	setRadius(double radius) Changes the circle radius to the given value in meters.
Circle	setStyle(PathOptions options) Changes the appearance of a Path based on the options in the PathOptions object.
Circle	unbindPopup() Unbinds the popup previously bound to the circle with bindPopup.

Methods inherited from class net.java.html.leaflet.Path

addEventListener, addMouseListener, addPopupListener, clearAllEventListeners, getBounds, removeEventListener, removeMouseListener, removePopupListener

Methods inherited from class java.lang.Object

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

Constructor Detail

Circle

public Circle(LatLng latlng,
              double radius)

Instantiates a circle object given a geographical point and a radius in meters.

Parameters:

latlng - geographical location of the circle

radius - circle radius

Circle

public Circle(LatLng latlng,
              double radius,
              PathOptions options)

Instantiates a circle object given a geographical point, a radius in meters and an options object.

Parameters:

latlng - geographical location of the circle

radius - circle radius

options - path configuration options

Method Detail

getLatLng

public LatLng getLatLng()

Returns the current geographical position of the circle.

Returns:

geographical position of the circle

getRadius

public double getRadius()

Returns the current radius of a circle. Units are in meters.

Returns:

radius of a circle in meters

setLatLng

public Circle setLatLng(LatLng latlng)

Changes the circle position to the given point.

Parameters:

latlng - location of the circle

Returns:

this

setRadius

public Circle setRadius(double radius)

Changes the circle radius to the given value in meters.

Parameters:

radius - circle radius in meters

Returns:

this

addTo

public Circle addTo(Map map)

Adds the layer to the map.

Overrides:

addTo in class Path

Parameters:

map - The map

Returns:

this

setStyle

public Circle setStyle(PathOptions options)

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

Overrides:

setStyle in class Path

Parameters:

options - path configuration options

Returns:

this

bringToFront

public Circle bringToFront()

Brings the layer to the top of all path layers.

Overrides:

bringToFront in class Path

Returns:

this

bringToBack

public Circle bringToBack()

Brings the layer to the bottom of all path layers.

Overrides:

bringToBack in class Path

Returns:

this

redraw

public Circle redraw()

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

Overrides:

redraw in class Path

Returns:

this

bindPopup

public Circle bindPopup(String html)

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

Overrides:

bindPopup in class Path

Parameters:

html - HTML content of the popup

Returns:

this

bindPopup

public Circle bindPopup(Popup popup)

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

Overrides:

bindPopup in class Path

Parameters:

popup - popup object

Returns:

this

bindPopup

public Circle bindPopup(Popup popup,
                        PopupOptions options)

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

Overrides:

bindPopup in class Path

Parameters:

popup - popup object

options - popup configuration options

Returns:

this

unbindPopup

public Circle unbindPopup()

Unbinds the popup previously bound to the circle with bindPopup.

Overrides:

unbindPopup in class Path

Returns:

this

openPopup

public Circle openPopup()

Opens the popup previously bound by the bindPopup method.

Overrides:

openPopup in class Path

Returns:

this

closePopup

public Circle closePopup()

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

Overrides:

closePopup in class Path

Returns:

this