Package ghidra.app.util

Interface ListingHighlightProvider

All Known Implementing Classes:

ListingDiffHighlightProvider

public interface ListingHighlightProvider

Provider of Highlight objects appropriate ListingFields.

Field Summary

Fields

Modifier and Type	Field	Description
static final Highlight[]	NO_HIGHLIGHTS

Method Summary

Modifier and Type	Method	Description
Highlight[]	createHighlights(String text, ListingField field, int cursorTextOffset)	Get the highlights appropriate for the given text

Field Details

NO_HIGHLIGHTS

static final Highlight[] NO_HIGHLIGHTS

Method Details

createHighlights

Highlight[] createHighlights(String text,
 ListingField field,
 int cursorTextOffset)

Get the highlights appropriate for the given text

Parameters:

text - the entire text contained in the field, regardless of layout.

field - the field being rendered. From this field you can get the field factory and the proxy object, which is usually a CodeUnit.

cursorTextOffset - the cursor position within the given text or -1 if no cursor in this field.

Returns:

an array of highlight objects that indicate the location within the text string to be highlighted.