org.openstreetmap.josm.gui.layer.geoimage

Class GeoImageLayer

java.lang.Object

org.openstreetmap.josm.gui.layer.Layer

org.openstreetmap.josm.gui.layer.AbstractModifiableLayer

org.openstreetmap.josm.gui.layer.geoimage.GeoImageLayer

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.util.EventListener, ProjectionChangeListener, JumpToMarkerActions.JumpToMarkerLayer, MapViewPaintable, SaveToFile, UploadToServer, Destroyable

public class GeoImageLayer
extends AbstractModifiableLayer
implements java.beans.PropertyChangeListener, JumpToMarkerActions.JumpToMarkerLayer

Layer displaying geottaged pictures.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	GeoImageLayer.Loader Loads a set of images, while displaying a dialog that indicates what the plugin is currently doing.

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 int	currentPhoto
(package private) java.util.List<ImageEntry>	data
(package private) GpxLayer	gpxLayer
private javax.swing.Icon	icon
private MapFrame.MapModeChangeListener	mapModeListener
private static java.util.List<javax.swing.Action>	menuAdditions
private java.awt.event.MouseAdapter	mouseAdapter
private java.awt.image.BufferedImage	offscreenBuffer
private javax.swing.Icon	selectedIcon
private static java.util.List<MapMode>	supportedMapModes
(package private) boolean	thumbsLoaded
private ThumbsLoader	thumbsloader
private java.util.concurrent.ExecutorService	thumbsLoaderExecutor
private boolean	thumbsLoaderRunning
(package private) boolean	updateOffscreenBuffer
(package private) boolean	useThumbs

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

FILTER_STATE_PROP, NAME_PROP, OPACITY_PROP, propertyChangeSupport, VISIBLE_PROP

Constructor Summary

Constructors

Constructor and Description
GeoImageLayer(java.util.List<ImageEntry> data, GpxLayer gpxLayer) Constructs a new GeoImageLayer.
GeoImageLayer(java.util.List<ImageEntry> data, GpxLayer gpxLayer, boolean useThumbs) Constructs a new GeoImageLayer.
GeoImageLayer(java.util.List<ImageEntry> data, GpxLayer gpxLayer, java.lang.String name) Constructs a new GeoImageLayer.
GeoImageLayer(java.util.List<ImageEntry> data, GpxLayer gpxLayer, java.lang.String name, boolean useThumbs) Constructs a new GeoImageLayer.

Method Summary

Modifier and Type	Method and Description
void	checkPreviousNextButtons()
void	clearCurrentPhoto(boolean repaint) Clears the currentPhoto, i.e.
private void	clearOtherCurrentPhotos() Clears the currentPhoto of the other GeoImageLayer's.
void	copyCurrentPhotoPath()
static void	create(java.util.Collection<java.io.File> files, GpxLayer gpxLayer)
GpxLayer	getGpxLayer() Returns the associated GPX layer.
javax.swing.Icon	getIcon() Return a representative small image for this layer.
java.util.List<ImageEntry>	getImages() Get list of images in layer.
java.lang.Object	getInfoComponent()
javax.swing.Action[]	getMenuEntries() Returns list of actions.
ImageEntry	getPhotoUnderMouse(java.awt.event.MouseEvent evt) Returns the image that matches the position of the mouse event.
java.lang.String	getToolTipText()
void	hookUpMapView() Initialization code, that depends on Main.map.mapView.
private java.lang.String	infoText() Prepare the string that is displayed if layer information is requested.
boolean	isMergable(Layer other)
boolean	isModified() Determines if data managed by this layer has been modified.
private static boolean	isSupportedMapMode(MapMode mapMode) Determines if the functionality of this layer is available in the specified map mode.
boolean	isUseThumbs() Returns the current thumbnail display status.
void	jumpToNextMarker()
void	jumpToPreviousMarker()
void	mergeFrom(Layer from) Merges the given layer into this layer.
void	paint(java.awt.Graphics2D g, MapView mv, Bounds bounds) Paint the dataset using the engine set.
void	propertyChange(java.beans.PropertyChangeEvent evt)
static void	registerMenuAddition(javax.swing.Action addition)
static void	registerSupportedMapMode(MapMode mapMode) Registers a map mode for which the functionality of this layer should be available.
void	removeCurrentPhoto()
void	removeCurrentPhotoFromDisk()
void	removePhotoByIdx(int idx) Removes a photo from the list of images by index.
private static java.awt.Dimension	scaledDimension(java.awt.Image thumb)
void	setUseThumbs(boolean useThumbs) Enables or disables the display of thumbnails.
void	showFirstPhoto() Shows first photo.
void	showLastPhoto() Shows last photo.
void	showNextPhoto() Shows next photo.
void	showPreviousPhoto() Shows previous photo.
void	startLoadThumbs() Start to load thumbnails.
void	stopLoadThumbs() Stop to load thumbnails.
void	thumbsLoaded() Called to signal that the loading of thumbnails has finished.
void	updateBufferAndRepaint()
void	visitBoundingBox(BoundingXYVisitor v)

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

createUploadTask, getUploadDialog, isUploadable, isUploadDiscouraged, onPostSaveToFile, onPostUploadToServer, requiresSaveToFile, requiresUploadToServer

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

addPropertyChangeListener, checkSaveConditions, createAndOpenSaveFileChooser, destroy, estimateMemoryUsage, fireFilterStateChanged, fireOpacityChanged, fireVisibleChanged, getAssociatedFile, getColor, getName, getOpacity, isBackgroundLayer, isChanged, isInfoResizable, isProjectionSupported, isRenamed, isSavable, isVisible, nameSupportedProjections, onPostLoadFromFile, projectionChanged, removePropertyChangeListener, rename, 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

Methods inherited from interface org.openstreetmap.josm.gui.layer.SaveToFile

isSavable

Field Detail

menuAdditions

private static java.util.List<javax.swing.Action> menuAdditions

supportedMapModes

private static volatile java.util.List<MapMode> supportedMapModes

data

java.util.List<ImageEntry> data

gpxLayer

GpxLayer gpxLayer

icon

private final javax.swing.Icon icon

selectedIcon

private final javax.swing.Icon selectedIcon

currentPhoto

private int currentPhoto

useThumbs

boolean useThumbs

thumbsLoaderExecutor

private final java.util.concurrent.ExecutorService thumbsLoaderExecutor

thumbsloader

private ThumbsLoader thumbsloader

thumbsLoaderRunning

private boolean thumbsLoaderRunning

thumbsLoaded

volatile boolean thumbsLoaded

offscreenBuffer

private java.awt.image.BufferedImage offscreenBuffer

updateOffscreenBuffer

boolean updateOffscreenBuffer

mouseAdapter

private java.awt.event.MouseAdapter mouseAdapter

mapModeListener

private MapFrame.MapModeChangeListener mapModeListener

Constructor Detail

GeoImageLayer

public GeoImageLayer(java.util.List<ImageEntry> data,
                     GpxLayer gpxLayer)

Constructs a new GeoImageLayer.

Parameters:

data - The list of images to display

gpxLayer - The associated GPX layer

GeoImageLayer

public GeoImageLayer(java.util.List<ImageEntry> data,
                     GpxLayer gpxLayer,
                     java.lang.String name)

Constructs a new GeoImageLayer.

Parameters:

data - The list of images to display

gpxLayer - The associated GPX layer

name - Layer name

Since:

6392

GeoImageLayer

public GeoImageLayer(java.util.List<ImageEntry> data,
                     GpxLayer gpxLayer,
                     boolean useThumbs)

Constructs a new GeoImageLayer.

Parameters:

data - The list of images to display

gpxLayer - The associated GPX layer

useThumbs - Thumbnail display flag

Since:

6392

GeoImageLayer

public GeoImageLayer(java.util.List<ImageEntry> data,
                     GpxLayer gpxLayer,
                     java.lang.String name,
                     boolean useThumbs)

Constructs a new GeoImageLayer.

Parameters:

data - The list of images to display

gpxLayer - The associated GPX layer

name - Layer name

useThumbs - Thumbnail display flag

Since:

6392

Method Detail

create

public static void create(java.util.Collection<java.io.File> files,
                          GpxLayer gpxLayer)

getIcon

public javax.swing.Icon getIcon()

Description copied from class: Layer

Return a representative small image for this layer. The image must not be larger than 64 pixel in any dimension.

Specified by:

getIcon in class Layer

Returns:

layer icon

registerMenuAddition

public static void registerMenuAddition(javax.swing.Action addition)

getMenuEntries

public javax.swing.Action[] getMenuEntries()

Description copied from class: Layer

Returns list of actions. Action can implement LayerAction interface when it needs to be represented by other menu component than JMenuItem or when it supports multiple layers. Actions that support multiple layers should also have correct equals implementation. Use Layer.SeparatorLayerAction.INSTANCE instead of new JSeparator

Specified by:

getMenuEntries in class Layer

Returns:

menu actions for this layer

infoText

private java.lang.String infoText()

Prepare the string that is displayed if layer information is requested.

Returns:

String with layer information

getInfoComponent

public java.lang.Object getInfoComponent()

Specified by:

getInfoComponent in class Layer

getToolTipText

public java.lang.String getToolTipText()

Specified by:

getToolTipText in class Layer

Returns:

A small tooltip hint about some statistics for this layer.

isModified

public boolean isModified()

Determines if data managed by this layer has been modified. That is the case if one image has modified GPS data.

Specified by:

isModified in class AbstractModifiableLayer

Returns:

true if data has been modified; false, otherwise

isMergable

public boolean isMergable(Layer other)

Specified by:

isMergable in class Layer

Parameters:

other - The other layer that is tested to be mergable with this.

Returns:

Whether the other layer can be merged into this layer.

mergeFrom

public void mergeFrom(Layer from)

Description copied from class: Layer

Merges the given layer into this layer. Throws if the layer types are incompatible.

Specified by:

mergeFrom in class Layer

Parameters:

from - The layer that get merged into this one. After the merge, the other layer is not usable anymore and passing to one others mergeFrom should be one of the last things to do with a layer.

scaledDimension

private static java.awt.Dimension scaledDimension(java.awt.Image thumb)

paint

public void paint(java.awt.Graphics2D g,
                  MapView mv,
                  Bounds bounds)

Description copied from class: Layer

Paint the dataset using the engine set.

Specified by:

paint in interface MapViewPaintable

Specified by:

paint in class Layer

Parameters:

g - Graphics

mv - The object that can translate GeoPoints to screen coordinates.

bounds - Bounding box

visitBoundingBox

public void visitBoundingBox(BoundingXYVisitor v)

Specified by:

visitBoundingBox in class Layer

showNextPhoto

public void showNextPhoto()

Shows next photo.

showPreviousPhoto

public void showPreviousPhoto()

Shows previous photo.

showFirstPhoto

public void showFirstPhoto()

Shows first photo.

showLastPhoto

public void showLastPhoto()

Shows last photo.

checkPreviousNextButtons

public void checkPreviousNextButtons()

removeCurrentPhoto

public void removeCurrentPhoto()

removeCurrentPhotoFromDisk

public void removeCurrentPhotoFromDisk()

copyCurrentPhotoPath

public void copyCurrentPhotoPath()

removePhotoByIdx

public void removePhotoByIdx(int idx)

Removes a photo from the list of images by index.

Parameters:

idx - Image index

Since:

6392

getPhotoUnderMouse

public ImageEntry getPhotoUnderMouse(java.awt.event.MouseEvent evt)

Returns the image that matches the position of the mouse event.

Parameters:

evt - Mouse event

Returns:

Image at mouse position, or null if there is no image at the mouse position

Since:

6392

clearCurrentPhoto

public void clearCurrentPhoto(boolean repaint)

Clears the currentPhoto, i.e. remove select marker, and optionally repaint.

Parameters:

repaint - Repaint flag

Since:

6392

clearOtherCurrentPhotos

private void clearOtherCurrentPhotos()

Clears the currentPhoto of the other GeoImageLayer's. Otherwise there could be multiple selected photos.

registerSupportedMapMode

public static void registerSupportedMapMode(MapMode mapMode)

Registers a map mode for which the functionality of this layer should be available.

Parameters:

mapMode - Map mode to be registered

Since:

6392

isSupportedMapMode

private static boolean isSupportedMapMode(MapMode mapMode)

Determines if the functionality of this layer is available in the specified map mode. SelectAction and LassoModeAction are supported by default, other map modes can be registered.

Parameters:

mapMode - Map mode to be checked

Returns:

true if the map mode is supported, false otherwise

hookUpMapView

public void hookUpMapView()

Description copied from class: Layer

Initialization code, that depends on Main.map.mapView. It is always called in the event dispatching thread. Note that Main.map is null as long as no layer has been added, so do not execute code in the constructor, that assumes Main.map.mapView is not null. Instead override this method. This implementation provides check, if JOSM will be able to use Layer. Layers using a lot of memory, which do know in advance, how much memory they use, should override estimateMemoryUsage method and give a hint. This allows for preemptive warning message for user, instead of failing later on Remember to call super.hookUpMapView() when overriding this method

Overrides:

hookUpMapView in class Layer

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

startLoadThumbs

public void startLoadThumbs()

Start to load thumbnails.

stopLoadThumbs

public void stopLoadThumbs()

Stop to load thumbnails. Can be called at any time to make sure that the thumbnail loader is stopped.

thumbsLoaded

public void thumbsLoaded()

Called to signal that the loading of thumbnails has finished. Usually called from ThumbsLoader in another thread.

updateBufferAndRepaint

public void updateBufferAndRepaint()

getImages

public java.util.List<ImageEntry> getImages()

Get list of images in layer.

Returns:

List of images in layer

getGpxLayer

public GpxLayer getGpxLayer()

Returns the associated GPX layer.

Returns:

The associated GPX layer

jumpToNextMarker

public void jumpToNextMarker()

Specified by:

jumpToNextMarker in interface JumpToMarkerActions.JumpToMarkerLayer

jumpToPreviousMarker

public void jumpToPreviousMarker()

Specified by:

jumpToPreviousMarker in interface JumpToMarkerActions.JumpToMarkerLayer

isUseThumbs

public boolean isUseThumbs()

Returns the current thumbnail display status. true: thumbnails are displayed, false: an icon is displayed instead of thumbnails.

Returns:

Current thumbnail display status

Since:

6392

setUseThumbs

public void setUseThumbs(boolean useThumbs)

Enables or disables the display of thumbnails. Does not update the display.

Parameters:

useThumbs - New thumbnail display status

Since:

6392