com.gwidgets.api.leaflet

Class Tooltip

java.lang.Object

com.gwidgets.api.leaflet.DivOverlay

com.gwidgets.api.leaflet.Tooltip

All Implemented Interfaces:

Evented, Layer

@JsType(isNative=true)
public class Tooltip
extends DivOverlay
implements Layer, Evented

The Class Tooltip.

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 tooltip to the given map
L	bindPopup(HTMLElement content, PopupOptions options) Binds a popup to the layer with the passed content and sets up the neccessary event listeners.
L	bindPopup(java.lang.String id, PopupOptions options) Binds a popup to the layer with the passed content and sets up the neccessary event listeners.
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 popup bound to this layer if it is open.
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.
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.
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 bound popup at the specificed latlng or at the default popup anchor if no latlng is passed.
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	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	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.
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() Removes the popup previously bound with bindPopup.
L	unbindTooltip() Removes the tooltip previously bound with *bindTooltip.

Methods inherited from class java.lang.Object

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

Method Detail

bindPopup

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

Description copied from interface: Layer

Binds a popup to the layer with the passed content and sets up the neccessary event listeners.

Specified by:

bindPopup in interface Layer

Returns:

the L class

bindPopup

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

Description copied from interface: Layer

Binds a popup to the layer with the passed content and sets up the neccessary event listeners.

Specified by:

bindPopup in interface Layer

Returns:

the L class

unbindPopup

@JsMethod
public L unbindPopup()

Description copied from interface: Layer

Removes the popup previously bound with bindPopup.

Specified by:

unbindPopup in interface Layer

Returns:

the L class

openPopup

@JsMethod
public L openPopup(LatLng latlng)

Description copied from interface: Layer

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

Specified by:

openPopup in interface Layer

Returns:

the L class

closePopup

@JsMethod
public L closePopup()

Description copied from interface: Layer

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

Specified by:

closePopup in interface Layer

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

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

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

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

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

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

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

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

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

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

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

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

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

public L addTo(Map map)

Description copied from interface: Layer

Adds the tooltip to the given map

Specified by:

addTo in interface Layer

Returns:

the L class

remove

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

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

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

public L clearAllEventListeners()

Description copied from interface: Evented

Clear all event listeners.

Specified by:

clearAllEventListeners in interface Evented

Returns:

the L class

on

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

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

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

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

public L off()

Description copied from interface: Evented

Removes all listener

Specified by:

off in interface Evented

Returns:

the L class

fire

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

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

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

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