com.gwidgets.api.leaflet

Class CircleMarker

java.lang.Object

com.gwidgets.api.leaflet.Path

com.gwidgets.api.leaflet.CircleMarker

All Implemented Interfaces:

Evented, Layer

Direct Known Subclasses:

Circle

@JsType(isNative=true)
public class CircleMarker
extends Path
implements Layer, Evented

A circle of a fixed size with radius specified in pixels. Extends Circle. Use Map#addLayer to add it to the map.

Author:

Zakaria Amine

Method Summary

Modifier and Type	Method and Description
L	addEventParent(Evented obj) Adds an event parent - an Evented that will receive propagated events
L	addTo(Map map) Adds the layer to the map.
L	bindPopup(HTMLElement content, PopupOptions options) Binds a popup with a particular HTML content to a click on this path.
L	bindPopup(java.lang.String id, PopupOptions options) Bind popup.
L	bindTooltip(HTMLElement content, TooltipOptions options) Binds a tooltip to the layer with the passed *content and sets up the neccessary event listeners.
L	bindTooltip(java.lang.String content, TooltipOptions options) Binds a tooltip to the layer with the passed *content and sets up the neccessary event listeners.
L	bindTooltip(Tooltip content, TooltipOptions options) Binds a tooltip to the layer with the passed content and sets up the neccessary event listeners.
L	clearAllEventListeners() Clear all event listeners.
L	closePopup() Closes the path's bound popup if it is opened.
L	closeTooltip() Closes the tooltip bound to this layer if it is open.
L	fire(java.lang.String type) Fires an event of the specified type.
LatLng	getLatLng() Returns the current geographical position of the circle.
HTMLElement	getPane(java.lang.String name) Returns the HTMLElement representing the named pane on the map.
Popup	getPopup() Returns the popup bound to this layer.
double	getRadius() Returns the current radius of a circle.
Tooltip	getTooltip() Returns the tooltip bound to this layer.
boolean	isPopupOpen() Returns true if the popup bound to this layer is currently open.
boolean	isTooltipOpen() Returns true if the tooltip bound to this layer is currently open.
java.lang.Boolean	listens(java.lang.String type) Returns true if a particular event type has any listeners attached to it.
L	off() Removes all listener
L	off(java.lang.String type) Removes a listener
L	off(java.lang.String[] type) Removes a set of listener
L	on(java.lang.String type, Function fn) Adds a set of type/listener pairs.
L	once(java.lang.String type, Function fn) the listener will only get fired once and then removed.
L	openPopup(LatLng latlng) Opens the popup previously bound by the bindPopup method in the given point, or in one of the path's points if not specified.
L	openTooltip(LatLng latlng) Opens the bound tooltip at the specificed latlng or at the default tooltip anchor if no latlng is passed.
L	remove() Removes the tooltip from the map it is currently active on.
L	removeEventParent(Evented obj) Removes an event parent, so it will stop receiving propagated events
L	removeFrom(Map map) Removes the tooltip from the given map
L	setLatLng(LatLng latlng) Sets the position of a circle to a new location.
L	setPopupContent(HTMLElement content) Sets the content of the popup bound to this layer.
L	setPopupContent(Popup content) Sets the content of the popup bound to this layer.
L	setPopupContent(java.lang.String content) Sets the content of the popup bound to this layer.
L	setRadius(double radius) Sets the radius of a circle.
L	setTooltipContent(HTMLElement content) Sets the content of the tooltip bound to this layer.
L	setTooltipContent(java.lang.String content) Sets the content of the tooltip bound to this layer.
L	setTooltipContent(Tooltip content) Sets the content of the tooltip bound to this layer.
com.google.gwt.core.client.JavaScriptObject	toGeoJSON() Returns a GeoJSON representation of the circle (GeoJSON Point Feature).
L	togglePopup() Opens or closes the popup bound to this layer depending on its current state.
L	toggleTooltip() Opens or closes the tooltip bound to this layer depending on its current state.
L	unbindPopup() Unbind popup.
L	unbindTooltip() Removes the tooltip previously bound with *bindTooltip.

Methods inherited from class com.gwidgets.api.leaflet.Path

bindPopup, bringToBack, bringToFront, getBounds, redraw, setStyle

Methods inherited from class java.lang.Object

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

Method Detail

setLatLng

@JsMethod
public L setLatLng(LatLng latlng)

Sets the position of a circle to a new location.

Parameters:

latlng - the latlng

Returns:

the L class

getLatLng

@JsMethod
public LatLng getLatLng()

Returns the current geographical position of the circle.

Returns:

the lat lng

setRadius

@JsMethod
public L setRadius(double radius)

Sets the radius of a circle. Units are in meters.

Parameters:

radius - the radius

Returns:

the L class

getRadius

@JsMethod
public double getRadius()

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

Returns:

the radius

toGeoJSON

@JsMethod
public com.google.gwt.core.client.JavaScriptObject toGeoJSON()

Returns a GeoJSON representation of the circle (GeoJSON Point Feature).

Returns:

the object

bindPopup

@JsMethod
public L bindPopup(HTMLElement content,
                              PopupOptions options)

Description copied from class: Path

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

Specified by:

bindPopup in interface Layer

Overrides:

bindPopup in class Path

Parameters:

content - the element

options - the options

Returns:

the L class

bindPopup

@JsMethod
public L bindPopup(java.lang.String id,
                              PopupOptions options)

Description copied from class: Path

Bind popup.

Specified by:

bindPopup in interface Layer

Overrides:

bindPopup in class Path

Parameters:

id - the html

options - the options

Returns:

the l

unbindPopup

@JsMethod
public L unbindPopup()

Description copied from class: Path

Unbind popup.

Specified by:

unbindPopup in interface Layer

Overrides:

unbindPopup in class Path

Returns:

the L class

openPopup

@JsMethod
public L openPopup(LatLng latlng)

Description copied from class: Path

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

Specified by:

openPopup in interface Layer

Overrides:

openPopup in class Path

Parameters:

latlng - the latlng

Returns:

the L class

closePopup

@JsMethod
public L closePopup()

Description copied from class: Path

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

Specified by:

closePopup in interface Layer

Overrides:

closePopup in class Path

Returns:

the L class

togglePopup

@JsMethod
public L togglePopup()

Description copied from interface: Layer

Opens or closes the popup bound to this layer depending on its current state.

Specified by:

togglePopup in interface Layer

Returns:

the L class

isPopupOpen

@JsMethod
public boolean isPopupOpen()

Description copied from interface: Layer

Returns true if the popup bound to this layer is currently open.

Specified by:

isPopupOpen in interface Layer

Returns:

true if pop up is open false if closed

setPopupContent

@JsMethod
public L setPopupContent(java.lang.String content)

Description copied from interface: Layer

Sets the content of the popup bound to this layer.

Specified by:

setPopupContent in interface Layer

Returns:

the L class

setPopupContent

@JsMethod
public L setPopupContent(HTMLElement content)

Description copied from interface: Layer

Sets the content of the popup bound to this layer.

Specified by:

setPopupContent in interface Layer

Returns:

the L class

setPopupContent

@JsMethod
public L setPopupContent(Popup content)

Description copied from interface: Layer

Sets the content of the popup bound to this layer.

Specified by:

setPopupContent in interface Layer

Returns:

the L class

getPopup

@JsMethod
public Popup getPopup()

Description copied from interface: Layer

Returns the popup bound to this layer.

Specified by:

getPopup in interface Layer

Returns:

Popup the Pop bound to this layer.

bindTooltip

@JsMethod
public L bindTooltip(java.lang.String content,
                                TooltipOptions options)

Description copied from interface: Layer

Binds a tooltip to the layer with the passed *content and sets up the neccessary event listeners. If a Function is passed it will receive the layer as the first argument and should return a String or HTMLElement.

Specified by:

bindTooltip in interface Layer

Returns:

the L class

bindTooltip

@JsMethod
public L bindTooltip(HTMLElement content,
                                TooltipOptions options)

Description copied from interface: Layer

Binds a tooltip to the layer with the passed *content and sets up the neccessary event listeners. If a Function is passed it will receive the layer as the first argument and should return a String or HTMLElement.

Specified by:

bindTooltip in interface Layer

Returns:

the L class

bindTooltip

@JsMethod
public L bindTooltip(Tooltip content,
                                TooltipOptions options)

Description copied from interface: Layer

Binds a tooltip to the layer with the passed content and sets up the neccessary event listeners. If a Function is passed it will receive the layer as the first argument and should return a String or HTMLElement.

Specified by:

bindTooltip in interface Layer

Returns:

the L class

unbindTooltip

@JsMethod
public L unbindTooltip()

Description copied from interface: Layer

Removes the tooltip previously bound with *bindTooltip.

Specified by:

unbindTooltip in interface Layer

Returns:

the L class

openTooltip

@JsMethod
public L openTooltip(LatLng latlng)

Description copied from interface: Layer

Opens the bound tooltip at the specificed latlng or at the default tooltip anchor if no latlng is passed.

Specified by:

openTooltip in interface Layer

Returns:

the L class

closeTooltip

@JsMethod
public L closeTooltip()

Description copied from interface: Layer

Closes the tooltip bound to this layer if it is open.

Specified by:

closeTooltip in interface Layer

Returns:

the L class

toggleTooltip

@JsMethod
public L toggleTooltip()

Description copied from interface: Layer

Opens or closes the tooltip bound to this layer depending on its current state.

Specified by:

toggleTooltip in interface Layer

Returns:

the L class

isTooltipOpen

@JsMethod
public boolean isTooltipOpen()

Description copied from interface: Layer

Returns true if the tooltip bound to this layer is currently open.

Specified by:

isTooltipOpen in interface Layer

Returns:

boolean true if tooltip is open, false otherwise

setTooltipContent

@JsMethod
public L setTooltipContent(java.lang.String content)

Description copied from interface: Layer

Sets the content of the tooltip bound to this layer.

Specified by:

setTooltipContent in interface Layer

Returns:

the L class

setTooltipContent

@JsMethod
public L setTooltipContent(HTMLElement content)

Description copied from interface: Layer

Sets the content of the tooltip bound to this layer.

Specified by:

setTooltipContent in interface Layer

Returns:

the L class

setTooltipContent

@JsMethod
public L setTooltipContent(Tooltip content)

Description copied from interface: Layer

Sets the content of the tooltip bound to this layer.

Specified by:

setTooltipContent in interface Layer

Returns:

the L class

getTooltip

@JsMethod
public Tooltip getTooltip()

Description copied from interface: Layer

Returns the tooltip bound to this layer.

Specified by:

getTooltip in interface Layer

Returns:

ToolTip the tooltip

addTo

@JsMethod
public L addTo(Map map)

Description copied from class: Path

Adds the layer to the map.

Specified by:

addTo in interface Layer

Overrides:

addTo in class Path

Parameters:

map - the map

Returns:

the L class

remove

@JsMethod
public L remove()

Description copied from interface: Layer

Removes the tooltip from the map it is currently active on.

Specified by:

remove in interface Layer

Returns:

the L class

removeFrom

@JsMethod
public L removeFrom(Map map)

Description copied from interface: Layer

Removes the tooltip from the given map

Specified by:

removeFrom in interface Layer

Returns:

the L class

getPane

@JsMethod
public HTMLElement getPane(java.lang.String name)

Description copied from interface: Layer

Returns the HTMLElement representing the named pane on the map. If name is omitted, returns the pane for this layer.

Specified by:

getPane in interface Layer

Returns:

HTMLElement the element

clearAllEventListeners

@JsMethod
public L clearAllEventListeners()

Description copied from interface: Evented

Clear all event listeners.

Specified by:

clearAllEventListeners in interface Evented

Returns:

the L class

on

@JsMethod
public L on(java.lang.String type,
                       Function fn)

Description copied from interface: Evented

Adds a set of type/listener pairs.

Specified by:

on in interface Evented

Parameters:

type - the type

fn - the callback function

Returns:

the L class

once

@JsMethod
public L once(java.lang.String type,
                         Function fn)

Description copied from interface: Evented

the listener will only get fired once and then removed.

Specified by:

once in interface Evented

Parameters:

type - the type

fn - the callback function

Returns:

the L class

off

@JsMethod
public L off(java.lang.String type)

Description copied from interface: Evented

Removes a listener

Specified by:

off in interface Evented

Parameters:

type - the type

Returns:

the L class

off

@JsMethod
public L off(java.lang.String[] type)

Description copied from interface: Evented

Removes a set of listener

Specified by:

off in interface Evented

Parameters:

type - the type

Returns:

the L class

off

@JsMethod
public L off()

Description copied from interface: Evented

Removes all listener

Specified by:

off in interface Evented

Returns:

the L class

fire

@JsMethod
public L fire(java.lang.String type)

Description copied from interface: Evented

Fires an event of the specified type. You can optionally provide an data object — the first argument of the listener function will contain its properties.

Specified by:

fire in interface Evented

Parameters:

type - the type

Returns:

the L class

listens

@JsMethod
public java.lang.Boolean listens(java.lang.String type)

Description copied from interface: Evented

Returns true if a particular event type has any listeners attached to it.

Specified by:

listens in interface Evented

Returns:

true if there is listener, false otherwise

addEventParent

@JsMethod
public L addEventParent(Evented obj)

Description copied from interface: Evented

Adds an event parent - an Evented that will receive propagated events

Specified by:

addEventParent in interface Evented

Returns:

the L class

removeEventParent

@JsMethod
public L removeEventParent(Evented obj)

Description copied from interface: Evented

Removes an event parent, so it will stop receiving propagated events

Specified by:

removeEventParent in interface Evented

Returns:

the L class