org.openstreetmap.josm.gui.download

Class DownloadDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

org.openstreetmap.josm.gui.download.DownloadDialog

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class DownloadDialog
extends javax.swing.JDialog

Dialog displayed to the user to download mapping data.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	DownloadDialog.CancelAction Action that is executed when the cancel button is pressed.
(package private) class	DownloadDialog.DownloadAction Action that is executed when the download button is pressed.
private static class	DownloadDialog.DownloadDialogSplitPane A special split pane that acts according to a DownloadSourceSizingPolicy It attempts to size the top tab content correctly.
private class	DownloadDialog.DownloadSourceTabs A special tabbed pane for AbstractDownloadSourcePanels
(package private) class	DownloadDialog.WindowEventHandler

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

javax.swing.JDialog.AccessibleJDialog

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

java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

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

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

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
protected javax.swing.JButton	btnCancel
protected javax.swing.JButton	btnDownload
protected javax.swing.JButton	btnDownloadNewLayer
protected javax.swing.JButton	btnHelp
protected boolean	canceled
protected javax.swing.JCheckBox	cbStartup
protected javax.swing.JCheckBox	cbZoomToDownloadedData
protected Bounds	currentBounds
protected DownloadDialog.DownloadDialogSplitPane	dialogSplit
private static BooleanProperty	DOWNLOAD_AUTORUN
private static StringProperty	DOWNLOAD_SOURCE_TAB
private static IntegerProperty	DOWNLOAD_TAB
private static BooleanProperty	DOWNLOAD_ZOOMTODATA
protected java.util.List<DownloadSelection>	downloadSelections
private static java.util.List<DownloadSource<?>>	downloadSources
private static ListenerList<DownloadSourceListener>	downloadSourcesListeners
protected DownloadDialog.DownloadSourceTabs	downloadSourcesTab
protected ExpertToggleAction.ExpertModeChangeListener	expertListener
private static DownloadDialog	instance the unique instance of the download dialog
protected javax.swing.JPanel	mainPanel
protected SlippyMapChooser	slippyMapChooser
protected javax.swing.JTabbedPane	tpDownloadAreaSelectors

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
DownloadDialog(java.awt.Component parent) Constructs a new DownloadDialog.
DownloadDialog(java.awt.Component parent, java.lang.String helpTopic) Constructs a new DownloadDialog.

Method Summary

Modifier and Type	Method and Description
void	addDownloadAreaSelector(javax.swing.JPanel selector, java.lang.String displayName) Adds a new download area selector to the download dialog.
static <T> void	addDownloadSource(DownloadSource<T> downloadSource) Adds a new download source to the download dialog if it is not added.
protected <T> void	addNewDownloadSourceTab(DownloadSource<T> downloadSource) Adds the download source to the download sources tab.
static void	autostartIfNeeded() Automatically opens the download dialog, if autorun is enabled.
void	boundingBoxChanged(Bounds b, DownloadSelection eventSource) Distributes a "bounding box changed" from one DownloadSelection object to the others, so they may update or clear their input fields.
protected javax.swing.JPanel	buildButtonPanel() Builds the button pane of the dialog.
protected javax.swing.JPanel	buildMainPanel() Builds the main panel of the dialog.
DownloadSettings	getDownloadSettings(boolean newLayer) Gets the global settings of the download dialog.
private javax.swing.event.ChangeListener	getDownloadSourceTabChangeListener() Creates a listener that reacts on tab switches for downloadSourcesTab in order to adjust proper division of the dialog according to user saved preferences or minimal size of the panel.
private ExpertToggleAction.ExpertModeChangeListener	getExpertModeListenerForDownloadSources() Creates listener that removes/adds download sources from/to downloadSourcesTab depending on the current mode.
static DownloadDialog	getInstance() Replies the unique instance of the download dialog
static Bounds	getSavedDownloadBounds() Returns the previously saved bounding box from preferences.
java.util.Optional<Bounds>	getSelectedDownloadArea() Returns an Optional of the currently selected download area.
static boolean	isAutorunEnabled() Determines if the dialog autorun is enabled in preferences.
boolean	isCanceled() Replies true if the dialog was canceled
boolean	isZoomToDownloadedDataRequired() Replies true if the user requires to zoom to new downloaded data
void	refreshTileSources() Refreshes the tile sources.
void	rememberSettings() Remembers the current settings in the download dialog.
void	restoreSettings() Restores the previous settings in the download dialog.
protected void	setCanceled(boolean canceled)
void	setVisible(boolean visible)
void	startDownload() Starts download.
void	startDownload(Bounds b) Starts download for the given bounding box

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, 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

DOWNLOAD_TAB

private static final IntegerProperty DOWNLOAD_TAB

DOWNLOAD_SOURCE_TAB

private static final StringProperty DOWNLOAD_SOURCE_TAB

DOWNLOAD_AUTORUN

private static final BooleanProperty DOWNLOAD_AUTORUN

DOWNLOAD_ZOOMTODATA

private static final BooleanProperty DOWNLOAD_ZOOMTODATA

instance

private static DownloadDialog instance

the unique instance of the download dialog

downloadSourcesListeners

private static final ListenerList<DownloadSourceListener> downloadSourcesListeners

downloadSources

private static final java.util.List<DownloadSource<?>> downloadSources

downloadSelections

protected final transient java.util.List<DownloadSelection> downloadSelections

tpDownloadAreaSelectors

protected final javax.swing.JTabbedPane tpDownloadAreaSelectors

downloadSourcesTab

protected final DownloadDialog.DownloadSourceTabs downloadSourcesTab

cbStartup

protected javax.swing.JCheckBox cbStartup

cbZoomToDownloadedData

protected javax.swing.JCheckBox cbZoomToDownloadedData

slippyMapChooser

protected SlippyMapChooser slippyMapChooser

mainPanel

protected javax.swing.JPanel mainPanel

dialogSplit

protected DownloadDialog.DownloadDialogSplitPane dialogSplit

expertListener

protected final transient ExpertToggleAction.ExpertModeChangeListener expertListener

currentBounds

protected transient Bounds currentBounds

canceled

protected boolean canceled

btnDownload

protected javax.swing.JButton btnDownload

btnDownloadNewLayer

protected javax.swing.JButton btnDownloadNewLayer

btnCancel

protected javax.swing.JButton btnCancel

btnHelp

protected javax.swing.JButton btnHelp

Constructor Detail

DownloadDialog

public DownloadDialog(java.awt.Component parent)

Constructs a new DownloadDialog.

Parameters:

parent - the parent component

DownloadDialog

public DownloadDialog(java.awt.Component parent,
                      java.lang.String helpTopic)

Constructs a new DownloadDialog.

Parameters:

parent - the parent component

helpTopic - the help topic to assign

Method Detail

getInstance

public static DownloadDialog getInstance()

Replies the unique instance of the download dialog

Returns:

the unique instance of the download dialog

buildMainPanel

protected final javax.swing.JPanel buildMainPanel()

Builds the main panel of the dialog.

Returns:

The panel of the dialog.

buildButtonPanel

protected final javax.swing.JPanel buildButtonPanel()

Builds the button pane of the dialog.

Returns:

The button panel of the dialog.

boundingBoxChanged

public void boundingBoxChanged(Bounds b,
                               DownloadSelection eventSource)

Distributes a "bounding box changed" from one DownloadSelection object to the others, so they may update or clear their input fields. Also informs download sources about the change, so they can react on it.

Parameters:

b - new current bounds

eventSource - - the DownloadSelection object that fired this notification.

startDownload

public void startDownload(Bounds b)

Starts download for the given bounding box

Parameters:

b - bounding box to download

startDownload

public void startDownload()

Starts download.

isZoomToDownloadedDataRequired

public boolean isZoomToDownloadedDataRequired()

Replies true if the user requires to zoom to new downloaded data

Returns:

true if the user requires to zoom to new downloaded data

Since:

11658

isAutorunEnabled

public static boolean isAutorunEnabled()

Determines if the dialog autorun is enabled in preferences.

Returns:

true if the download dialog must be open at startup, false otherwise.

addDownloadAreaSelector

public void addDownloadAreaSelector(javax.swing.JPanel selector,
                                    java.lang.String displayName)

Adds a new download area selector to the download dialog.

Parameters:

selector - the download are selector.

displayName - the display name of the selector.

addDownloadSource

public static <T> void addDownloadSource(DownloadSource<T> downloadSource)

Adds a new download source to the download dialog if it is not added.

Type Parameters:

T - The type of the download data.

Parameters:

downloadSource - The download source to be added.

Throws:

JosmRuntimeException - If the download source is already added. Note, download sources are compared by their reference.

Since:

12878

refreshTileSources

public final void refreshTileSources()

Refreshes the tile sources.

Since:

6364

rememberSettings

public void rememberSettings()

Remembers the current settings in the download dialog.

restoreSettings

public void restoreSettings()

Restores the previous settings in the download dialog.

getSavedDownloadBounds

public static Bounds getSavedDownloadBounds()

Returns the previously saved bounding box from preferences.

Returns:

The bounding box saved in preferences if any, null otherwise.

Since:

6509

autostartIfNeeded

public static void autostartIfNeeded()

Automatically opens the download dialog, if autorun is enabled.

See Also:

isAutorunEnabled()

getSelectedDownloadArea

public java.util.Optional<Bounds> getSelectedDownloadArea()

Returns an Optional of the currently selected download area.

Returns:

An Optional of the currently selected download area.

Since:

12574 Return type changed to optional

setVisible

public void setVisible(boolean visible)

Overrides:

setVisible in class java.awt.Dialog

isCanceled

public boolean isCanceled()

Replies true if the dialog was canceled

Returns:

true if the dialog was canceled

getDownloadSettings

public DownloadSettings getDownloadSettings(boolean newLayer)

Gets the global settings of the download dialog.

Parameters:

newLayer - The flag defining if a new layer must be created for the downloaded data.

Returns:

The DownloadSettings object that describes the current state of the download dialog.

setCanceled

protected void setCanceled(boolean canceled)

addNewDownloadSourceTab

protected <T> void addNewDownloadSourceTab(DownloadSource<T> downloadSource)

Adds the download source to the download sources tab.

Type Parameters:

T - The type of the download data.

Parameters:

downloadSource - The download source to be added.

getExpertModeListenerForDownloadSources

private ExpertToggleAction.ExpertModeChangeListener getExpertModeListenerForDownloadSources()

Creates listener that removes/adds download sources from/to downloadSourcesTab depending on the current mode.

Returns:

The expert mode listener.

getDownloadSourceTabChangeListener

private javax.swing.event.ChangeListener getDownloadSourceTabChangeListener()

Creates a listener that reacts on tab switches for downloadSourcesTab in order to adjust proper division of the dialog according to user saved preferences or minimal size of the panel.

Returns:

A listener to adjust dialog division.