org.openstreetmap.josm.gui.layer.geoimage

Class ImageViewerDialog

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.openstreetmap.josm.gui.dialogs.ToggleDialog

org.openstreetmap.josm.gui.layer.geoimage.ImageViewerDialog

All Implemented Interfaces:

java.awt.event.AWTEventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, Preferences.PreferenceChangedListener, Helpful, LayerManager.LayerChangeListener, MainLayerManager.ActiveLayerChangeListener, ShowHideButtonListener, Destroyable

public final class ImageViewerDialog
extends ToggleDialog
implements LayerManager.LayerChangeListener, MainLayerManager.ActiveLayerChangeListener

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	ImageViewerDialog.ImageAction

Nested classes/interfaces inherited from class org.openstreetmap.josm.gui.dialogs.ToggleDialog

ToggleDialog.ButtonHidingType, ToggleDialog.TitleBar, ToggleDialog.ToggleDialogAction

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
private javax.swing.JButton	btnCollapse
private javax.swing.JButton	btnNext
private javax.swing.JButton	btnPrevious
private boolean	centerView
private boolean	collapseButtonClicked
private static java.lang.String	COMMAND_CENTERVIEW
private static java.lang.String	COMMAND_COLLAPSE
private static java.lang.String	COMMAND_COPY_PATH
private static java.lang.String	COMMAND_FIRST
private static java.lang.String	COMMAND_LAST
private static java.lang.String	COMMAND_NEXT
private static java.lang.String	COMMAND_PREVIOUS
private static java.lang.String	COMMAND_REMOVE
private static java.lang.String	COMMAND_REMOVE_FROM_DISK
private static java.lang.String	COMMAND_ZOOM
private ImageEntry	currentEntry
private GeoImageLayer	currentLayer
private static ImageViewerDialog	dialog
private ImageDisplay	imgDisplay
private javax.swing.JToggleButton	tbCentre

Fields inherited from class org.openstreetmap.josm.gui.dialogs.ToggleDialog

button, buttonHiding, detachedDialog, dialogsPanel, isCollapsed, isDocked, isShowing, name, preferenceClass, preferencePrefix, PROP_DYNAMIC_BUTTONS, titleBar, toggleAction, windowMenuItem

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

Modifier	Constructor and Description
private	ImageViewerDialog()

Method Summary

Modifier and Type	Method and Description
void	activeOrEditLayerChanged(MainLayerManager.ActiveLayerChangeEvent e) Called whenever the active or edit layer changed.
protected void	build()
void	destroy() Called when the object has been destroyed.
void	displayImage(GeoImageLayer layer, ImageEntry entry)
protected boolean	dockWhenClosingDetachedDlg() When an image is closed, really close it and do not pop up the side dialog.
static ImageEntry	getCurrentImage() Returns the currently displayed image.
static GeoImageLayer	getCurrentLayer() Returns the layer associated with the image.
static ImageViewerDialog	getInstance() Replies the unique instance of this dialog
boolean	hasImage() Returns whether an image is currently displayed
static boolean	isCenterView() Returns whether the center view is currently active.
void	layerAdded(LayerManager.LayerAddEvent e) Notifies this listener that a layer has been added.
void	layerOrderChanged(LayerManager.LayerOrderChangeEvent e) Notifies this listener that the order of layers was changed.
void	layerRemoving(LayerManager.LayerRemoveEvent e) Notifies this listener that a layer is about to be removed.
(package private) static void	newInstance()
static boolean	setCentreEnabled(boolean value) Enables (or disables) the "Center view" button.
static void	setNextEnabled(boolean value) Enables (or disables) the "Next" button.
static void	setPreviousEnabled(boolean value) Enables (or disables) the "Previous" button.
static void	showImage(GeoImageLayer layer, ImageEntry entry)
private void	showLayer(Layer newLayer)
protected void	stateChanged() primitive stateChangedListener for subclasses

Methods inherited from class org.openstreetmap.josm.gui.dialogs.ToggleDialog

buttonHidden, buttonShown, closeDetachedDialog, collapse, createLayout, createLayout, detach, dock, eventDispatched, expand, getButton, getDefaultDetachedSize, getName, getPreferencePrefix, getPreferredHeight, getToggleAction, helpTopic, hideDialog, hideNotify, isDialogInCollapsedView, isDialogInDefaultView, isDialogShowing, preferenceChanged, registerInWindowMenu, setButton, setContentVisible, setDialogsPanel, setIsButtonHiding, setIsCollapsed, setIsDocked, setIsShowing, setTitle, showDialog, showNotify, toggleButtonHook, toString, unfurlDialog

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, 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

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, 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, 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, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

COMMAND_ZOOM

private static final java.lang.String COMMAND_ZOOM

See Also:

Constant Field Values

COMMAND_CENTERVIEW

private static final java.lang.String COMMAND_CENTERVIEW

See Also:

Constant Field Values

COMMAND_NEXT

private static final java.lang.String COMMAND_NEXT

See Also:

Constant Field Values

COMMAND_REMOVE

private static final java.lang.String COMMAND_REMOVE

See Also:

Constant Field Values

COMMAND_REMOVE_FROM_DISK

private static final java.lang.String COMMAND_REMOVE_FROM_DISK

See Also:

Constant Field Values

COMMAND_PREVIOUS

private static final java.lang.String COMMAND_PREVIOUS

See Also:

Constant Field Values

COMMAND_COLLAPSE

private static final java.lang.String COMMAND_COLLAPSE

See Also:

Constant Field Values

COMMAND_FIRST

private static final java.lang.String COMMAND_FIRST

See Also:

Constant Field Values

COMMAND_LAST

private static final java.lang.String COMMAND_LAST

See Also:

Constant Field Values

COMMAND_COPY_PATH

private static final java.lang.String COMMAND_COPY_PATH

See Also:

Constant Field Values

imgDisplay

private final ImageDisplay imgDisplay

centerView

private boolean centerView

dialog

private static volatile ImageViewerDialog dialog

collapseButtonClicked

private boolean collapseButtonClicked

btnNext

private javax.swing.JButton btnNext

btnPrevious

private javax.swing.JButton btnPrevious

btnCollapse

private javax.swing.JButton btnCollapse

tbCentre

private javax.swing.JToggleButton tbCentre

currentLayer

private transient GeoImageLayer currentLayer

currentEntry

private transient ImageEntry currentEntry

Constructor Detail

ImageViewerDialog

private ImageViewerDialog()

Method Detail

newInstance

static void newInstance()

getInstance

public static ImageViewerDialog getInstance()

Replies the unique instance of this dialog

Returns:

the unique instance

build

protected void build()

destroy

public void destroy()

Description copied from interface: Destroyable

Called when the object has been destroyed.

Specified by:

destroy in interface Destroyable

Overrides:

destroy in class ToggleDialog

showImage

public static void showImage(GeoImageLayer layer,
                             ImageEntry entry)

setPreviousEnabled

public static void setPreviousEnabled(boolean value)

Enables (or disables) the "Previous" button.

Parameters:

value - true to enable the button, false otherwise

setNextEnabled

public static void setNextEnabled(boolean value)

Enables (or disables) the "Next" button.

Parameters:

value - true to enable the button, false otherwise

setCentreEnabled

public static boolean setCentreEnabled(boolean value)

Enables (or disables) the "Center view" button.

Parameters:

value - true to enable the button, false otherwise

Returns:

the old enabled value. Can be used to restore the original enable state

displayImage

public void displayImage(GeoImageLayer layer,
                         ImageEntry entry)

dockWhenClosingDetachedDlg

protected boolean dockWhenClosingDetachedDlg()

When an image is closed, really close it and do not pop up the side dialog.

Overrides:

dockWhenClosingDetachedDlg in class ToggleDialog

stateChanged

protected void stateChanged()

Description copied from class: ToggleDialog

primitive stateChangedListener for subclasses

Overrides:

stateChanged in class ToggleDialog

hasImage

public boolean hasImage()

Returns whether an image is currently displayed

Returns:

If image is currently displayed

getCurrentImage

public static ImageEntry getCurrentImage()

Returns the currently displayed image.

Returns:

Currently displayed image or null

Since:

6392

getCurrentLayer

public static GeoImageLayer getCurrentLayer()

Returns the layer associated with the image.

Returns:

Layer associated with the image

Since:

6392

isCenterView

public static boolean isCenterView()

Returns whether the center view is currently active.

Returns:

true if the center view is active, false otherwise

Since:

9416

layerAdded

public void layerAdded(LayerManager.LayerAddEvent e)

Description copied from interface: LayerManager.LayerChangeListener

Notifies this listener that a layer has been added.

Listeners are called in the EDT thread and you can manipulate the layer manager in the current thread.

Specified by:

layerAdded in interface LayerManager.LayerChangeListener

Parameters:

e - The new added layer event

layerRemoving

public void layerRemoving(LayerManager.LayerRemoveEvent e)

Description copied from interface: LayerManager.LayerChangeListener

Notifies this listener that a layer is about to be removed.

Listeners are called in the EDT thread and you can manipulate the layer manager in the current thread.

Specified by:

layerRemoving in interface LayerManager.LayerChangeListener

Parameters:

e - The layer to be removed (as event)

layerOrderChanged

public void layerOrderChanged(LayerManager.LayerOrderChangeEvent e)

Description copied from interface: LayerManager.LayerChangeListener

Notifies this listener that the order of layers was changed.

Listeners are called in the EDT thread and you can manipulate the layer manager in the current thread.

Specified by:

layerOrderChanged in interface LayerManager.LayerChangeListener

Parameters:

e - The order change event.

activeOrEditLayerChanged

public void activeOrEditLayerChanged(MainLayerManager.ActiveLayerChangeEvent e)

Description copied from interface: MainLayerManager.ActiveLayerChangeListener

Called whenever the active or edit layer changed.

You can be sure that this layer is still contained in this set.

Listeners are called in the EDT thread and you can manipulate the layer manager in the current thread.

Specified by:

activeOrEditLayerChanged in interface MainLayerManager.ActiveLayerChangeListener

Parameters:

e - The change event.

showLayer

private void showLayer(Layer newLayer)