Package org.openstreetmap.josm.actions

Class PreferenceToggleAction

java.lang.Object

javax.swing.AbstractAction

org.openstreetmap.josm.actions.JosmAction

org.openstreetmap.josm.actions.ToggleAction

org.openstreetmap.josm.actions.PreferenceToggleAction

All Implemented Interfaces:

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

Direct Known Subclasses:

DrawBoundariesOfDownloadedDataAction

public class PreferenceToggleAction
extends ToggleAction
implements PreferenceChangedListener

User action to toggle a custom boolean preference value. A user action will just change a preference value. To take any real action, register another PreferenceChangedListener for the given preference key.

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

Modifier and Type	Field	Description
private javax.swing.JCheckBoxMenuItem	checkbox
private BooleanProperty	pref

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	Description
PreferenceToggleAction(java.lang.String name, java.lang.String tooltip, BooleanProperty pref)	Create a new PreferenceToggleAction.
PreferenceToggleAction(java.lang.String name, ImageProvider icon, java.lang.String tooltip, BooleanProperty pref)	Create a new PreferenceToggleAction.

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(java.awt.event.ActionEvent e)
javax.swing.JCheckBoxMenuItem	getCheckbox()	Get the checkbox that can be used for this action.
void	preferenceChanged(PreferenceChangeEvent e)	Triggered when a preference entry value changes.

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

addButtonModel, isSelected, notifySelectedState, removeButtonModel, setSelected, toggleSelectedState

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

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

Field Detail

checkbox

private final javax.swing.JCheckBoxMenuItem checkbox

pref

private final BooleanProperty pref

Constructor Detail

PreferenceToggleAction

public PreferenceToggleAction(java.lang.String name,
                              java.lang.String tooltip,
                              BooleanProperty pref)

Create a new PreferenceToggleAction.

Parameters:

name - the (translated) title

tooltip - tooltip text

pref - the preference to toggle

PreferenceToggleAction

public PreferenceToggleAction(java.lang.String name,
                              ImageProvider icon,
                              java.lang.String tooltip,
                              BooleanProperty pref)

Create a new PreferenceToggleAction.

Parameters:

name - the (translated) title

icon - icon to display e.g. in menu

tooltip - tooltip text

pref - the preference to toggle

Since:

17021

Method Detail

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

getCheckbox

public javax.swing.JCheckBoxMenuItem getCheckbox()

Get the checkbox that can be used for this action. It can only be used at one place.

Returns:

The checkbox.

preferenceChanged

public void preferenceChanged(PreferenceChangeEvent e)

Description copied from interface: PreferenceChangedListener

Triggered when a preference entry value changes.

Specified by:

preferenceChanged in interface PreferenceChangedListener

Parameters:

e - the preference change event