Popup (gwty-leaflet 1.0 API)

java.lang.Object
- com.gwidgets.api.leaflet.DivOverlay
- - com.gwidgets.api.leaflet.Popup

All Implemented Interfaces:

Evented, Layer
```
@JsType(isNative=true)
public class Popup
extends DivOverlay
implements Layer, Evented
```
Used to open popups in certain places of the map. Use openPopup of the Map class to open popups while making sure that only one popup is open at one time (recommended for usability), or use of addLayer method of the Map class to open as many as you want.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Popup()

Constructors
Modifier	Constructor and Description
`protected`	`Popup()`

Method Summary

All Methods Instance Methods Concrete Methods
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(elemental2.dom.HTMLElement content, PopupOptions options)` Binds a popup to the layer with the passed content and sets up the neccessary event listeners.
`L`	`bindPopup(String id, PopupOptions options)` Binds a popup to the layer with the passed content and sets up the neccessary event listeners.
`L`	`bindTooltip(elemental2.dom.HTMLElement content, TooltipOptions options)` Binds a tooltip to the layer with the passed *content and sets up the neccessary event listeners.
`L`	`bindTooltip(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`	`bringToBack()` Returns true when the popup is visible on the map.
`L`	`bringToFront()` Returns true when the popup is visible on the map.
`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(String type)` Fires an event of the specified type.
`elemental2.dom.HTMLElement`	`getContentAsHTMLElement()` gets the HTML content of the popup.
`String`	`getContentAsString()` gets content of the popup.
`L`	`getLatLng()` Returns the geographical point of popup.
`elemental2.dom.HTMLElement`	`getPane(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`	`isOpen()` Returns true when the popup is visible on the map.
`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.
`Boolean`	`listens(String type)` Returns true if a particular event type has any listeners attached to it.
`L`	`off()` Removes all listener
`L`	`off(String type)` Removes a listener
`L`	`off(String[] type)` Removes a set of listener
`L`	`on(String type, EventCallback fn)` Adds a set of type/listener pairs.
`L`	`once(String type, EventCallback fn)` the listener will only get fired once and then removed.
`L`	`openOn(Map map)` Adds the popup to the map and closes the previous one.
`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`	`setContent(elemental2.dom.HTMLElement htmlContent)` Sets the HTML content of the popup.
`L`	`setContent(String htmlContent)` Sets the HTML content of the popup.
`L`	`setLatLng(LatLng latlng)` Sets the geographical point where the popup will open.
`L`	`setPopupContent(elemental2.dom.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(String content)` Sets the content of the popup bound to this layer.
`L`	`setTooltipContent(elemental2.dom.HTMLElement content)` Sets the content of the tooltip bound to this layer.
`L`	`setTooltipContent(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.
`L`	`update()` Updates the popup content, layout and position.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Popup
```
protected Popup()
```
- Method Detail
  - openOn
```
@JsMethod
public L openOn(Map map)
```
    Adds the popup to the map and closes the previous one. The same as map.openPopup(popup).
    
    Parameters:
    
    map - the map
    
    Returns:
    
    the L class
  - setLatLng
```
@JsMethod
public L setLatLng(LatLng latlng)
```
    Sets the geographical point where the popup will open.
    
    Parameters:
    
    latlng - the latlng
    
    Returns:
    
    the L class
  - setContent
```
@JsMethod
public L setContent(String htmlContent)
```
    Sets the HTML content of the popup.
    
    Parameters:
    
    htmlContent - the html content
    
    Returns:
    
    the L class
  - getContentAsHTMLElement
```
@JsMethod(name="getContent")
public elemental2.dom.HTMLElement getContentAsHTMLElement()
```
    gets the HTML content of the popup.
    
    Returns:
    
    the content
  - getContentAsString
```
@JsMethod(name="getContent")
public String getContentAsString()
```
    gets content of the popup.
    
    Returns:
    
    the content
  - setContent
```
@JsMethod
public L setContent(elemental2.dom.HTMLElement htmlContent)
```
    Sets the HTML content of the popup.
    
    Parameters:
    
    htmlContent - the html content
    
    Returns:
    
    the l
  - bringToFront
```
@JsMethod
public L bringToFront()
```
    Returns true when the popup is visible on the map.
    
    Returns:
    
    true if popup is open, false otherwise
  - bringToBack
```
@JsMethod
public L bringToBack()
```
    Returns true when the popup is visible on the map.
    
    Returns:
    
    true if popup is open, false otherwise
  - isOpen
```
@JsMethod
public Boolean isOpen()
```
    Returns true when the popup is visible on the map.
    
    Returns:
    
    true if popup is open, false otherwise
  - update
```
@JsMethod
public L update()
```
    Updates the popup content, layout and position. Useful for updating the popup after something inside changed, e.g. image loaded.
    
    Returns:
    
    the L class
  - getLatLng
```
@JsMethod
public L getLatLng()
```
    Returns the geographical point of popup.
    
    Returns:
    
    the L class
  - bindPopup
```
@JsMethod
public L bindPopup(elemental2.dom.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(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(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(elemental2.dom.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(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(elemental2.dom.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(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(elemental2.dom.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 elemental2.dom.HTMLElement getPane(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(String type,
            EventCallback 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(String type,
              EventCallback 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(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(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(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 Boolean listens(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

Class Popup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Popup

Method Detail

openOn

setLatLng

setContent

getContentAsHTMLElement

getContentAsString

setContent

bringToFront

bringToBack

isOpen

update

getLatLng

bindPopup

bindPopup

unbindPopup

openPopup

closePopup

togglePopup

isPopupOpen

setPopupContent

setPopupContent

setPopupContent

getPopup

bindTooltip

bindTooltip

bindTooltip

unbindTooltip

openTooltip

closeTooltip

toggleTooltip

isTooltipOpen

setTooltipContent

setTooltipContent

setTooltipContent

getTooltip

addTo

remove

removeFrom

getPane

clearAllEventListeners

on

once

off

off

off

fire

listens

addEventParent

removeEventParent