Package ghidra.app.util

Class ToolTipUtils

java.lang.Object

ghidra.app.util.ToolTipUtils

public class ToolTipUtils
extends 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 final int	LINE_LENGTH

Method Summary

Modifier and Type	Method	Description
static String	getFullToolTipText(DataType dataType)	Examines the give dataType and creates a tool tip for it, depending upon its actual class type.
static HTMLDataTypeRepresentation	getHTMLRepresentation(DataType dataType)	Return dataType details as HTML.
static String	getToolTipText(DataType dataType)	Examines the give dataType and creates a tool tip for it, depending upon its actual class type.
static String	getToolTipText(Function function, boolean includeSymbolDetails)	Return an HTML formatted rendering of a function
static 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

Field Details

LINE_LENGTH

public static final int LINE_LENGTH

See Also:

• Constant Field Values

Method Details

getToolTipText

public static String getToolTipText(DataType dataType)

Examines the give dataType 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 String getFullToolTipText(DataType dataType)

Examines the give dataType 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 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 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