Class QuickAccessElement

java.lang.Object
org.eclipse.ui.quickaccess.QuickAccessElement

public abstract class QuickAccessElement extends Object
A QuickAccessElement describes one of the possible actions to show in Quick Access.
Since:
3.115
  • Field Details

  • Constructor Details

    • QuickAccessElement

      public QuickAccessElement()
  • Method Details

    • getLabel

      public abstract String getLabel()
      Returns the label to be displayed to the user.
      Returns:
      the label
    • getImageDescriptor

      public abstract ImageDescriptor getImageDescriptor()
      Returns the image descriptor for this element.
      Returns:
      an image descriptor, or null if no image is available
    • getId

      public abstract String getId()
      Returns the id for this element. The id has to be unique within the QuickAccessProvider that provided this element.
      Returns:
      the id
    • execute

      public abstract void execute()
      Executes the associated action for this element.
    • getSortLabel

      public String getSortLabel()
      Return the label to be used for sorting elements.
      Returns:
      the sort label
    • getMatchLabel

      public String getMatchLabel()
      Return the label to be used for matching elements. The match string can contain additional text that should result in a match, but isn't shown in the quick access UI.

      The match label should always be either identical to or a superset of the actual label.

      Returns:
      the match label