Class ToggleAction

All Implemented Interfaces:
ActionListener, Serializable, Cloneable, EventListener, Action, Destroyable
Direct Known Subclasses:
ChangesetManagerToggleAction, DialogsToggleAction, ExpertToggleAction, FullscreenToggleAction, OnlineResourceMenu.ToggleOnlineResourceAction, PreferenceToggleAction, TiledRenderToggleAction, ViewportFollowToggleAction, WireframeToggleAction

public abstract class ToggleAction extends JosmAction
Abstract class for Toggle Actions.
Since:
6220
See Also:
  • Field Details

  • Constructor Details

    • ToggleAction

      protected ToggleAction(String name, ImageProvider icon, String tooltip, Shortcut shortcut, boolean registerInToolbar, String toolbarId, boolean installAdapters)
      Constructs a ToggleAction.
      Parameters:
      name - the action's text as displayed on the menu (if it is added to a menu)
      icon - 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.
      registerInToolbar - register this action for the toolbar preferences?
      toolbarId - identifier for the toolbar preferences. The iconName is used, if this parameter is null
      installAdapters - 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 a ToggleAction.
      Parameters:
      name - the action's text as displayed on the menu (if it is added to a menu)
      iconName - the name of 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.
      registerInToolbar - register this action for the toolbar preferences?
  • Method Details

    • setSelected

      protected final void setSelected(boolean selected)
    • isSelected

      public final boolean isSelected()
      Determines if this action is currently being selected.
      Returns:
      true if this action is currently being selected, false otherwise
    • addButtonModel

      public final void addButtonModel(ButtonModel model)
      Adds a button model
      Parameters:
      model - The button model to add
    • removeButtonModel

      public final void removeButtonModel(ButtonModel model)
      Removes a button model
      Parameters:
      model - The button model to remove
    • notifySelectedState

      protected void notifySelectedState()
    • toggleSelectedState

      protected final void toggleSelectedState(ActionEvent e)
      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: