org.openstreetmap.gui.jmapviewer.interfaces

Interface Attributed

All Known Subinterfaces:

TileSource

All Known Implementing Classes:

AbstractMapQuestTileSource, AbstractOsmTileSource, AbstractTileSource, AbstractTMSTileSource, BingAerialTileSource, MapQuestOpenAerialTileSource, MapQuestOsmTileSource, OsmTileSource.CycleMap, OsmTileSource.Mapnik, ScanexTileSource, TemplatedTMSTileSource, TMSTileSource

public interface Attributed

Method Summary

Modifier and Type	Method and Description
java.awt.Image	getAttributionImage()
java.lang.String	getAttributionImageURL()
java.lang.String	getAttributionLinkURL()
java.lang.String	getAttributionText(int zoom, Coordinate topLeft, Coordinate botRight)
java.lang.String	getTermsOfUseText()
java.lang.String	getTermsOfUseURL()
boolean	requiresAttribution()

Method Detail

requiresAttribution

boolean requiresAttribution()

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.

getAttributionLinkURL

java.lang.String getAttributionLinkURL()

Returns:

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

getAttributionImage

java.awt.Image getAttributionImage()

Returns:

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

getAttributionImageURL

java.lang.String getAttributionImageURL()

Returns:

The URL to open when the user clicks the attribution image. When return value is null, the image is still displayed (provided getAttributionImage() returns a value other than null), but the image does not link to a website.

getTermsOfUseText

java.lang.String getTermsOfUseText()

Returns:

The attribution "Terms of Use" text. In case it returns null, but getTermsOfUseURL() is not null, a default terms of use text is used.

getTermsOfUseURL

java.lang.String getTermsOfUseURL()

Returns:

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