Package ghidra.app.util

Class ToolTipUtils

  • public class ToolTipUtils
extends java.lang.Object
    A utility class that creates tool tip text for given data types.
    Since:
    Tracker Id 616

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static HTMLDataTypeRepresentation getHTMLRepresentation​(DataType dataType)
      Return dataType details as HTML.
      static java.lang.String getToolTipText​(DataType dataType)
      Examines the give dataType and creates a tool tip for it, depending upon its actual class type.
      static java.lang.String getToolTipText​(Function function, boolean includeSymbolDetails)
      Return an HTML formatted rendering of a function
      static java.lang.String getToolTipText​(ExternalLocation extLoc, boolean includeSymbolDetails)
      Return an HTML formatted rendering of an external location/function.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getToolTipText

        public static java.lang.String getToolTipText​(DataType dataType)
        Examines the give dataType and creates a tool tip for it, depending upon its actual class type.
        Parameters:
        dataType - The data type from which a tool tip will be created.
        Returns:
        tool tip text for the given data type.

      • getHTMLRepresentation

        public static HTMLDataTypeRepresentation getHTMLRepresentation​(DataType dataType)
        Return dataType details as HTML.
        Parameters:
        dataType -
        htmlFragmentOnly - if true only a fragment of HTML, suitable for combining with other fragments will be Returned. If false, the fragment will be enclosed within an HTML tag element.
        Returns:
        dataType details formatted as HTML

      • getToolTipText

        public static java.lang.String getToolTipText​(ExternalLocation extLoc,
                                              boolean includeSymbolDetails)
        Return an HTML formatted rendering of an external location/function.
        Parameters:
        extLoc - the location
        includeSymbolDetails - true to include details of the symbol
        Returns:
        tool tip text for the given external location/function

      • getToolTipText

        public static java.lang.String getToolTipText​(Function function,
                                              boolean includeSymbolDetails)
        Return an HTML formatted rendering of a function
        Parameters:
        function - the function
        includeSymbolDetails - true to include details of the symbol
        Returns:
        tool tip text for the given function