Package org.openstreetmap.josm.actions.audio

Class AbstractAudioAction

java.lang.Object

javax.swing.AbstractAction

org.openstreetmap.josm.actions.JosmAction

org.openstreetmap.josm.actions.audio.AbstractAudioAction

All Implemented Interfaces:

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

Direct Known Subclasses:

AudioBackAction, AudioFastSlowAction, AudioFwdAction, AudioNextAction, AudioPlayPauseAction, AudioPrevAction

public abstract class AbstractAudioAction
extends JosmAction

Base class for every action related to audio content.

Since:

12565

See Also:

Serialized Form

Nested Class Summary

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

JosmAction.ActiveLayerChangeAdapter, 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

Modifier	Constructor	Description
protected	AbstractAudioAction(java.lang.String name, java.lang.String iconName, java.lang.String tooltip, Shortcut shortcut, boolean registerInToolbar)	Constructs a new BaseAudioAction.

Method Summary

Modifier and Type	Method	Description
protected static boolean	isAudioMarkerPresent()	Checks if there is at least one AudioMarker is present in the current layout.
protected boolean	listenToSelectionChange()	Overwrite this if JosmAction.updateEnabledState() should be called when the selection changed.
protected void	updateEnabledState()	Override in subclasses to update the enabled state of the action when something in the JOSM state changes, i.e.

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

buildActiveLayerChangeAdapter, buildLayerChangeAdapter, checkAndConfirmOutlyingOperation, destroy, getLayerManager, getShortcut, initEnabledState, installAdapters, listenToLayerChange, setHelpId, setToolbarId, setTooltip, updateEnabledState, updateEnabledStateOnCurrentSelection, updateEnabledStateOnCurrentSelection, updateEnabledStateOnModifiableSelection, 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

Methods inherited from interface javax.swing.Action

accept

Methods inherited from interface java.awt.event.ActionListener

actionPerformed

Constructor Detail

AbstractAudioAction

protected AbstractAudioAction(java.lang.String name,
                              java.lang.String iconName,
                              java.lang.String tooltip,
                              Shortcut shortcut,
                              boolean registerInToolbar)

Constructs a new BaseAudioAction.

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

shortcut - a ready-created shortcut object or null if you don't want a shortcut

registerInToolbar - register this action for the toolbar preferences?

Method Detail

isAudioMarkerPresent

protected static boolean isAudioMarkerPresent()

Checks if there is at least one AudioMarker is present in the current layout.

Returns:

true if at least one AudioMarker is present in the current layout, false otherwise.

listenToSelectionChange

protected boolean listenToSelectionChange()

Description copied from class: JosmAction

Overwrite this if JosmAction.updateEnabledState() should be called when the selection changed. Default is true.

Overrides:

listenToSelectionChange in class JosmAction

Returns:

true if a DataSelectionListener should be registered.

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(), JosmAction.listenToLayerChange()