Class HelpAction

java.lang.Object
org.ka2ddo.yaac.gui.HelpAction
All Implemented Interfaces:
ActionListener, EventListener

public class HelpAction extends Object implements ActionListener
This class implements the basic functionality for launching help from a Help button.
Author:
Andrew Pavlin, KA2DDO
  • Constructor Details

    • HelpAction

      public HelpAction(String helpTag)
      Create a Help ActionListener for a particular static help tag.
      Parameters:
      helpTag - String of help tag
    • HelpAction

      public HelpAction(HasHelpTag tagProvider)
      Create a Help ActionListener for a dynamic help tag.
      Parameters:
      tagProvider - HasHelpTag implementer providing the help tag
  • Method Details

    • createHelpButton

      public static JButton createHelpButton(String helpTag)
      Create a JButton for launching help.
      Parameters:
      helpTag - help tag String for launched help
      Returns:
      a JButton that could launch the help dialog
    • createHelpButton

      public static JButton createHelpButton(HasHelpTag tagProvider)
      Create a JButton for launching help.
      Parameters:
      tagProvider - HasHelpTag implementer that provides a dynamic tag value
      Returns:
      a JButton that could launch the help dialog
    • actionPerformed

      public void actionPerformed(ActionEvent e)
      Respond when the Help button is pushed.
      Specified by:
      actionPerformed in interface ActionListener
      Parameters:
      e - ActionEvent identifying the help button