GeoImageLayer (JOSM)

java.lang.Object
- org.openstreetmap.josm.gui.layer.Layer
- - org.openstreetmap.josm.gui.layer.geoimage.GeoImageLayer

All Implemented Interfaces:

PropertyChangeListener, EventListener, ProjectionChangeListener, JumpToMarkerActions.JumpToMarkerLayer, MapViewPaintable, Destroyable
```
public class GeoImageLayer
extends Layer
implements PropertyChangeListener, JumpToMarkerActions.JumpToMarkerLayer
```
Layer displaying geottaged pictures.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`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) List<ImageEntry>`	`data`
`(package private) GpxLayer`	`gpxLayer`
`private Icon`	`icon`
`private MapFrame.MapModeChangeListener`	`mapModeListener`
`private static List<Action>`	`menuAdditions`
`private MouseAdapter`	`mouseAdapter`
`private BufferedImage`	`offscreenBuffer`
`private Icon`	`selectedIcon`
`private static List<MapMode>`	`supportedMapModes`
`(package private) boolean`	`thumbsLoaded`
`private ThumbsLoader`	`thumbsloader`
`private 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, ICON_SIZE, NAME_PROP, OPACITY_PROP, propertyChangeSupport, VISIBLE_PROP

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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(Collection<File> files, GpxLayer gpxLayer)`
`GpxLayer`	`getGpxLayer()` Returns the associated GPX layer.
`Icon`	`getIcon()` Return a representative small image for this layer.
`List<ImageEntry>`	`getImages()` Get list of images in layer.
`Object`	`getInfoComponent()`
`Action[]`	`getMenuEntries()` Returns list of actions.
`ImageEntry`	`getPhotoUnderMouse(MouseEvent evt)` Returns the image that matches the position of the mouse event.
`String`	`getToolTipText()`
`void`	`hookUpMapView()` Initialization code, that depends on Main.map.mapView.
`private String`	`infoText()` Prepare the string that is displayed if layer information is requested.
`boolean`	`isMergable(Layer other)`
`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(Graphics2D g, MapView mv, Bounds bounds)` Paint the dataset using the engine set.
`void`	`propertyChange(PropertyChangeEvent evt)`
`static void`	`registerMenuAddition(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 Dimension`	`scaledDimension(Image thumb)`
`void`	`setUseThumbs(boolean useThumbs)` Enables or disables the display of thumbnails.
`void`	`showFirstPhoto()`
`void`	`showLastPhoto()`
`void`	`showNextPhoto()`
`void`	`showPreviousPhoto()`
`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.Layer
addPropertyChangeListener, checkSaveConditions, createAndOpenSaveFileChooser, destroy, estimateMemoryUsage, fireFilterStateChanged, fireOpacityChanged, fireVisibleChanged, getAssociatedFile, getColor, getName, getOpacity, isBackgroundLayer, isChanged, isInfoResizable, isProjectionSupported, isSavable, isVisible, nameSupportedProjections, 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
  - data
```
List<ImageEntry> data
```
  - gpxLayer
```
GpxLayer gpxLayer
```
  - icon
```
private final Icon icon
```
  - selectedIcon
```
private final Icon selectedIcon
```
  - currentPhoto
```
private int currentPhoto
```
  - useThumbs
```
boolean useThumbs
```
  - thumbsLoaderExecutor
```
private final ExecutorService thumbsLoaderExecutor
```
  - thumbsloader
```
private ThumbsLoader thumbsloader
```
  - thumbsLoaderRunning
```
private boolean thumbsLoaderRunning
```
  - thumbsLoaded
```
volatile boolean thumbsLoaded
```
  - offscreenBuffer
```
private BufferedImage offscreenBuffer
```
  - updateOffscreenBuffer
```
boolean updateOffscreenBuffer
```
  - menuAdditions
```
private static List<Action> menuAdditions
```
  - supportedMapModes
```
private static volatile List<MapMode> supportedMapModes
```
  - mouseAdapter
```
private MouseAdapter mouseAdapter
```
  - mapModeListener
```
private MapFrame.MapModeChangeListener mapModeListener
```
- Constructor Detail
  - GeoImageLayer
```
public GeoImageLayer(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(List<ImageEntry> data,
                     GpxLayer gpxLayer,
                     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(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(List<ImageEntry> data,
                     GpxLayer gpxLayer,
                     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(Collection<File> files,
                          GpxLayer gpxLayer)
```
  - getIcon
```
public 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(Action addition)
```
  - getMenuEntries
```
public 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 String infoText()
```
    Prepare the string that is displayed if layer information is requested.
    
    Returns:
    
    String with layer information
  - getInfoComponent
```
public Object getInfoComponent()
```
    Specified by:
    
    getInfoComponent in class Layer
  - getToolTipText
```
public String getToolTipText()
```
    Specified by:
    
    getToolTipText in class Layer
    
    Returns:
    
    A small tooltip hint about some statistics for this layer.
  - 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 Dimension scaledDimension(Image thumb)
```
  - paint
```
public void paint(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()
```
  - showPreviousPhoto
```
public void showPreviousPhoto()
```
  - showFirstPhoto
```
public void showFirstPhoto()
```
  - showLastPhoto
```
public void showLastPhoto()
```
  - 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(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(PropertyChangeEvent evt)
```
    Specified by:
    
    propertyChange in interface 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 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

Class GeoImageLayer

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

data

gpxLayer

icon

selectedIcon

currentPhoto

useThumbs

thumbsLoaderExecutor

thumbsloader

thumbsLoaderRunning

thumbsLoaded

offscreenBuffer

updateOffscreenBuffer

menuAdditions

supportedMapModes

mouseAdapter

mapModeListener

Constructor Detail

GeoImageLayer

GeoImageLayer

GeoImageLayer

GeoImageLayer

Method Detail

create

getIcon

registerMenuAddition

getMenuEntries

infoText

getInfoComponent

getToolTipText

isMergable

mergeFrom

scaledDimension

paint

visitBoundingBox

showNextPhoto

showPreviousPhoto

showFirstPhoto

showLastPhoto

checkPreviousNextButtons

removeCurrentPhoto

removeCurrentPhotoFromDisk

copyCurrentPhotoPath

removePhotoByIdx

getPhotoUnderMouse

clearCurrentPhoto

clearOtherCurrentPhotos

registerSupportedMapMode

isSupportedMapMode

hookUpMapView

propertyChange

startLoadThumbs

stopLoadThumbs

thumbsLoaded

updateBufferAndRepaint

getImages

getGpxLayer

jumpToNextMarker

jumpToPreviousMarker

isUseThumbs

setUseThumbs