Package org.openstreetmap.josm.actions
Class ToggleAction
java.lang.Object
javax.swing.AbstractAction
org.openstreetmap.josm.actions.JosmAction
org.openstreetmap.josm.actions.ToggleAction
- All Implemented Interfaces:
ActionListener,Serializable,Cloneable,EventListener,Action,Destroyable
- Direct Known Subclasses:
ChangesetManagerToggleAction,DialogsToggleAction,ExpertToggleAction,FullscreenToggleAction,OnlineResourceMenu.ToggleOnlineResourceAction,PreferenceToggleAction,TiledRenderToggleAction,ViewportFollowToggleAction,WireframeToggleAction
Abstract class for Toggle Actions.
- Since:
- 6220
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.openstreetmap.josm.actions.JosmAction
JosmAction.ActiveLayerChangeAdapter, JosmAction.LayerChangeAdapter, JosmAction.SelectionChangeAdapter -
Field Summary
FieldsFields inherited from class org.openstreetmap.josm.actions.JosmAction
scFields inherited from class javax.swing.AbstractAction
changeSupport, enabledFields 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
ConstructorsModifierConstructorDescriptionprotectedToggleAction(String name, String iconName, String tooltip, Shortcut shortcut, boolean registerInToolbar) Constructs aToggleAction.protectedToggleAction(String name, ImageProvider icon, String tooltip, Shortcut shortcut, boolean registerInToolbar, String toolbarId, boolean installAdapters) Constructs aToggleAction. -
Method Summary
Modifier and TypeMethodDescriptionfinal voidaddButtonModel(ButtonModel model) Adds a button modelfinal booleanDetermines if this action is currently being selected.protected voidfinal voidremoveButtonModel(ButtonModel model) Removes a button modelprotected final voidsetSelected(boolean selected) protected final voidToggles the selected action state, if needed according to the ActionEvent that triggered the action.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, waitFutureMethods inherited from class javax.swing.AbstractAction
addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabledMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface java.awt.event.ActionListener
actionPerformed
-
Field Details
-
buttonModels
-
-
Constructor Details
-
ToggleAction
protected ToggleAction(String name, ImageProvider icon, String tooltip, Shortcut shortcut, boolean registerInToolbar, String toolbarId, boolean installAdapters) Constructs aToggleAction.- Parameters:
name- the action's text as displayed on the menu (if it is added to a menu)icon- the icon to usetooltip- 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.registerInToolbar- register this action for the toolbar preferences?toolbarId- identifier for the toolbar preferences. The iconName is used, if this parameter is nullinstallAdapters- false, if you don't want to install layer changed and selection changed adapters
-
ToggleAction
protected ToggleAction(String name, String iconName, String tooltip, Shortcut shortcut, boolean registerInToolbar) Constructs aToggleAction.- Parameters:
name- the action's text as displayed on the menu (if it is added to a menu)iconName- the name of icon to usetooltip- 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.registerInToolbar- register this action for the toolbar preferences?
-
-
Method Details
-
setSelected
-
isSelected
Determines if this action is currently being selected.- Returns:
trueif this action is currently being selected,falseotherwise
-
addButtonModel
Adds a button model- Parameters:
model- The button model to add
-
removeButtonModel
Removes a button model- Parameters:
model- The button model to remove
-
notifySelectedState
-
toggleSelectedState
Toggles the selected action state, if needed according to the ActionEvent that triggered the action. This method will do nothing if the action event comes from a Swing component supporting the SELECTED_KEY property because the component already set the selected state. This method needs to be called especially if the action is associated with a keyboard shortcut to ensure correct selected state.- Parameters:
e- ActionEvent that triggered the action- See Also:
-