jfxtras.labs.map.tile

Interface TileSource

All Known Implementing Classes:

BingTileSource, DefaultTileSource, LocalTileSource

public interface TileSource

Method Summary

Methods

Modifier and Type	Method and Description
javafx.scene.image.Image	getAttributionImage()
java.lang.String	getAttributionLinkURL()
java.lang.String	getAttributionText(int zoom, Coordinate topLeft, Coordinate botRight)
int	getMaxZoom() Specifies the maximum zoom value.
int	getMinZoom() Specifies the minimum zoom value.
java.lang.String	getName() A tile layer name has to be unique and has to consist only of characters valid for filenames.
java.lang.String	getTermsOfUseURL()
int	getTileSize() Specifies how large each tile is.
java.lang.String	getTileUrl(int zoom, int tilex, int tiley) Constructs the tile url.
boolean	isAttributionRequired()
double	latToTileY(double lat, int zoom)
double	lonToTileX(double lon, int zoom)
double	tileXToLon(int x, int zoom)
double	tileYToLat(int y, int zoom)

Method Detail

getMaxZoom

int getMaxZoom()

Specifies the maximum zoom value. The number of zoom levels is [0.. getMaxZoom()].

Returns:

maximum zoom value that has to be smaller or equal to JMapViewer#MAX_ZOOM

getMinZoom

int getMinZoom()

Specifies the minimum zoom value. This value is usually 0. Only for maps that cover a certain region up to a limited zoom level this method should return a value different than 0.

Returns:

minimum zoom value - usually 0

getName

java.lang.String getName()

A tile layer name has to be unique and has to consist only of characters valid for filenames.

Returns:

Name of the tile layer

getTileUrl

java.lang.String getTileUrl(int zoom,
                          int tilex,
                          int tiley)

Constructs the tile url.

Parameters:

zoom -

tilex -

tiley -

Returns:

fully qualified url for downloading the specified tile image

getTileSize

int getTileSize()

Specifies how large each tile is.

Returns:

The size of a single tile in pixels.

isAttributionRequired

boolean isAttributionRequired()

Returns:

True if the tile source requires attribution in text or image form.

getAttributionText

java.lang.String getAttributionText(int zoom,
                                  Coordinate topLeft,
                                  Coordinate botRight)

Parameters:

zoom - The optional zoom level for the view.

botRight - The bottom right of the bounding box for attribution.

topLeft - The top left of the bounding box for attribution.

Returns:

Attribution text for the image source.

getAttributionImage

javafx.scene.image.Image getAttributionImage()

Returns:

The URL for the attribution image. Null if no image should be displayed.

getAttributionLinkURL

java.lang.String getAttributionLinkURL()

Returns:

The URL to open when the user clicks the attribution image.

getTermsOfUseURL

java.lang.String getTermsOfUseURL()

Returns:

The URL to open when the user clicks the attribution "Terms of Use" text.

latToTileY

double latToTileY(double lat,
                int zoom)

lonToTileX

double lonToTileX(double lon,
                int zoom)

tileYToLat

double tileYToLat(int y,
                int zoom)

tileXToLon

double tileXToLon(int x,
                int zoom)