org.openstreetmap.josm.actions

Class OpenLocationAction

java.lang.Object

javax.swing.AbstractAction

org.openstreetmap.josm.actions.JosmAction

org.openstreetmap.josm.actions.OpenLocationAction

All Implemented Interfaces:

java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action, Destroyable

Direct Known Subclasses:

OsmLinkPaster.NoWarnOpenLocationAction

public class OpenLocationAction
extends JosmAction

Open an URL input dialog and load data from the given URL.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	OpenLocationAction.WhichTasksToPerformDialog

Nested classes/interfaces inherited from class org.openstreetmap.josm.actions.JosmAction

JosmAction.ActiveLayerChangeAdapter, JosmAction.LayerChangeAdapter, JosmAction.SelectionChangeAdapter

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.lang.Class<? extends DownloadTask>>	downloadTasks
private static BooleanProperty	USE_NEW_LAYER true if the URL needs to be opened in a new layer, false otherwise

Fields inherited from class org.openstreetmap.josm.actions.JosmAction

sc

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors

Constructor and Description
OpenLocationAction() Create an open action.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e)
boolean	addDownloadTaskClass(java.lang.Class<? extends DownloadTask> taskClass) Adds a new download task to the supported ones.
(package private) java.util.Collection<DownloadTask>	askWhichTasksToLoad(java.util.Collection<DownloadTask> tasks) Asks the user which of the possible tasks to perform.
java.util.Collection<DownloadTask>	findDownloadTasks(java.lang.String url, boolean isRemotecontrol) Replies the list of download tasks accepting the given url.
java.lang.String	findSummaryDocumentation() Summarizes acceptable urls for error message purposes.
void	openUrl(boolean newLayer, java.lang.String url) Open the given URL.
boolean	openUrl(java.lang.String url) Open the given URL.
private boolean	realOpenUrl(boolean newLayer, java.lang.String url)
protected void	remindUploadAddressHistory(HistoryComboBox cbHistory) Remind the current history in the preferences
protected void	restoreUploadAddressHistory(HistoryComboBox cbHistory) Restore the current history from the preferences
protected void	warnNoSuitableTasks(java.lang.String url) Displays an error message dialog that no suitable tasks have been found for the given url.

Methods inherited from class org.openstreetmap.josm.actions.JosmAction

destroy, getLayerManager, getShortcut, initEnabledState, installAdapters, listenToLayerChange, listenToSelectionChange, setTooltip, updateEnabledState, updateEnabledState, updateEnabledStateOnCurrentSelection, waitFuture

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

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

Field Detail

USE_NEW_LAYER

private static final BooleanProperty USE_NEW_LAYER

true if the URL needs to be opened in a new layer, false otherwise

downloadTasks

protected final transient java.util.List<java.lang.Class<? extends DownloadTask>> downloadTasks

Constructor Detail

OpenLocationAction

public OpenLocationAction()

Create an open action. The name is "Open a file".

Method Detail

restoreUploadAddressHistory

protected void restoreUploadAddressHistory(HistoryComboBox cbHistory)

Restore the current history from the preferences

Parameters:

cbHistory - the history combo box

remindUploadAddressHistory

protected void remindUploadAddressHistory(HistoryComboBox cbHistory)

Remind the current history in the preferences

Parameters:

cbHistory - the history combo box

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

findDownloadTasks

public java.util.Collection<DownloadTask> findDownloadTasks(java.lang.String url,
                                                            boolean isRemotecontrol)

Replies the list of download tasks accepting the given url.

Parameters:

url - The URL to open

isRemotecontrol - True if download request comes from remotecontrol.

Returns:

The list of download tasks accepting the given url.

Since:

5691

findSummaryDocumentation

public java.lang.String findSummaryDocumentation()

Summarizes acceptable urls for error message purposes.

Returns:

The HTML message to be displayed

Since:

6031

openUrl

public void openUrl(boolean newLayer,
                    java.lang.String url)

Open the given URL.

Parameters:

newLayer - true if the URL needs to be opened in a new layer, false otherwise

url - The URL to open

openUrl

public boolean openUrl(java.lang.String url)

Open the given URL. This class checks the USE_NEW_LAYER preference to check if a new layer should be used.

Parameters:

url - The URL to open

Returns:

true if at least one task was started successfully.

Since:

11279

realOpenUrl

private boolean realOpenUrl(boolean newLayer,
                            java.lang.String url)

askWhichTasksToLoad

java.util.Collection<DownloadTask> askWhichTasksToLoad(java.util.Collection<DownloadTask> tasks)

Asks the user which of the possible tasks to perform.

Parameters:

tasks - a list of possible tasks

Returns:

the selected tasks from the user or an empty list if the dialog has been canceled

warnNoSuitableTasks

protected void warnNoSuitableTasks(java.lang.String url)

Displays an error message dialog that no suitable tasks have been found for the given url.

Parameters:

url - the given url

addDownloadTaskClass

public final boolean addDownloadTaskClass(java.lang.Class<? extends DownloadTask> taskClass)

Adds a new download task to the supported ones.

Parameters:

taskClass - The new download task to add

Returns:

true (as specified by Collection.add(E))