Changeset 12460 in josm


Ignore:
Timestamp:
2017-07-09T00:51:45+02:00 (5 months ago)
Author:
bastiK
Message:

see #14794 - javadoc

Location:
trunk/src/org/openstreetmap/josm/gui
Files:
10 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/org/openstreetmap/josm/gui/layer/CustomizeColor.java

    r11097 r12460  
    2727import org.openstreetmap.josm.tools.ImageProvider;
    2828
     29/**
     30 * Action to show a dialog for picking a color.
     31 *
     32 * By calling this action, the user can choose a color to customize the painting
     33 * of a certain {@link GpxLayer} or {@link org.openstreetmap.josm.gui.layer.markerlayer.MarkerLayer}.
     34 */
    2935public class CustomizeColor extends AbstractAction implements LayerAction, MultiLayerAction {
    3036    private final transient List<AbstractProperty<Color>> colors;
  • trunk/src/org/openstreetmap/josm/gui/layer/ImageryLayer.java

    r12093 r12460  
    4343import org.openstreetmap.josm.tools.Utils;
    4444
     45/**
     46 * Abstract base class for background imagery layers ({@link WMSLayer}, {@link TMSLayer}, {@link WMTSLayer}).
     47 *
     48 * Handles some common tasks, like image filters, image processors, etc.
     49 */
    4550public abstract class ImageryLayer extends Layer {
    4651
  • trunk/src/org/openstreetmap/josm/gui/layer/JumpToMarkerActions.java

    r11519 r12460  
    1616import org.openstreetmap.josm.tools.Shortcut;
    1717
     18/**
     19 * Manages actions to jump from one marker to the next for layers that show markers
     20 * ({@link org.openstreetmap.josm.gui.layer.geoimage.GeoImageLayer},
     21 * {@link org.openstreetmap.josm.gui.layer.markerlayer.MarkerLayer}).
     22 *
     23 * Registers global multi-key shortcuts and offers actions for the right-click menu of
     24 * the layers.
     25 */
    1826public final class JumpToMarkerActions {
    1927
     28    /**
     29     * Interface for a layer that displays markers and supports jumping from
     30     * one marker to the next.
     31     */
    2032    public interface JumpToMarkerLayer {
     33        /**
     34         * Jump (move the viewport) to the next marker.
     35         */
    2136        void jumpToNextMarker();
    2237
     38        /**
     39         * Jump (move the viewport) to the previous marker.
     40         */
    2341        void jumpToPreviousMarker();
    2442    }
     
    3149    private static volatile JumpToPreviousMarker jumpToPreviousMarkerAction;
    3250
     51    /**
     52     * Initialize the actions, register shortcuts.
     53     */
    3354    public static void initialize() {
    3455        jumpToNextMarkerAction = new JumpToNextMarker(null);
     
    3859    }
    3960
     61    /**
     62     * Unregister the actions.
     63     */
    4064    public static void unregisterActions() {
    4165        MultikeyActionsHandler.getInstance().removeAction(jumpToNextMarkerAction);
  • trunk/src/org/openstreetmap/josm/gui/layer/geoimage/ImageDisplay.java

    r11539 r12460  
    2929import org.openstreetmap.josm.tools.ExifReader;
    3030
     31/**
     32 * GUI component to display an image (photograph).
     33 *
     34 * Offers basic mouse interaction (zoom, drag) and on-screen text.
     35 */
    3136public class ImageDisplay extends JComponent {
    3237
  • trunk/src/org/openstreetmap/josm/gui/layer/geoimage/ImageViewerDialog.java

    r11452 r12460  
    3636import org.openstreetmap.josm.tools.date.DateUtils;
    3737
     38/**
     39 * Dialog to view and manipulate geo-tagged images from a {@link GeoImageLayer}.
     40 */
    3841public final class ImageViewerDialog extends ToggleDialog implements LayerChangeListener, ActiveLayerChangeListener {
    3942
  • trunk/src/org/openstreetmap/josm/gui/layer/geoimage/ThumbsLoader.java

    r12340 r12460  
    2323import org.openstreetmap.josm.tools.ExifReader;
    2424
     25/**
     26 * Loads thumbnail previews for a list of images from a {@link GeoImageLayer}.
     27 *
     28 * Thumbnails are loaded in the background and cached on disk for the next session.
     29 */
    2530public class ThumbsLoader implements Runnable {
    2631    public static final int maxSize = 120;
  • trunk/src/org/openstreetmap/josm/gui/preferences/DefaultPreferenceSetting.java

    r9665 r12460  
    22package org.openstreetmap.josm.gui.preferences;
    33
     4/**
     5 * Abstract base class for {@link PreferenceSetting} implementations.
     6 *
     7 * Handles the flag that indicates if a PreferenceSetting is and expert option
     8 * or not.
     9 */
    410public abstract class DefaultPreferenceSetting implements PreferenceSetting {
    511
    612    private final boolean isExpert;
    713
     14    /**
     15     * Constructs a new DefaultPreferenceSetting.
     16     *
     17     * (Not an expert option by default.)
     18     */
    819    public DefaultPreferenceSetting() {
    920        this(false);
    1021    }
    1122
     23    /**
     24     * Constructs a new DefaultPreferenceSetting.
     25     *
     26     * @param isExpert true, if it is an expert option
     27     */
    1228    public DefaultPreferenceSetting(boolean isExpert) {
    1329        this.isExpert = isExpert;
  • trunk/src/org/openstreetmap/josm/gui/preferences/DefaultTabPreferenceSetting.java

    r10593 r12460  
    1313import org.openstreetmap.josm.tools.GBC;
    1414
     15/**
     16 * Abstract base class for {@link TabPreferenceSetting} implementations.
     17 *
     18 * Support for common functionality, like icon, title and adding a tab ({@link SubPreferenceSetting}).
     19 */
    1520public abstract class DefaultTabPreferenceSetting extends DefaultPreferenceSetting implements TabPreferenceSetting {
    1621
  • trunk/src/org/openstreetmap/josm/gui/preferences/PreferenceDialog.java

    r10791 r12460  
    3232import org.openstreetmap.josm.tools.WindowGeometry;
    3333
     34/**
     35 * The main preferences dialog.
     36 *
     37 * Dialog window where the user can change various settings. Organized in main
     38 * tabs to the left ({@link TabPreferenceSetting}) and (optional) sub-pages
     39 * ({@link SubPreferenceSetting}).
     40 */
    3441public class PreferenceDialog extends JDialog {
    3542
  • trunk/src/org/openstreetmap/josm/gui/preferences/SourceProvider.java

    r10600 r12460  
    44import java.util.Collection;
    55
     6/**
     7 * Interface for a class that offers a list of {@link SourceEntry}s.
     8 *
     9 * Used by plugins to offer additional SourceEntrys to the user.
     10 */
    611@FunctionalInterface
    712public interface SourceProvider {
    813
     14    /**
     15     * Get the collection of {@link SourceEntry}s.
     16     * @return the collection of {@link SourceEntry}s
     17     */
    918    Collection<SourceEntry> getSources();
    1019}
Note: See TracChangeset for help on using the changeset viewer.