Class OpenProperty

  • All Implemented Interfaces:
    IQuickFix, IQuickFixer, org.eclipse.ui.IMarkerResolution, org.eclipse.ui.IMarkerResolution2

    public class OpenProperty
    extends GotoProperty
    A quick-fix to open the property reference in an editor.
    Author:
    Christopher Mindus
    • Constructor Summary

      Constructors 
      ConstructorDescription
      OpenProperty()
      Constructs the quick-fixer with default constructor for Eclipse.
      OpenProperty​(GProp<?> property)
      Creates a quick-fixer to Open the specified property.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.StringgetDescription()
      Returns optional additional information about the resolution.
      java.lang.StringgetID()
      Gets the ID of the quick-fix.
      java.lang.StringgetLabel()
      Returns a short label indicating what the resolution will do.
      booleanisMarkerRequired()
      Indicates if the label returned and also the description depends on the marker selected.
      • Methods inherited from class org.eclipse.ui.views.markers.WorkbenchMarkerResolution

        run
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • OpenProperty

        public OpenProperty()
        Constructs the quick-fixer with default constructor for Eclipse.
      • OpenProperty

        public OpenProperty​(GProp<?> property)
        Creates a quick-fixer to Open the specified property.
        Parameters:
        property - The property to go to.
    • Method Detail

      • getID

        public java.lang.String getID()
        Gets the ID of the quick-fix.
      • isMarkerRequired

        public boolean isMarkerRequired()
        Indicates if the label returned and also the description depends on the marker selected.
        Specified by:
        isMarkerRequired in interface IQuickFixer
        Overrides:
        isMarkerRequired in class QuickFixAdapter
        Returns:
        true, to be able to use getMarker() to format the label and description.
      • getLabel

        public java.lang.String getLabel()
        Returns a short label indicating what the resolution will do.
        Specified by:
        getLabel in interface org.eclipse.ui.IMarkerResolution
        Specified by:
        getLabel in interface IQuickFixer
        Specified by:
        getLabel in class QuickFixAdapter
        Returns:
        a short label for this resolution
      • getDescription

        public java.lang.String getDescription()
        Returns optional additional information about the resolution. The additional information will be presented to assist the user in deciding if the selected proposal is the desired choice.
        Specified by:
        getDescription in interface org.eclipse.ui.IMarkerResolution2
        Overrides:
        getDescription in class QuickFixAdapter
        Returns:
        the additional information or null