Context Navigation

Changeset 12460 in josm for trunk/src

Timestamp:

2017-07-09T00:51:45+02:00 (7 years ago)

Author:

bastiK

Message:

see #14794 - javadoc

Location:

trunk/src/org/openstreetmap/josm/gui

Files:

-              r11097
+              r12460
 import org.openstreetmap.josm.tools.ImageProvider;
+/**
+ * Action to show a dialog for picking a color.
+ *
+ * By calling this action, the user can choose a color to customize the painting
+ * of a certain {@link GpxLayer} or {@link org.openstreetmap.josm.gui.layer.markerlayer.MarkerLayer}.
+ */
 public class CustomizeColor extends AbstractAction implements LayerAction, MultiLayerAction {
     private final transient List<AbstractProperty<Color>> colors;

-              r12093
+              r12460
 import org.openstreetmap.josm.tools.Utils;
+/**
+ * Abstract base class for background imagery layers ({@link WMSLayer}, {@link TMSLayer}, {@link WMTSLayer}).
+ *
+ * Handles some common tasks, like image filters, image processors, etc.
+ */
 public abstract class ImageryLayer extends Layer {

-              r11519
+              r12460
 import org.openstreetmap.josm.tools.Shortcut;
+/**
+ * Manages actions to jump from one marker to the next for layers that show markers
+ * ({@link org.openstreetmap.josm.gui.layer.geoimage.GeoImageLayer},
+ * {@link org.openstreetmap.josm.gui.layer.markerlayer.MarkerLayer}).
+ *
+ * Registers global multi-key shortcuts and offers actions for the right-click menu of
+ * the layers.
+ */
 public final class JumpToMarkerActions {
+    /**
+     * Interface for a layer that displays markers and supports jumping from
+     * one marker to the next.
+     */
     public interface JumpToMarkerLayer {
+        /**
+         * Jump (move the viewport) to the next marker.
+         */
         void jumpToNextMarker();
+        /**
+         * Jump (move the viewport) to the previous marker.
+         */
         void jumpToPreviousMarker();
+    }
 …
     private static volatile JumpToPreviousMarker jumpToPreviousMarkerAction;
+    /**
+     * Initialize the actions, register shortcuts.
+     */
     public static void initialize() {
         jumpToNextMarkerAction = new JumpToNextMarker(null);
 …
+    }
+    /**
+     * Unregister the actions.
+     */
     public static void unregisterActions() {
         MultikeyActionsHandler.getInstance().removeAction(jumpToNextMarkerAction);

-              r11539
+              r12460
 import org.openstreetmap.josm.tools.ExifReader;
+/**
+ * GUI component to display an image (photograph).
+ *
+ * Offers basic mouse interaction (zoom, drag) and on-screen text.
+ */
 public class ImageDisplay extends JComponent {

-              r11452
+              r12460
 import org.openstreetmap.josm.tools.date.DateUtils;
+/**
+ * Dialog to view and manipulate geo-tagged images from a {@link GeoImageLayer}.
+ */
 public final class ImageViewerDialog extends ToggleDialog implements LayerChangeListener, ActiveLayerChangeListener {

-              r12340
+              r12460
 import org.openstreetmap.josm.tools.ExifReader;
+/**
+ * Loads thumbnail previews for a list of images from a {@link GeoImageLayer}.
+ *
+ * Thumbnails are loaded in the background and cached on disk for the next session.
+ */
 public class ThumbsLoader implements Runnable {
     public static final int maxSize = 120;

-              r9665
+              r12460
 package org.openstreetmap.josm.gui.preferences;
+/**
+ * Abstract base class for {@link PreferenceSetting} implementations.
+ *
+ * Handles the flag that indicates if a PreferenceSetting is and expert option
+ * or not.
+ */
 public abstract class DefaultPreferenceSetting implements PreferenceSetting {
     private final boolean isExpert;
+    /**
+     * Constructs a new DefaultPreferenceSetting.
+     *
+     * (Not an expert option by default.)
+     */
     public DefaultPreferenceSetting() {
         this(false);
+    }
+    /**
+     * Constructs a new DefaultPreferenceSetting.
+     *
+     * @param isExpert true, if it is an expert option
+     */
     public DefaultPreferenceSetting(boolean isExpert) {
         this.isExpert = isExpert;

-              r10593
+              r12460
 import org.openstreetmap.josm.tools.GBC;
+/**
+ * Abstract base class for {@link TabPreferenceSetting} implementations.
+ *
+ * Support for common functionality, like icon, title and adding a tab ({@link SubPreferenceSetting}).
+ */
 public abstract class DefaultTabPreferenceSetting extends DefaultPreferenceSetting implements TabPreferenceSetting {

-              r10791
+              r12460
 import org.openstreetmap.josm.tools.WindowGeometry;
+/**
+ * The main preferences dialog.
+ *
+ * Dialog window where the user can change various settings. Organized in main
+ * tabs to the left ({@link TabPreferenceSetting}) and (optional) sub-pages
+ * ({@link SubPreferenceSetting}).
+ */
 public class PreferenceDialog extends JDialog {

-              r10600
+              r12460
 import java.util.Collection;
+/**
+ * Interface for a class that offers a list of {@link SourceEntry}s.
+ *
+ * Used by plugins to offer additional SourceEntrys to the user.
+ */
 @FunctionalInterface
 public interface SourceProvider {
+    /**
+     * Get the collection of {@link SourceEntry}s.
+     * @return the collection of {@link SourceEntry}s
+     */
     Collection<SourceEntry> getSources();
+}

Note: See TracChangeset for help on using the changeset viewer.