org.openstreetmap.josm.gui.preferences.plugin

Class PluginPreference

java.lang.Object

org.openstreetmap.josm.gui.preferences.DefaultPreferenceSetting

org.openstreetmap.josm.gui.preferences.DefaultTabPreferenceSetting

org.openstreetmap.josm.gui.preferences.plugin.PluginPreference

All Implemented Interfaces:

PreferenceSetting, TabPreferenceSetting

public final class PluginPreference
extends DefaultTabPreferenceSetting

Preference settings for plugins.

Since:

168

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	PluginPreference.ConfigureSitesAction The action for configuring the plugin download sites
(package private) class	PluginPreference.DownloadAvailablePluginsAction The action for downloading the list of available plugins
static class	PluginPreference.Factory Factory used to create a new PluginPreference.
private static class	PluginPreference.PluginConfigurationSitesPanel
(package private) class	PluginPreference.SearchFieldAdapter Applies the current filter condition in the filter text field to the model
(package private) class	PluginPreference.UpdateSelectedPluginsAction The action for updating the list of selected plugins

Field Summary

Fields

Modifier and Type	Field and Description
private PluginPreferencesModel	model
private boolean	pluginPreferencesActivated is set to true if this preference pane has been selected by the user
private PluginListPanel	pnlPluginPreferences
private PluginUpdatePolicyPanel	pnlPluginUpdatePolicy
private javax.swing.JScrollPane	spPluginPreferences
private JosmTextField	tfFilter

Constructor Summary

Constructors

Modifier	Constructor and Description
private	PluginPreference()

Method Summary

Modifier and Type	Method and Description
void	addGui(PreferenceTabbedPane gui) Add the GUI elements to the dialog.
protected javax.swing.JPanel	buildActionPanel()
protected javax.swing.JTabbedPane	buildContentPane()
static java.lang.String	buildDownloadSummary(PluginDownloadTask task) Returns the download summary string to be shown.
protected javax.swing.JPanel	buildPluginListPanel()
protected javax.swing.JPanel	buildSearchFieldPanel()
private void	configureSites()
private static java.util.Collection<java.lang.String>	getOnlinePluginSites()
java.util.List<PluginInformation>	getPluginsScheduledForUpdateOrDownload() Replies the list of plugins waiting for update or download
static void	notifyDownloadResults(java.awt.Component parent, PluginDownloadTask task) Notifies user about result of a finished plugin download task.
boolean	ok() Called when OK is pressed to save the setting in the preferences file.
void	readLocalPluginInformation() Reads locally available information about plugins from the local file system.

Methods inherited from class org.openstreetmap.josm.gui.preferences.DefaultTabPreferenceSetting

addSubTab, addSubTab, createPreferenceTabWithScrollPane, getDescription, getIconName, getSubTab, getTabPane, getTitle, getTooltip, registerSubTab, selectSubTab

Methods inherited from class org.openstreetmap.josm.gui.preferences.DefaultPreferenceSetting

isExpert

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openstreetmap.josm.gui.preferences.PreferenceSetting

isExpert

Field Detail

tfFilter

private JosmTextField tfFilter

pnlPluginPreferences

private PluginListPanel pnlPluginPreferences

model

private PluginPreferencesModel model

spPluginPreferences

private javax.swing.JScrollPane spPluginPreferences

pnlPluginUpdatePolicy

private PluginUpdatePolicyPanel pnlPluginUpdatePolicy

pluginPreferencesActivated

private boolean pluginPreferencesActivated

is set to true if this preference pane has been selected by the user

Constructor Detail

PluginPreference

private PluginPreference()

Method Detail

buildDownloadSummary

public static java.lang.String buildDownloadSummary(PluginDownloadTask task)

Returns the download summary string to be shown.

Parameters:

task - The plugin download task that has completed

Returns:

the download summary string to be shown. Contains summary of success/failed plugins.

notifyDownloadResults

public static void notifyDownloadResults(java.awt.Component parent,
                                         PluginDownloadTask task)

Notifies user about result of a finished plugin download task.

Parameters:

parent - The parent component

task - The finished plugin download task

Since:

6797

buildSearchFieldPanel

protected javax.swing.JPanel buildSearchFieldPanel()

buildActionPanel

protected javax.swing.JPanel buildActionPanel()

buildPluginListPanel

protected javax.swing.JPanel buildPluginListPanel()

buildContentPane

protected javax.swing.JTabbedPane buildContentPane()

addGui

public void addGui(PreferenceTabbedPane gui)

Description copied from interface: PreferenceSetting

Add the GUI elements to the dialog. The elements should be initialized after the current preferences.

configureSites

private void configureSites()

getPluginsScheduledForUpdateOrDownload

public java.util.List<PluginInformation> getPluginsScheduledForUpdateOrDownload()

Replies the list of plugins waiting for update or download

Returns:

the list of plugins waiting for update or download

ok

public boolean ok()

Description copied from interface: PreferenceSetting

Called when OK is pressed to save the setting in the preferences file. Return true when restart is required.

readLocalPluginInformation

public void readLocalPluginInformation()

Reads locally available information about plugins from the local file system. Scans cached plugin lists from plugin download sites and locally available plugin jar files.

getOnlinePluginSites

private static java.util.Collection<java.lang.String> getOnlinePluginSites()