Package ghidra.app.util.viewer.field

Class XRefHeaderFieldFactory

java.lang.Object

ghidra.app.util.viewer.field.FieldFactory

ghidra.app.util.viewer.field.XRefFieldFactory

ghidra.app.util.viewer.field.XRefHeaderFieldFactory

All Implemented Interfaces:

ExtensionPoint

public class XRefHeaderFieldFactory
extends XRefFieldFactory

Field for display XRef headers.

Nested Class Summary

Nested classes/interfaces inherited from class ghidra.app.util.viewer.field.XRefFieldFactory

XRefFieldFactory.SORT_CHOICE

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XREF_FIELD_NAME

Fields inherited from class ghidra.app.util.viewer.field.XRefFieldFactory

delim, displayBlockName, displayLocalNamespace, displayNonLocalNamespace, displayRefType, FIELD_NAME, groupByFunction, localPrefixText, maxXRefs, sortChoice, typeComparator, useLocalPrefixOverride

Fields inherited from class ghidra.app.util.viewer.field.FieldFactory

BASE_LISTING_FONT_ID, baseFont, colorOptionName, enabled, FONT_OPTION_NAME, hlProvider, model, name, startX, style, styleOptionName, width

Constructor Summary

Constructors

Constructor	Description
XRefHeaderFieldFactory()
XRefHeaderFieldFactory(FieldFormatModel model, ListingHighlightProvider hlProvider, Options displayOptions, ToolOptions fieldOptions)	Constructor

Method Summary

Modifier and Type	Method	Description
ListingField	getField(ProxyObj<?> proxy, int varWidth)	Generates a Field based on the given information.
FieldLocation	getFieldLocation(ListingField bf, BigInteger index, int fieldNum, ProgramLocation loc)	Return a FieldLocation that corresponds to the given index, fieldNum, and ProgramLocation IF and ONLY IF the given programLocation is the type generated by this class's FieldFactory.getFieldLocation(ListingField, BigInteger, int, ProgramLocation).
ProgramLocation	getProgramLocation(int row, int col, ListingField bf)	Returns the Program location for the given object, row, col, and groupPath
protected void	initDisplayOptions(Options displayOptions)
FieldFactory	newInstance(FieldFormatModel formatModel, ListingHighlightProvider provider, ToolOptions options, ToolOptions fieldOptions)	Returns a new instance of this FieldFactory that can be used to generate fields instead of being used as a prototype.

Methods inherited from class ghidra.app.util.viewer.field.XRefFieldFactory

acceptsType, createFieldLocation, createRefTypeAttributedString, fieldOptionsChanged, getBlockName, getPrefix, getProgram, getXRefLocation

Methods inherited from class ghidra.app.util.viewer.field.FieldFactory

displayOptionsChanged, getFieldModel, getFieldName, getFieldText, getMetrics, getMetrics, getStartX, getWidth, hasSamePath, initFieldOptions, isEnabled, servicesChanged, setEnabled, setStartX, setWidth, simplifyTemplates, supportsLocation

Methods inherited from class java.lang.Object

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

Field Details

XREF_FIELD_NAME

public static final String XREF_FIELD_NAME

See Also:

• Constant Field Values

Constructor Details

XRefHeaderFieldFactory

public XRefHeaderFieldFactory()

XRefHeaderFieldFactory

public XRefHeaderFieldFactory(FieldFormatModel model,
 ListingHighlightProvider hlProvider,
 Options displayOptions,
 ToolOptions fieldOptions)

Constructor

Parameters:

model - the model that the field belongs to.

hlProvider - the HighlightProvider.

displayOptions - the Options for display properties.

fieldOptions - the Options for field specific properties.

Method Details

initDisplayOptions

protected void initDisplayOptions(Options displayOptions)

Overrides:

initDisplayOptions in class FieldFactory

getField

public ListingField getField(ProxyObj<?> proxy,
 int varWidth)

Description copied from class: FieldFactory

Generates a Field based on the given information.

Overrides:

getField in class XRefFieldFactory

Parameters:

proxy - The object that the generated field will report some information about.

varWidth - the additional distance along the x axis to place the generated field.

Returns:

the newly generated FactoryField that shows some property or information about the given object.

getProgramLocation

public ProgramLocation getProgramLocation(int row,
 int col,
 ListingField bf)

Description copied from class: FieldFactory

Returns the Program location for the given object, row, col, and groupPath

Overrides:

getProgramLocation in class XRefFieldFactory

Parameters:

row - the row within this field

col - the col on the given row within this field.

bf - the ListingField containing the cursor.

Returns:

the location.

getFieldLocation

public FieldLocation getFieldLocation(ListingField bf,
 BigInteger index,
 int fieldNum,
 ProgramLocation loc)

Description copied from class: FieldFactory

Return a FieldLocation that corresponds to the given index, fieldNum, and ProgramLocation IF and ONLY IF the given programLocation is the type generated by this class's FieldFactory.getFieldLocation(ListingField, BigInteger, int, ProgramLocation). Each FieldFactory should generate and process a unique ProgramLocation class.

Overrides:

getFieldLocation in class XRefFieldFactory

Parameters:

bf - the ListingField at the current cursor.

index - the line index (corresponds to an address)

fieldNum - the index of field within the layout to try and get a FieldLocation.

loc - the ProgramLocation to be converted into a FieldLocation.

Returns:

the location.

newInstance

public FieldFactory newInstance(FieldFormatModel formatModel,
 ListingHighlightProvider provider,
 ToolOptions options,
 ToolOptions fieldOptions)

Description copied from class: FieldFactory

Returns a new instance of this FieldFactory that can be used to generate fields instead of being used as a prototype.

Overrides:

newInstance in class XRefFieldFactory

Parameters:

formatModel - the model that the field belongs to.

provider - the HightLightProvider.

options - the Options for display properties.

fieldOptions - the Options for field specific properties.

Returns:

the factory