org.openstreetmap.josm.gui.layer

Class TMSLayer

java.lang.Object

org.openstreetmap.josm.gui.layer.Layer

org.openstreetmap.josm.gui.layer.ImageryLayer

org.openstreetmap.josm.gui.layer.AbstractTileSourceLayer

org.openstreetmap.josm.gui.layer.AbstractCachedTileSourceLayer

org.openstreetmap.josm.gui.layer.TMSLayer

All Implemented Interfaces:

ImageObserver, TileLoaderListener, ProjectionChangeListener, MapViewPaintable, NavigatableComponent.ZoomChangeListener, Destroyable

public class TMSLayer
extends AbstractCachedTileSourceLayer

Class that displays a slippy map layer.

Nested Class Summary

Nested classes/interfaces inherited from class org.openstreetmap.josm.gui.layer.AbstractTileSourceLayer

AbstractTileSourceLayer.PrecacheTask

Nested classes/interfaces inherited from class org.openstreetmap.josm.gui.layer.ImageryLayer

ImageryLayer.ApplyOffsetAction, ImageryLayer.GammaImageProcessor, ImageryLayer.OffsetAction

Nested classes/interfaces inherited from class org.openstreetmap.josm.gui.layer.Layer

Layer.LayerAction, Layer.LayerGpxExportAction, Layer.LayerSaveAction, Layer.LayerSaveAsAction, Layer.MultiLayerAction, Layer.SeparatorLayerAction

Field Summary

Fields

Modifier and Type	Field and Description
private static String	CACHE_REGION_NAME
private static String	PREFERENCE_PREFIX
static BooleanProperty	PROP_ADD_TO_SLIPPYMAP_CHOOSER shall TMS layers be added to download dialog
static IntegerProperty	PROP_MAX_ZOOM_LVL maximum zoom level for TMS layer
static IntegerProperty	PROP_MIN_ZOOM_LVL minimum zoom level for TMS layer

Fields inherited from class org.openstreetmap.josm.gui.layer.AbstractCachedTileSourceLayer

MAX_DISK_CACHE_SIZE

Fields inherited from class org.openstreetmap.josm.gui.layer.AbstractTileSourceLayer

autoLoad, autoZoom, currentZoomLevel, MAX_ZOOM, MIN_ZOOM, PROP_DEFAULT_AUTOLOAD, PROP_DEFAULT_AUTOZOOM, PROP_DEFAULT_SHOWERRORS, showErrors, tileCache, tileLoader, tileSource, ZOOM_OFFSET

Fields inherited from class org.openstreetmap.josm.gui.layer.ImageryLayer

dx, dy, gammaImageProcessor, icon, info, PROP_FADE_AMOUNT, PROP_FADE_COLOR, PROP_SHARPEN_LEVEL

Fields inherited from class org.openstreetmap.josm.gui.layer.Layer

FILTER_STATE_PROP, ICON_SIZE, NAME_PROP, OPACITY_PROP, propertyChangeSupport, VISIBLE_PROP

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
TMSLayer(ImageryInfo info) Create a layer based on ImageryInfo

Method Summary

Modifier and Type	Method and Description
static org.apache.commons.jcs.access.CacheAccess<String,BufferedImageCacheEntry>	getCache()
protected String	getCacheName()
protected Class<? extends TileLoader>	getTileLoaderClass()
protected AbstractTMSTileSource	getTileSource(ImageryInfo info) Creates and returns a new TileSource instance depending on the ImageryInfo.ImageryType of the passed ImageryInfo object.
static AbstractTMSTileSource	getTileSourceStatic(ImageryInfo info) Creates and returns a new TileSource instance depending on the ImageryInfo.ImageryType of the passed ImageryInfo object.
static AbstractTMSTileSource	getTileSourceStatic(ImageryInfo info, Runnable attributionLoadedTask) Creates and returns a new TileSource instance depending on the ImageryInfo.ImageryType of the passed ImageryInfo object.
boolean	isProjectionSupported(Projection proj) Adds a context menu to the mapView.
String	nameSupportedProjections() Specify user information about projections

Methods inherited from class org.openstreetmap.josm.gui.layer.AbstractCachedTileSourceLayer

getCache, getDiskCacheSize, getTileLoaderFactory, getTileLoaderFactory, setTileLoaderFactory

Methods inherited from class org.openstreetmap.josm.gui.layer.AbstractTileSourceLayer

checkMaxZoomLvl, checkMinZoomLvl, clearTileCache, createAndOpenSaveFileChooser, decreaseZoomLevel, downloadAreaToCache, estimateMemoryUsage, estimateTileCacheSize, getBestZoom, getHeaders, getMaxZoomLvl, getMaxZoomLvl, getMenuEntries, getMinZoomLvl, getMinZoomLvl, getToolTipText, hookUpMapView, imageUpdate, increaseZoomLevel, initTileSource, isChanged, isSavable, loadAllErrorTiles, loadAllTiles, paint, redraw, setGamma, setMaxZoomLvl, setMinZoomLvl, setOffset, setZoomLevel, tileLoadingFinished, visitBoundingBox, zoomChanged, zoomDecreaseAllowed, zoomIncreaseAllowed

Methods inherited from class org.openstreetmap.josm.gui.layer.ImageryLayer

addImageProcessor, applyImageProcessors, create, createImageProcessor, createSharpener, destroy, displace, drawErrorTile, getDx, getDy, getFadeColor, getFadeColorWithAlpha, getGamma, getIcon, getImageProcessors, getInfo, getInfoComponent, getOffsetMenuItem, getOffsetMenuItem, getPPD, isMergable, mergeFrom, removeImageProcessor

Methods inherited from class org.openstreetmap.josm.gui.layer.Layer

addPropertyChangeListener, checkSaveConditions, fireFilterStateChanged, fireOpacityChanged, fireVisibleChanged, getAssociatedFile, getColor, getName, getOpacity, isBackgroundLayer, isInfoResizable, isVisible, onPostLoadFromFile, projectionChanged, removePropertyChangeListener, setAssociatedFile, setBackgroundLayer, setFilterStateChanged, setName, setOpacity, setVisible, toggleVisible

Methods inherited from class java.lang.Object

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

Field Detail

CACHE_REGION_NAME

private static final String CACHE_REGION_NAME

See Also:

Constant Field Values

PREFERENCE_PREFIX

private static final String PREFERENCE_PREFIX

See Also:

Constant Field Values

PROP_MIN_ZOOM_LVL

public static final IntegerProperty PROP_MIN_ZOOM_LVL

minimum zoom level for TMS layer

PROP_MAX_ZOOM_LVL

public static final IntegerProperty PROP_MAX_ZOOM_LVL

maximum zoom level for TMS layer

PROP_ADD_TO_SLIPPYMAP_CHOOSER

public static final BooleanProperty PROP_ADD_TO_SLIPPYMAP_CHOOSER

shall TMS layers be added to download dialog

Constructor Detail

TMSLayer

public TMSLayer(ImageryInfo info)

Create a layer based on ImageryInfo

Parameters:

info - description of the layer

Method Detail

getTileSource

protected AbstractTMSTileSource getTileSource(ImageryInfo info)
                                       throws IllegalArgumentException

Creates and returns a new TileSource instance depending on the ImageryInfo.ImageryType of the passed ImageryInfo object. If no appropriate TileSource is found, null is returned. Currently supported ImageryType are ImageryInfo.ImageryType.TMS, ImageryInfo.ImageryType.BING, ImageryInfo.ImageryType.SCANEX.

Specified by:

getTileSource in class AbstractTileSourceLayer

Parameters:

info - imagery info

Returns:

a new TileSource instance or null if no TileSource for the ImageryInfo/ImageryType could be found.

Throws:

IllegalArgumentException - if url from imagery info is null or invalid

isProjectionSupported

public final boolean isProjectionSupported(Projection proj)

Adds a context menu to the mapView.

Overrides:

isProjectionSupported in class Layer

Parameters:

proj - projection

Returns:

True if projection is supported for this layer

nameSupportedProjections

public final String nameSupportedProjections()

Description copied from class: Layer

Specify user information about projections

Overrides:

nameSupportedProjections in class Layer

Returns:

User readable text telling about supported projections

getTileSourceStatic

public static AbstractTMSTileSource getTileSourceStatic(ImageryInfo info)
                                                 throws IllegalArgumentException

Creates and returns a new TileSource instance depending on the ImageryInfo.ImageryType of the passed ImageryInfo object. If no appropriate TileSource is found, null is returned. Currently supported ImageryType are ImageryInfo.ImageryType.TMS, ImageryInfo.ImageryType.BING, ImageryInfo.ImageryType.SCANEX.

Parameters:

info - imagery info

Returns:

a new TileSource instance or null if no TileSource for the ImageryInfo/ImageryType could be found.

Throws:

IllegalArgumentException - if url from imagery info is null or invalid

getTileSourceStatic

public static AbstractTMSTileSource getTileSourceStatic(ImageryInfo info,
                                                        Runnable attributionLoadedTask)
                                                 throws IllegalArgumentException

Creates and returns a new TileSource instance depending on the ImageryInfo.ImageryType of the passed ImageryInfo object. If no appropriate TileSource is found, null is returned. Currently supported ImageryType are ImageryInfo.ImageryType.TMS, ImageryInfo.ImageryType.BING, ImageryInfo.ImageryType.SCANEX.

Parameters:

info - imagery info

attributionLoadedTask - task to be run once attribution is loaded, might be null, if nothing special shall happen

Returns:

a new TileSource instance or null if no TileSource for the ImageryInfo/ImageryType could be found.

Throws:

IllegalArgumentException - if url from imagery info is null or invalid

getTileLoaderClass

protected Class<? extends TileLoader> getTileLoaderClass()

Specified by:

getTileLoaderClass in class AbstractCachedTileSourceLayer

getCacheName

protected String getCacheName()

Specified by:

getCacheName in class AbstractCachedTileSourceLayer

getCache

public static org.apache.commons.jcs.access.CacheAccess<String,BufferedImageCacheEntry> getCache()

Returns:

cache for TMS region