Package ghidra.app.util
Class ToolTipUtils
- java.lang.Object
-
- ghidra.app.util.ToolTipUtils
-
public class ToolTipUtils extends java.lang.Object
A utility class that creates tool tip text for given data types.- Since:
- Tracker Id 616
-
-
Field Summary
Fields Modifier and Type Field Description static int
LINE_LENGTH
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static java.lang.String
getFullToolTipText(DataType dataType)
Examines the givedataType
and creates a tool tip for it, depending upon its actual class type.static HTMLDataTypeRepresentation
getHTMLRepresentation(DataType dataType)
Return dataType details as HTML.static java.lang.String
getToolTipText(DataType dataType)
Examines the givedataType
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 functionstatic java.lang.String
getToolTipText(ExternalLocation extLoc, boolean includeSymbolDetails)
Return an HTML formatted rendering of an external location/function.
-
-
-
Field Detail
-
LINE_LENGTH
public static final int LINE_LENGTH
- See Also:
- Constant Field Values
-
-
Method Detail
-
getToolTipText
public static java.lang.String getToolTipText(DataType dataType)
Examines the givedataType
and creates a tool tip for it, depending upon its actual class type.Note: the text returned here will be truncated as needed for the type of data. To get the full tool tip text, use
getFullToolTipText(DataType)
.- Parameters:
dataType
- The data type from which a tool tip will be created.- Returns:
- tool tip text for the given data type.
-
getFullToolTipText
public static java.lang.String getFullToolTipText(DataType dataType)
Examines the givedataType
and creates a tool tip for it, depending upon its actual class type.Note: the text returned here will not be truncated. This can result in tool tip windows that are too large to fit in the screen. For truncated tool tip text, use
getToolTipText(DataType)
.- 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
- the dataType to be represented- 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 locationincludeSymbolDetails
- 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 functionincludeSymbolDetails
- true to include details of the symbol- Returns:
- tool tip text for the given function
-
-