Package org.openstreetmap.josm.gui.dialogs.properties

Class HelpAction

  • All Implemented Interfaces:
    java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action
    Direct Known Subclasses:
    HelpMembershipAction, HelpTagAction
    public abstract class HelpAction
extends javax.swing.AbstractAction
    Launch browser with wiki help for selected object.
    Since:
    13521
    See Also:
    Serialized Form

    • Field Summary

      • 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 HelpAction()
      Constructs a new HelpAction.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void actionPerformed​(java.awt.event.ActionEvent e)  
      static void displayGenericHelp()
      Displays the localized Map Features.
      static void displayHelp​(java.util.List<java.lang.String> pages)
      Display help by opening the first existing wiki page in the given list.
      static void displayRelationHelp​(IRelation<?> rel)
      Displays the most specific wiki page for the given relation.
      static void displayTagHelp​(java.lang.String key, java.lang.String val)
      Displays the most specific wiki page for the given key/value.
      static javax.swing.KeyStroke getKeyStroke()
      Returns the keystroke launching this action (F1 by default).

      • 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

    • Constructor Detail

      • HelpAction

        protected HelpAction()
        Constructs a new HelpAction.

    • Method Detail

      • getKeyStroke

        public static javax.swing.KeyStroke getKeyStroke()
        Returns the keystroke launching this action (F1 by default).
        Returns:
        the keystroke launching this action

      • actionPerformed

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

      • displayTagHelp

        public static void displayTagHelp​(java.lang.String key,
                                  java.lang.String val)
        Displays the most specific wiki page for the given key/value.
        Parameters:
        key - Key
        val - Value
        Since:
        14208

      • displayRelationHelp

        public static void displayRelationHelp​(IRelation<?> rel)
        Displays the most specific wiki page for the given relation.
        Parameters:
        rel - Relation
        Since:
        14208

      • displayGenericHelp

        public static void displayGenericHelp()
        Displays the localized Map Features.
        Since:
        14208

      • displayHelp

        public static void displayHelp​(java.util.List<java.lang.String> pages)
        Display help by opening the first existing wiki page in the given list.
        Parameters:
        pages - list of wiki page names to test
        Since:
        14208