Package ghidra.app.util.viewer.field

Class OpenCloseFieldFactory

java.lang.Object

ghidra.app.util.viewer.field.FieldFactory

ghidra.app.util.viewer.field.OpenCloseFieldFactory

All Implemented Interfaces:

ExtensionPoint

public class OpenCloseFieldFactory
extends FieldFactory

Generates Open/Close Fields.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FIELD_NAME

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
OpenCloseFieldFactory()

Method Summary

Modifier and Type	Method	Description
boolean	acceptsType(int category, Class<?> proxyObjectClass)	Used to specify which format models this field can belong to.
ListingField	getField(ProxyObj<?> proxy, int varWidth)	Returns the FactoryField for the given object at index index.
FieldLocation	getFieldLocation(ListingField bf, BigInteger index, int fieldNum, ProgramLocation programLoc)	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
FieldFactory	newInstance(FieldFormatModel fieldModel, ListingHighlightProvider provider, ToolOptions displayOptions, 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.FieldFactory

displayOptionsChanged, fieldOptionsChanged, getFieldModel, getFieldName, getFieldText, getMetrics, getMetrics, getStartX, getWidth, hasSamePath, initDisplayOptions, 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

FIELD_NAME

public static final String FIELD_NAME

See Also:

• Constant Field Values

Constructor Details

OpenCloseFieldFactory

public OpenCloseFieldFactory()

Method Details

getField

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

Returns the FactoryField for the given object at index index.

Specified by:

getField in class FieldFactory

Parameters:

proxy - the object whose properties should be displayed.

varWidth - the amount of variable width spacing for any fields before this one.

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

Specified by:

getProgramLocation in class FieldFactory

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.

See Also:

• FieldFactory.getProgramLocation(int, int, ghidra.app.util.viewer.field.ListingField)

getFieldLocation

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

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.

Specified by:

getFieldLocation in class FieldFactory

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.

programLoc - the ProgramLocation to be converted into a FieldLocation.

Returns:

the location.

See Also:

• FieldFactory.getFieldLocation(ghidra.app.util.viewer.field.ListingField, BigInteger, int, ghidra.program.util.ProgramLocation)

acceptsType

public boolean acceptsType(int category,
 Class<?> proxyObjectClass)

Description copied from class: FieldFactory

Used to specify which format models this field can belong to.

Specified by:

acceptsType in class FieldFactory

Parameters:

category - the category for this field

proxyObjectClass - the type of proxy object used by this field

Returns:

true if this class accepts the given category.

See Also:

• FieldFactory.acceptsType(int, java.lang.Class)

newInstance

public FieldFactory newInstance(FieldFormatModel fieldModel,
 ListingHighlightProvider provider,
 ToolOptions displayOptions,
 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.

Specified by:

newInstance in class FieldFactory

Parameters:

fieldModel - the model that the field belongs to.

provider - the HightLightProvider.

displayOptions - the Options for display properties.

fieldOptions - the Options for field specific properties.

Returns:

the factory