org.openstreetmap.josm.plugins.streetside.gui

## Class StreetsideImageDisplay

- java.lang.Object
- - java.awt.Component
  - - java.awt.Container
    - - javax.swing.JComponent
      - - org.openstreetmap.josm.plugins.streetside.gui.StreetsideImageDisplay

- All Implemented Interfaces:
    ImageObserver, MenuContainer, Serializable

      public class StreetsideImageDisplay
      extends JComponent

  This object is a responsible JComponent which lets you zoom and drag. It is included in a `StreetsideMainDialog` object.
  See Also:
    `StreetsideImageDisplay`, `StreetsideMainDialog`, Serialized Form

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Class and Description
    --- | ---
    `private class` | `StreetsideImageDisplay.ImgDisplayMouseListener`

    - ### Nested classes/interfaces inherited from class javax.swing.JComponent

      `JComponent.AccessibleJComponent`

    - ### Nested classes/interfaces inherited from class java.awt.Container

      `Container.AccessibleAWTContainer`

    - ### Nested classes/interfaces inherited from class java.awt.Component

      `Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy`

  - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `private Collection<ImageDetection>` | `detections`
    `private BufferedImage` | `image` The image currently displayed
    `private Rectangle` | `selectedRect` When a selection is done, the rectangle of the selection (in image coordinates)
    `private static long` | `serialVersionUID`
    `private Rectangle` | `visibleRect` The rectangle (in image coordinates) of the image that is visible.

    - ### Fields inherited from class javax.swing.JComponent

      `listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW`

    - ### Fields inherited from class java.awt.Component

      `accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT`

    - ### Fields inherited from interface java.awt.image.ImageObserver

      `ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `StreetsideImageDisplay()` Main constructor.

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `private Rectangle` | `calculateDrawImageRectangle(Rectangle visibleRect)`
    `private static Rectangle` | `calculateDrawImageRectangle(Rectangle imgRect, Rectangle compRect)` calculateDrawImageRectangle
    `private static void` | `checkVisibleRectPos(Image image, Rectangle visibleRect)`
    `private static void` | `checkVisibleRectSize(Image image, Rectangle visibleRect)`
    `private Point` | `comp2imgCoord(Rectangle visibleRect, int xComp, int yComp)`
    `private static Point` | `getCenterImgCoord(Rectangle visibleRect)`
    `BufferedImage` | `getImage()` Returns the picture that is being displayed
    `private Point` | `img2compCoord(Rectangle visibleRect, int xImg, int yImg)`
    `void` | `paintComponent(Graphics g)` Paints the visible part of the picture.
    `void` | `setImage(BufferedImage image, Collection<ImageDetection> detections)` Sets a new picture to be displayed.
    `void` | `zoomBestFitOrOne()` Zooms to 1:1 and, if it is already in 1:1, to best fit.

    - ### Methods inherited from class javax.swing.JComponent

      `addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI`

    - ### Methods inherited from class java.awt.Container

      `add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree`

    - ### Methods inherited from class java.awt.Component

      `action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Field Detail

    - #### serialVersionUID

          private static final long serialVersionUID

      See Also:
        Constant Field Values

    - #### detections

          private final Collection<ImageDetection> detections

    - #### image

          private volatile BufferedImage image

      The image currently displayed

    - #### visibleRect

          private volatile Rectangle visibleRect

      The rectangle (in image coordinates) of the image that is visible. This rectangle is calculated each time the zoom is modified

    - #### selectedRect

          private Rectangle selectedRect

      When a selection is done, the rectangle of the selection (in image coordinates)

  - ### Constructor Detail

    - #### StreetsideImageDisplay

          public StreetsideImageDisplay()

      Main constructor.

  - ### Method Detail

    - #### setImage

          public void setImage(BufferedImage image,
                               Collection<ImageDetection> detections)

      Sets a new picture to be displayed.
      Parameters:
        `image` - The picture to be displayed.
        `detections` - image detections

    - #### getImage

          public BufferedImage getImage()

      Returns the picture that is being displayed
      Returns:
        The picture that is being displayed.

    - #### paintComponent

          public void paintComponent(Graphics g)

      Paints the visible part of the picture.
      Overrides:
        `paintComponent` in class `JComponent`

    - #### img2compCoord

          private Point img2compCoord(Rectangle visibleRect,
                                      int xImg,
                                      int yImg)

    - #### comp2imgCoord

          private Point comp2imgCoord(Rectangle visibleRect,
                                      int xComp,
                                      int yComp)

    - #### getCenterImgCoord

          private static Point getCenterImgCoord(Rectangle visibleRect)

    - #### calculateDrawImageRectangle

          private Rectangle calculateDrawImageRectangle(Rectangle visibleRect)

    - #### calculateDrawImageRectangle

          private static Rectangle calculateDrawImageRectangle(Rectangle imgRect,
                                                               Rectangle compRect)

      calculateDrawImageRectangle
      Parameters:
        `imgRect` - the part of the image that should be drawn (in image coordinates)
        `compRect` - the part of the component where the image should be drawn (in component coordinates)
      Returns:
        the part of compRect with the same width/height ratio as the image

    - #### zoomBestFitOrOne

          public void zoomBestFitOrOne()

      Zooms to 1:1 and, if it is already in 1:1, to best fit.

    - #### checkVisibleRectPos

          private static void checkVisibleRectPos(Image image,
                                                  Rectangle visibleRect)

    - #### checkVisibleRectSize

          private static void checkVisibleRectSize(Image image,
                                                   Rectangle visibleRect)

JOSM Plugins