org.openstreetmap.josm.gui.oauth

Class AbstractAuthorizationUI

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.openstreetmap.josm.gui.widgets.VerticallyScrollablePanel

org.openstreetmap.josm.gui.oauth.AbstractAuthorizationUI

All Implemented Interfaces:

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

Direct Known Subclasses:

FullyAutomaticAuthorizationUI, ManualAuthorizationUI, SemiAutomaticAuthorizationUI

public abstract class AbstractAuthorizationUI
extends VerticallyScrollablePanel

This is the abstract base class for the three authorisation UIs.

Since:

2746

See Also:

Serialized Form

Nested Class Summary

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
static java.lang.String	ACCESS_TOKEN_PROP The property name for the Access Token property
private OAuthToken	accessToken
private java.lang.String	apiUrl
private AdvancedOAuthPropertiesPanel	pnlAdvancedProperties

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

Constructor and Description
AbstractAuthorizationUI(java.lang.String apiUrl) Constructs a new AbstractAuthorizationUI for the given API URL.

Method Summary

Modifier and Type	Method and Description
protected void	fireAccessTokenChanged(OAuthToken oldValue, OAuthToken newValue)
OAuthToken	getAccessToken() Replies the retrieved Access Token.
protected AdvancedOAuthPropertiesPanel	getAdvancedPropertiesPanel() Replies the panel for entering advanced OAuth parameters (see OAuthParameters)
java.lang.String	getApiUrl() Replies the URL of the OSM API for which this UI is currently trying to retrieve an OAuth Access Token
OAuthParameters	getOAuthParameters() Replies the current set of advanced OAuth parameters in this UI
boolean	hasAccessToken() Replies true if this UI currently has an Access Token
void	initFromPreferences(Preferences pref) Initializes the authorisation UI with preference values in pref.
abstract boolean	isSaveAccessTokenToPreferences() Replies whether the user has chosen to save the Access Token in the JOSM preferences or not.
protected void	setAccessToken(OAuthToken accessToken) Sets the current Access Token.
void	setApiUrl(java.lang.String apiUrl) Sets the URL of the OSM API for which this UI is currently trying to retrieve an OAuth Access Token

Methods inherited from class org.openstreetmap.josm.gui.widgets.VerticallyScrollablePanel

getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getVerticalScrollPane

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

ACCESS_TOKEN_PROP

public static final java.lang.String ACCESS_TOKEN_PROP

The property name for the Access Token property

apiUrl

private java.lang.String apiUrl

pnlAdvancedProperties

private final AdvancedOAuthPropertiesPanel pnlAdvancedProperties

accessToken

private OAuthToken accessToken

Constructor Detail

AbstractAuthorizationUI

public AbstractAuthorizationUI(java.lang.String apiUrl)

Constructs a new AbstractAuthorizationUI for the given API URL.

Parameters:

apiUrl - The OSM API URL

Since:

5422

Method Detail

fireAccessTokenChanged

protected void fireAccessTokenChanged(OAuthToken oldValue,
                                      OAuthToken newValue)

getApiUrl

public java.lang.String getApiUrl()

Replies the URL of the OSM API for which this UI is currently trying to retrieve an OAuth Access Token

Returns:

the API URL

setApiUrl

public void setApiUrl(java.lang.String apiUrl)

Sets the URL of the OSM API for which this UI is currently trying to retrieve an OAuth Access Token

Parameters:

apiUrl - the api URL

getAdvancedPropertiesPanel

protected AdvancedOAuthPropertiesPanel getAdvancedPropertiesPanel()

Replies the panel for entering advanced OAuth parameters (see OAuthParameters)

Returns:

the panel for entering advanced OAuth parameters

See Also:

getOAuthParameters()

getOAuthParameters

public OAuthParameters getOAuthParameters()

Replies the current set of advanced OAuth parameters in this UI

Returns:

the current set of advanced OAuth parameters in this UI

getAccessToken

public OAuthToken getAccessToken()

Replies the retrieved Access Token. null, if no Access Token was retrieved.

Returns:

the retrieved Access Token

setAccessToken

protected void setAccessToken(OAuthToken accessToken)

Sets the current Access Token. This will fire a property change event for ACCESS_TOKEN_PROP if the access token has changed

Parameters:

accessToken - the new access token. null, to clear the current access token

hasAccessToken

public boolean hasAccessToken()

Replies true if this UI currently has an Access Token

Returns:

true if this UI currently has an Access Token

isSaveAccessTokenToPreferences

public abstract boolean isSaveAccessTokenToPreferences()

Replies whether the user has chosen to save the Access Token in the JOSM preferences or not.

Returns:

true if the user has chosen to save the Access Token

initFromPreferences

public void initFromPreferences(Preferences pref)
                         throws java.lang.IllegalArgumentException

Initializes the authorisation UI with preference values in pref.

Parameters:

pref - the preferences. Must not be null.

Throws:

java.lang.IllegalArgumentException - thrown if pref is null