Package ghidra.app.util.viewer.field
Class ExecutableTaskStringHandler
- java.lang.Object
-
- ghidra.app.util.viewer.field.ExecutableTaskStringHandler
-
- All Implemented Interfaces:
AnnotatedStringHandler,ExtensionPoint
public class ExecutableTaskStringHandler extends java.lang.Object implements AnnotatedStringHandler
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface ghidra.util.classfinder.ExtensionPoint
ExtensionPoint.Exclude, ExtensionPoint.Util
-
-
Field Summary
-
Fields inherited from interface ghidra.app.util.viewer.field.AnnotatedStringHandler
DUMMY_MOUSE_HANDLER
-
-
Constructor Summary
Constructors Constructor Description ExecutableTaskStringHandler()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AttributedStringcreateAnnotatedString(AttributedString prototypeString, java.lang.String[] text, Program program)Creates anFieldElementbased upon the give array of Strings.java.lang.StringgetDisplayString()Returns the String that represents the GUI presence of this optionjava.lang.StringgetPrototypeString()Returns an example string of how the annotation is usedjava.lang.String[]getSupportedAnnotations()Returns the annotation string names that this AnnotatedStringHandler supports (e.g., "symbol", "address", etc...).booleanhandleMouseClick(java.lang.String[] annotationParts, Navigatable sourceNavigatable, ServiceProvider serviceProvider)A method that is notified when an annotation is clicked.
-
-
-
Method Detail
-
createAnnotatedString
public AttributedString createAnnotatedString(AttributedString prototypeString, java.lang.String[] text, Program program) throws AnnotationException
Description copied from interface:AnnotatedStringHandlerCreates anFieldElementbased 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:
createAnnotatedStringin interfaceAnnotatedStringHandler- Parameters:
prototypeString- The prototypeFieldElementthat dictates the attributes for the newly created string. Implementations may change attributes as needed.text- An array of Strings used to create theFieldElementbeing returned.program- The program with which the returned string is associated.- Returns:
- An
AnnotatedTextFieldElementthat will be used to render the given text. - Throws:
AnnotationException- if the given text data does not fit the expected format for the given handler implementation.
-
getDisplayString
public java.lang.String getDisplayString()
Description copied from interface:AnnotatedStringHandlerReturns the String that represents the GUI presence of this option- Specified by:
getDisplayStringin interfaceAnnotatedStringHandler- Returns:
- the String to display in GUI components.
-
getPrototypeString
public java.lang.String getPrototypeString()
Description copied from interface:AnnotatedStringHandlerReturns an example string of how the annotation is used- Specified by:
getPrototypeStringin interfaceAnnotatedStringHandler- Returns:
- the example of how this is used.
-
getSupportedAnnotations
public java.lang.String[] getSupportedAnnotations()
Description copied from interface:AnnotatedStringHandlerReturns the annotation string names that this AnnotatedStringHandler supports (e.g., "symbol", "address", etc...).- Specified by:
getSupportedAnnotationsin interfaceAnnotatedStringHandler- 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:AnnotatedStringHandlerA 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:
handleMouseClickin interfaceAnnotatedStringHandler- Parameters:
annotationParts- The constituent parts of the annotationsourceNavigatable- 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.
-
-