001// License: GPL. For details, see LICENSE file. 002package org.openstreetmap.josm.gui.layer.geoimage; 003 004import java.util.Collections; 005import java.util.List; 006 007import org.openstreetmap.josm.data.imagery.street_level.IImageEntry; 008 009/** 010 * An interface for layers which want to show images 011 * @since 18613 012 */ 013public interface IGeoImageLayer { 014 /** 015 * Clear the selection of the layer 016 */ 017 void clearSelection(); 018 019 /** 020 * Get the current selection 021 * @return The currently selected images 022 */ 023 List<? extends IImageEntry<?>> getSelection(); 024 025 /** 026 * Get the invalid geo images for this layer (specifically, those that <i>cannot</i> be displayed on the map) 027 * @return The list of invalid geo images 028 */ 029 default List<IImageEntry<?>> getInvalidGeoImages() { 030 return Collections.emptyList(); 031 } 032 033 /** 034 * Check if the layer contains the specified image 035 * @param imageEntry The entry to look for 036 * @return {@code true} if this layer contains the image 037 */ 038 boolean containsImage(IImageEntry<?> imageEntry); 039 040 /** 041 * Add a listener for when images change 042 * @param listener The listener to call 043 */ 044 void addImageChangeListener(ImageChangeListener listener); 045 046 /** 047 * Remove a listener for when images change 048 * @param listener The listener to remove 049 */ 050 void removeImageChangeListener(ImageChangeListener listener); 051 052 /** 053 * Listen for image changes 054 */ 055 @FunctionalInterface 056 interface ImageChangeListener { 057 /** 058 * Called when the selected image(s) change 059 * @param source The source of the change 060 * @param oldImages The previously selected image(s) 061 * @param newImages The newly selected image(s) 062 */ 063 void imageChanged(IGeoImageLayer source, List<? extends IImageEntry<?>> oldImages, List<? extends IImageEntry<?>> newImages); 064 } 065}