org.openstreetmap.josm.gui.download

Class AbstractDownloadSourcePanel<T>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.openstreetmap.josm.gui.download.AbstractDownloadSourcePanel<T>

Type Parameters:

T - The type of the data that a download source uses.

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

OSMDownloadSource.OSMDownloadSourcePanel, OverpassDownloadSource.OverpassDownloadSourcePanel

public abstract class AbstractDownloadSourcePanel<T>
extends JPanel

GUI representation of DownloadSource that is shown to the user in DownloadDialog.

Since:

12652

See Also:

Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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
protected DownloadSource<T>	downloadSource The download source of this panel.
static String	TAB_SPLIT_NAMESPACE A prefix to be used for tab height preferences

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
protected	AbstractDownloadSourcePanel(DownloadSource<T> downloadSource) Called when creating a new AbstractDownloadSourcePanel for the given download source

Method Summary

Modifier and Type	Method and Description
void	boundingBoxChanged(Bounds bbox) Updates GUI components of the panel according to the bbox changes.
void	checkCancel() Performs the logic needed in case if the user triggered the cancel action in DownloadDialog.
abstract boolean	checkDownload(DownloadSettings settings) Performs the logic needed in case if the user triggered the download action in DownloadDialog.
abstract T	getData() Gets the data.
DownloadSource<T>	getDownloadSource() Gets the download source of this panel.
Icon	getIcon() Gets the icon of the download source panel.
abstract String	getSimpleName() Returns a simple name describing this panel.
DownloadSourceSizingPolicy	getSizingPolicy() Gets the policy that defines how this component should be sized
abstract void	rememberSettings() Saves the current user preferences devoted to the data source.
abstract void	restoreSettings() Restores the latest user preferences devoted to the data source.
void	triggerDownload(DownloadSettings downloadSettings) Tells the DownloadSource to start downloading

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, 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

TAB_SPLIT_NAMESPACE

public static final String TAB_SPLIT_NAMESPACE

A prefix to be used for tab height preferences

See Also:

Constant Field Values

downloadSource

protected transient DownloadSource<T> downloadSource

The download source of this panel.

Constructor Detail

AbstractDownloadSourcePanel

protected AbstractDownloadSourcePanel(DownloadSource<T> downloadSource)

Called when creating a new AbstractDownloadSourcePanel for the given download source

Parameters:

downloadSource - The download source this panel is for

Method Detail

getData

public abstract T getData()

Gets the data.

Returns:

Returns the data.

getDownloadSource

public DownloadSource<T> getDownloadSource()

Gets the download source of this panel.

Returns:

Returns the download source of this panel.

rememberSettings

public abstract void rememberSettings()

Saves the current user preferences devoted to the data source.

restoreSettings

public abstract void restoreSettings()

Restores the latest user preferences devoted to the data source.

checkDownload

public abstract boolean checkDownload(DownloadSettings settings)

Performs the logic needed in case if the user triggered the download action in DownloadDialog.

Parameters:

settings - The settings to check.

Returns:

Returns true if the required procedure of handling the download action succeeded and DownloadDialog can be closed, e.g. validation, otherwise false.

checkCancel

public void checkCancel()

Performs the logic needed in case if the user triggered the cancel action in DownloadDialog.

getIcon

public Icon getIcon()

Gets the icon of the download source panel.

Returns:

The icon. Can be null if there is no icon associated with this download source.

boundingBoxChanged

public void boundingBoxChanged(Bounds bbox)

Updates GUI components of the panel according to the bbox changes.

Parameters:

bbox - The new value for the bounding box.

Since:

13498

triggerDownload

public void triggerDownload(DownloadSettings downloadSettings)

Tells the DownloadSource to start downloading

Parameters:

downloadSettings - The download settings

getSimpleName

public abstract String getSimpleName()

Returns a simple name describing this panel. This string can be used from other GUI parts of JOSM to save the user preferences related to the GUI settings. For example, the panel for downloading the OSM data can be named 'downloadosmpanel'. Note, choose the name such that it is unique to avoid collisions with other names.

Returns:

A simple name describing this panel.

getSizingPolicy

public DownloadSourceSizingPolicy getSizingPolicy()

Gets the policy that defines how this component should be sized

Returns:

The sizing policy. A fixed policy on default.

Since:

12705