Class OpenCheatSheetAction

All Implemented Interfaces:
IAction

public final class OpenCheatSheetAction extends Action
Action for opening a cheat sheet. The cheat sheet can be specified either by a cheat sheet id or by a URL of a cheat sheet content file.
Since:
3.0
Restriction:
This class is not intended to be subclassed by clients.
  • Constructor Details

    • OpenCheatSheetAction

      public OpenCheatSheetAction(String id)
      Creates an action that opens the cheat sheet with the given id. The cheat sheet content file is located via the org.eclipse.ui.cheatsheets.cheatSheetContent extension point.
      Parameters:
      id - the cheat sheet id
      Throws:
      IllegalArgumentException - if id is null
    • OpenCheatSheetAction

      public OpenCheatSheetAction(String id, String name, URL url)
      Creates an action that opens the cheat sheet with the given cheat sheet content file.
      Parameters:
      id - the id to give this cheat sheet
      name - the name to give this cheat sheet
      url - URL of the cheat sheet content file
      Throws:
      IllegalArgumentException - if the parameters are null
    • OpenCheatSheetAction

      public OpenCheatSheetAction(String id, String name, String xml, URL baseURL)
      Creates an action that opens a cheat sheet using XML passed in as a string.
      Parameters:
      id - the id to give this cheat sheet
      name - the name to give this cheat sheet
      xml - the cheatsheet content in xml format
      baseURL - is a URL which is only required if the cheat sheet is a composite cheat sheet which has tasks which use path parameters in which case the paths will be relative to baseURL. May be null if this is not a composite cheat sheet
      Throws:
      IllegalArgumentException - if the parameters are null
      Since:
      3.3
  • Method Details

    • run

      public void run()
      Description copied from class: Action
      The default implementation of this IAction method does nothing. Subclasses should override this method if they do not need information from the triggering event, or override runWithEvent(Event) if they do.
      Specified by:
      run in interface IAction
      Overrides:
      run in class Action
      See Also:
    • setTargetShell

      public void setTargetShell(Shell shell)
      Sets the shell in which the cheat sheet is opened. If this is not set, the active shell of the default display is used.
      Parameters:
      shell - The shell in which the cheat sheet is opened.
      Since:
      3.7