Class SymbolAnnotatedStringHandler

  • All Implemented Interfaces:
    AnnotatedStringHandler, ExtensionPoint

    public class SymbolAnnotatedStringHandler
    extends java.lang.Object
    implements AnnotatedStringHandler
    An annotated string handler that handles annotations that begin with SUPPORTED_ANNOTATIONS. This class expects one string following the annotation text that is the address or a symbol name. The display text will be that of the symbol that is referred to by the address or symbol name.
    • Constructor Detail

      • SymbolAnnotatedStringHandler

        public SymbolAnnotatedStringHandler()
    • Method Detail

      • convertAnnotationSymbolToAddress

        public static java.lang.String convertAnnotationSymbolToAddress​(java.lang.String[] annotationParts,
                                                                        java.lang.String rawText,
                                                                        Program program)
      • createAnnotatedString

        public AttributedString createAnnotatedString​(AttributedString prototypeString,
                                                      java.lang.String[] text,
                                                      Program program)
        Description copied from interface: AnnotatedStringHandler
        Creates an FieldElement based upon the give array of Strings. The first String in the list is expected to be the annotation tag used to create the annotation. At the very least the array is expected to be comprised of two elements, the annotation and some data. Extra data may be provided as needed by implementing classes.
        Specified by:
        createAnnotatedString in interface AnnotatedStringHandler
        Parameters:
        prototypeString - The prototype FieldElement that dictates the attributes for the newly created string. Implementations may change attributes as needed.
        text - An array of Strings used to create the FieldElement being returned.
        program - The program with which the returned string is associated.
        Returns:
        An AnnotatedTextFieldElement that will be used to render the given text.
      • getSupportedAnnotations

        public java.lang.String[] getSupportedAnnotations()
        Description copied from interface: AnnotatedStringHandler
        Returns the annotation string names that this AnnotatedStringHandler supports (e.g., "symbol", "address", etc...).
        Specified by:
        getSupportedAnnotations in interface AnnotatedStringHandler
        Returns:
        the annotation string names that this AnnotatedStringHandler supports.
      • handleMouseClick

        public boolean handleMouseClick​(java.lang.String[] annotationParts,
                                        Navigatable sourceNavigatable,
                                        ServiceProvider serviceProvider)
        Description copied from interface: AnnotatedStringHandler
        A method that is notified when an annotation is clicked. Returns true if this annotation handles the click; return false if this annotation does not do anything with the click.
        Specified by:
        handleMouseClick in interface AnnotatedStringHandler
        Parameters:
        annotationParts - The constituent parts of the annotation
        sourceNavigatable - The location in the program that was clicked.
        serviceProvider - A service provider for needed services.
        Returns:
        true if this annotation handles the click; return false if this annotation does not do anything with the click.