Class OpenCheatSheetFromHelpAction

java.lang.Object
org.eclipse.ui.cheatsheets.OpenCheatSheetFromHelpAction
All Implemented Interfaces:
Runnable, ILiveHelpAction

public final class OpenCheatSheetFromHelpAction extends Object implements ILiveHelpAction
Live help action for launching a cheat sheet from a help book.

The initialization string passed to setInitializationString(String) is the id of a cheat sheet contributed to the cheatsheetContent extension point.

Since:
3.0
  • Constructor Details

    • OpenCheatSheetFromHelpAction

      public OpenCheatSheetFromHelpAction()
      Creates a new live help action.
  • Method Details

    • setInitializationString

      public void setInitializationString(String data)
      Description copied from interface: ILiveHelpAction
      This method will be called upon instantiation of the live help extension. The data will be passed as specified in the help document live help link.
      Specified by:
      setInitializationString in interface ILiveHelpAction
      Parameters:
      data - - initialization data as a String
    • run

      public void run()
      Specified by:
      run in interface Runnable