net.java.html.leaflet

Class Rectangle

java.lang.Object

net.java.html.leaflet.ILayer

net.java.html.leaflet.Path

net.java.html.leaflet.PolyLine

net.java.html.leaflet.Polygon

net.java.html.leaflet.Rectangle

public final class Rectangle
extends Polygon

A class for drawing rectangle overlays on a map.

Constructor Summary

Constructors

Constructor and Description
Rectangle(LatLngBounds bounds) Instantiates a rectangle object with the given geographical bounds.
Rectangle(LatLngBounds bounds, PolyLineOptions options) Instantiates a rectangle object with the given geographical bounds and an options object.

Method Summary

Modifier and Type	Method and Description
Rectangle	addLatLng(LatLng latlng) Adds a given point to the rectangle.
Rectangle	addTo(Map map) Adds the layer to the map.
Rectangle	bindPopup(Popup popup) Binds a given popup object to the rectangle.
Rectangle	bindPopup(Popup popup, PopupOptions options) Binds a given popup object with the given options to the rectangle.
Rectangle	bindPopup(String html) Binds a popup with a particular HTML content to a click on this rectangle.
Rectangle	bringToBack() Brings the layer to the bottom of all path layers.
Rectangle	bringToFront() Brings the layer to the top of all path layers.
Rectangle	closePopup() Closes the rectangle's bound popup if it is opened.
Rectangle	openPopup() Opens the popup previously bound by the bindPopup method.
Rectangle	redraw() Redraws the layer.
Rectangle	setBounds(LatLngBounds bounds) Redraws the rectangle with the passed bounds.
Rectangle	setLatLngs(LatLng[] latlngs) Replaces all the points in the rectangle with the given array of geographical points.
Rectangle	setStyle(PathOptions options) Changes the appearance of a Rectangle based on the options in the PathOptions object.
Rectangle	unbindPopup() Unbinds the popup previously bound to the rectangle with bindPopup.

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

getLatLngs, spliceLatLngs

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

Rectangle

public Rectangle(LatLngBounds bounds)

Instantiates a rectangle object with the given geographical bounds.

Parameters:

bounds - geographical bounds

Rectangle

public Rectangle(LatLngBounds bounds,
                 PolyLineOptions options)

Instantiates a rectangle object with the given geographical bounds and an options object.

Parameters:

bounds - geographical bounds

options - configuration options

Method Detail

setBounds

public Rectangle setBounds(LatLngBounds bounds)

Redraws the rectangle with the passed bounds.

Parameters:

bounds - bounds of the rectangle

Returns:

this

addLatLng

public Rectangle addLatLng(LatLng latlng)

Adds a given point to the rectangle.

Overrides:

addLatLng in class Polygon

Parameters:

latlng - point to add

Returns:

this

setLatLngs

public Rectangle setLatLngs(LatLng[] latlngs)

Replaces all the points in the rectangle with the given array of geographical points.

Overrides:

setLatLngs in class Polygon

Parameters:

latlngs - array of points that replace the existing ones

Returns:

this

addTo

public Rectangle addTo(Map map)

Adds the layer to the map.

Overrides:

addTo in class Polygon

Parameters:

map - The map

Returns:

this

setStyle

public Rectangle setStyle(PathOptions options)

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

Overrides:

setStyle in class Polygon

Parameters:

options - path configuration options

Returns:

this

bringToFront

public Rectangle bringToFront()

Brings the layer to the top of all path layers.

Overrides:

bringToFront in class Polygon

Returns:

this

bringToBack

public Rectangle bringToBack()

Brings the layer to the bottom of all path layers.

Overrides:

bringToBack in class Polygon

Returns:

this

redraw

public Rectangle redraw()

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

Overrides:

redraw in class Polygon

Returns:

this

bindPopup

public Rectangle bindPopup(String html)

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

Overrides:

bindPopup in class Polygon

Parameters:

html - poup HTML content

Returns:

this

bindPopup

public Rectangle bindPopup(Popup popup)

Binds a given popup object to the rectangle.

Overrides:

bindPopup in class Polygon

Parameters:

popup - popup object

Returns:

this

bindPopup

public Rectangle bindPopup(Popup popup,
                           PopupOptions options)

Binds a given popup object with the given options to the rectangle.

Overrides:

bindPopup in class Polygon

Parameters:

popup - popup object

options - popup configuration object

Returns:

this

unbindPopup

public Rectangle unbindPopup()

Unbinds the popup previously bound to the rectangle with bindPopup.

Overrides:

unbindPopup in class Polygon

Returns:

this

openPopup

public Rectangle openPopup()

Opens the popup previously bound by the bindPopup method.

Overrides:

openPopup in class Polygon

Returns:

this

closePopup

public Rectangle closePopup()

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

Overrides:

closePopup in class Polygon

Returns:

this