org.openstreetmap.josm.actions

Class UpdateSelectionAction

java.lang.Object

javax.swing.AbstractAction

org.openstreetmap.josm.actions.JosmAction

org.openstreetmap.josm.actions.UpdateSelectionAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action, Destroyable

Direct Known Subclasses:

UpdateModifiedAction

public class UpdateSelectionAction
extends JosmAction

This action synchronizes a set of primitives with their state on the server.

Since:

1670

See Also:

Serialized Form

Nested Class Summary

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

JosmAction.LayerChangeAdapter, JosmAction.SelectionChangeAdapter

Field Summary

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
UpdateSelectionAction() Constructs a new UpdateSelectionAction.
UpdateSelectionAction(String name, String iconName, String tooltip, Shortcut shortcut, boolean register, String toolbarId) Constructs a new UpdateSelectionAction.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e)
Collection<OsmPrimitive>	getData() Returns the data on which this action operates.
static void	handlePrimitiveGoneException(long id, OsmPrimitiveType type) handle an exception thrown because a primitive was deleted on the server
protected void	updateEnabledState() Override in subclasses to update the enabled state of the action when something in the JOSM state changes, i.e.
protected void	updateEnabledState(Collection<? extends OsmPrimitive> selection) Override in subclasses to update the enabled state of the action if the collection of selected primitives changes.
static void	updatePrimitive(PrimitiveId id) Updates the data for the OsmPrimitives with id id with the data currently kept on the server.
static void	updatePrimitives(Collection<OsmPrimitive> selection) Updates the data for for the OsmPrimitives in selection with the data currently kept on the server.

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

destroy, getCurrentDataSet, getEditLayer, getShortcut, initEnabledState, installAdapters, setTooltip

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

Constructor Detail

UpdateSelectionAction

public UpdateSelectionAction()

Constructs a new UpdateSelectionAction.

UpdateSelectionAction

public UpdateSelectionAction(String name,
                             String iconName,
                             String tooltip,
                             Shortcut shortcut,
                             boolean register,
                             String toolbarId)

Constructs a new UpdateSelectionAction.

Parameters:

name - the action's text as displayed on the menu (if it is added to a menu)

iconName - the filename of the icon to use

tooltip - a longer description of the action that will be displayed in the tooltip. Please note that html is not supported for menu actions on some platforms.

shortcut - a ready-created shortcut object or null if you don't want a shortcut. But you always do want a shortcut, remember you can always register it with group=none, so you won't be assigned a shortcut unless the user configures one. If you pass null here, the user CANNOT configure a shortcut for your action.

register - register this action for the toolbar preferences?

toolbarId - identifier for the toolbar preferences. The iconName is used, if this parameter is null

Method Detail

handlePrimitiveGoneException

public static void handlePrimitiveGoneException(long id,
                                                OsmPrimitiveType type)

handle an exception thrown because a primitive was deleted on the server

Parameters:

id - the primitive id

type - The primitive type. Must be one of NODE, WAY, RELATION

updatePrimitives

public static void updatePrimitives(Collection<OsmPrimitive> selection)

Updates the data for for the OsmPrimitives in selection with the data currently kept on the server.

Parameters:

selection - a collection of OsmPrimitives to update

updatePrimitive

public static void updatePrimitive(PrimitiveId id)

Updates the data for the OsmPrimitives with id id with the data currently kept on the server.

Parameters:

id - the id of a primitive in the DataSet of the current edit layer. Must not be null.

Throws:

IllegalArgumentException - if id is null

IllegalStateException - if there is no primitive with id in the current dataset

IllegalStateException - if there is no current dataset

updateEnabledState

protected void updateEnabledState()

Description copied from class: JosmAction

Override in subclasses to update the enabled state of the action when something in the JOSM state changes, i.e. when a layer is removed or added. See JosmAction.updateEnabledState(Collection) to respond to changes in the collection of selected primitives. Default behavior is empty.

Overrides:

updateEnabledState in class JosmAction

See Also:

JosmAction.updateEnabledState(Collection), JosmAction.initEnabledState()

updateEnabledState

protected void updateEnabledState(Collection<? extends OsmPrimitive> selection)

Description copied from class: JosmAction

Override in subclasses to update the enabled state of the action if the collection of selected primitives changes. This method is called with the new selection.

Overrides:

updateEnabledState in class JosmAction

Parameters:

selection - the collection of selected primitives; may be empty, but not null

See Also:

JosmAction.updateEnabledState(), JosmAction.initEnabledState()

actionPerformed

public void actionPerformed(ActionEvent e)

getData

public Collection<OsmPrimitive> getData()

Returns the data on which this action operates. Override if needed.

Returns:

the data on which this action operates