org.fujion.lmaps

Class LeafletMap

java.lang.Object

org.fujion.component.BaseComponent

org.fujion.component.BaseUIComponent

org.fujion.lmaps.LeafletMap

All Implemented Interfaces:

org.fujion.ancillary.IDisable, org.fujion.ancillary.IElementIdentifier, org.fujion.client.IClientTransform, org.fujion.common.IAttributeMap<String,Object>

@Component(tag="lmap",
           widgetModule="fujion-lmaps",
           widgetClass="LeafletMap",
           parentTag="*",
           description="Fujion wrapper for leaflet.js interactive maps.")
public class LeafletMap
extends org.fujion.component.BaseUIComponent

Fujion wrapper for Leaflet.js interactive maps.

Nested Class Summary

Nested classes/interfaces inherited from class org.fujion.component.BaseComponent

org.fujion.component.BaseComponent.ComponentReference<T extends org.fujion.component.BaseComponent>, org.fujion.component.BaseComponent.SubComponent

Field Summary

Fields inherited from interface org.fujion.ancillary.IElementIdentifier

log

Constructor Summary

Constructors

Constructor and Description
LeafletMap()

Method Summary

Modifier and Type	Method and Description
void	clear() Removes the current map.
void	fitBounds(LatLngBounds bounds) Sets a map view that contains the given geographical bounds with the maximum zoom level possible.
void	flyToBounds(LatLngBounds bounds)
LatLng	getCenter() Get the center coordinates.
int	getMaxZoom() Gets the upper limit for the available zoom levels.
int	getMinZoom() Gets the lower limit for the available zoom levels.
LeafletOptions	getOptions() Returns the option map.
int	getZoom() Get the map's zoom level.
boolean	isRunning() Returns true if a map is currently displayed on the client.
void	locate() Tries to locate the user using the Geolocation API, firing a locationfound event with location data on success or a locationerror event on failure.
void	locate(LocateOptions options) Tries to locate the user using the Geolocation API, firing a locationfound event with location data on success or a locationerror event on failure, and optionally sets the map view to the user's location with respect to detection accuracy (or to the world view if geolocation failed).
void	panBy(double x, double y) Pans the map to a given center.
void	panInside(LatLng latlng) Pans the map the minimum amount to make the latlng visible.
void	panInside(LatLngBounds bounds) Pans the map to the closest view that would lie inside the given bounds (if it's not already).
void	panTo(LatLng center) Changes the center of the map to the given LatLng.
void	run() Display the map on the client using the current options.
void	setCenter(LatLng center) Sets the current center of the map.
void	setCenter(String center) Set the center coordinates.
void	setMaxZoom(int maxZoom) Set the upper limit for the available zoom levels.
void	setMinZoom(int minZoom) Set the lower limit for the available zoom levels.
void	setZoom(int zoom) Set the map's zoom level.
void	stopLocate() Stops watching location previously initiated by map.locate({watch: true}) and aborts resetting the map view if map.locate was called with {setView: true}.
void	zoom(int delta) Increments the zoom of the map by delta.
void	zoomAround(LatLng position) Zooms the map while keeping a specified geographical position on the map stationary.
void	zoomAround(Point offset) Zooms the map while keeping a specified pixel on the map (relative to the top-left corner) stationary.

Methods inherited from class org.fujion.component.BaseUIComponent

_syncClasses, _syncStyles, addClass, addMask, addMask, addMask, addStyle, addStyles, afterRemoveChild, focus, getBalloon, getClasses, getContext, getCss, getDragid, getDropid, getFirstVisibleChild, getFirstVisibleChild, getFlex, getHeight, getHint, getKeycapture, getPopup, getStyle, getStyles, getTabindex, getWidth, hide, isDisabled, isVisible, print, print, removeClass, removeMask, removeStyle, reportSize, scrollIntoView, setBalloon, setClasses, setContext, setCss, setDisabled, setDragid, setDropid, setFlex, setFocus, setHeight, setHint, setKeycapture, setPopup, setStyles, setTabindex, setVisible, setWidth, show, toggleClass

Methods inherited from class org.fujion.component.BaseComponent

_attach, _initProps, addChild, addChild, addChild, addChildren, addComposite, addEventForward, addEventForward, addEventForward, addEventForward, addEventListener, addEventListener, addEventListener, addEventListener, afterAddChild, afterSetParent, areEqual, beforeAddChild, beforeRemoveChild, beforeSetParent, bind, bringToFront, defaultify, destroy, destroyChildren, detach, detachChildren, disableChildren, disableChildren, finalize, findAllNamed, findAttribute, findByName, findByName, findChild, findChildByData, findChildByLabel, findChildByLabel, fireEvent, fireEvent, fireEventToClient, fireEventToClient, getAncestor, getAncestor, getAttribute, getAttribute, getAttributes, getChildAt, getChildCount, getChildCount, getChildren, getChildren, getContent, getControllers, getData, getData, getDefinition, getFirstChild, getFirstChild, getId, getIndex, getLastChild, getLastController, getLastController, getName, getNamespace, getNextSibling, getNextSibling, getPage, getParent, getPreviousSibling, getPreviousSibling, getRoot, hasChildren, hasEventListener, hasEventListener, initialize, invoke, invoke, invoke, invoke, invoke, invokeIfAttached, isAncestor, isContainer, isContentSynced, isDead, isInitializing, isNamespace, isRendered, loadModule, loadModule, notifyAncestors, notifyDescendants, nullify, onAttach, onDestroy, propertyChange, propertyChange, removeChild, removeEventForward, removeEventForward, removeEventForward, removeEventForward, removeEventListener, removeEventListener, removeEventListener, removeEventListener, setContent, setContentSynced, setData, setIndex, setName, setNamespace, setParent, sub, swapChildren, sync, toString, trimify, validate, validate, validateChild, validateIsChild, validateName, validatePage, validateParent, wireController, wireController

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fujion.ancillary.IElementIdentifier

transformForClient

Methods inherited from interface org.fujion.common.IAttributeMap

getAttribute, hasAttribute, removeAttribute, setAttribute

Constructor Detail

LeafletMap

public LeafletMap()

Method Detail

clear

public void clear()

Removes the current map.

run

public void run()

Display the map on the client using the current options.

isRunning

public boolean isRunning()

Returns true if a map is currently displayed on the client.

Returns:

True if a map is being displayed.

getOptions

public LeafletOptions getOptions()

Returns the option map.

Returns:

The option map.

getCenter

@Component.PropertyGetter(value="center",
                          description="The coordinates of the map\'s center.")
public LatLng getCenter()

Get the center coordinates.

Returns:

The coordinates of the map's center.

setCenter

@Component.PropertySetter(value="center",
                          description="The coordinates of the map\'s center.")
public void setCenter(String center)

Set the center coordinates.

Parameters:

center - The center coordinates.

setCenter

public void setCenter(LatLng center)

Sets the current center of the map.

Parameters:

center - The current center of the map.

getZoom

@Component.PropertyGetter(value="zoom",
                          description="The map\'s current zoom level.")
public int getZoom()

Get the map's zoom level.

Returns:

The map's zoom level.

setZoom

@Component.PropertySetter(value="zoom",
                          description="The map\'s current zoom level.")
public void setZoom(int zoom)

Set the map's zoom level.

Parameters:

zoom - The map's zoom level.

getMinZoom

@Component.PropertyGetter(value="minZoom",
                          description="The lower limit for the available zoom levels.")
public int getMinZoom()

Gets the lower limit for the available zoom levels.

Returns:

The lower limit for the available zoom levels.

setMinZoom

@Component.PropertySetter(value="minZoom",
                          description="The lower limit for the available zoom levels.")
public void setMinZoom(int minZoom)

Set the lower limit for the available zoom levels.

Parameters:

minZoom - The lower limit for the available zoom levels.

getMaxZoom

@Component.PropertyGetter(value="maxZoom",
                          description="The upper limit for the available zoom levels.")
public int getMaxZoom()

Gets the upper limit for the available zoom levels.

Returns:

The upper limit for the available zoom levels.

setMaxZoom

@Component.PropertySetter(value="maxZoom",
                          description="The upper limit for the available zoom levels.")
public void setMaxZoom(int maxZoom)

Set the upper limit for the available zoom levels.

Parameters:

maxZoom - The upper limit for the available zoom levels.

panBy

public void panBy(double x,
                  double y)

Pans the map to a given center.

Parameters:

x - The x increment.

y - The y increment.

panTo

public void panTo(LatLng center)

Changes the center of the map to the given LatLng. If the change is less than both the width and height of the map, the transition will be smoothly animated.

Parameters:

center - The new map center.

panInside

public void panInside(LatLngBounds bounds)

Pans the map to the closest view that would lie inside the given bounds (if it's not already).

Parameters:

bounds - The restricting bounds.

panInside

public void panInside(LatLng latlng)

Pans the map the minimum amount to make the latlng visible. Use padding, paddingTopLeft and paddingTopRight options to fit the display to more restricted bounds, like fitBounds. If latlng is already within the (optionally padded) display bounds, the map will not be panned.

Parameters:

latlng - The location to make visible.

fitBounds

public void fitBounds(LatLngBounds bounds)

Sets a map view that contains the given geographical bounds with the maximum zoom level possible.

Parameters:

bounds - The bounds.

zoom

public void zoom(int delta)

Increments the zoom of the map by delta. A positive value zooms in by that amount, a negative value zooms out.

Parameters:

delta - The amount to increment.

zoomAround

public void zoomAround(LatLng position)

Zooms the map while keeping a specified geographical position on the map stationary.

Parameters:

position - The position to remain stationary.

zoomAround

public void zoomAround(Point offset)

Zooms the map while keeping a specified pixel on the map (relative to the top-left corner) stationary.

Parameters:

offset - The pixel offset.

flyToBounds

public void flyToBounds(LatLngBounds bounds)

locate

public void locate()

Tries to locate the user using the Geolocation API, firing a locationfound event with location data on success or a locationerror event on failure. Note that, if your page doesn't use HTTPS, this method will fail in modern browsers.

locate

public void locate(LocateOptions options)

Tries to locate the user using the Geolocation API, firing a locationfound event with location data on success or a locationerror event on failure, and optionally sets the map view to the user's location with respect to detection accuracy (or to the world view if geolocation failed). Note that, if your page doesn't use HTTPS, this method will fail in modern browsers.

Parameters:

options - The locate options.

stopLocate

public void stopLocate()

Stops watching location previously initiated by map.locate({watch: true}) and aborts resetting the map view if map.locate was called with {setView: true}.