Package ghidra.app.util.viewer.field
Class SpacerFieldFactory
- java.lang.Object
-
- ghidra.app.util.viewer.field.FieldFactory
-
- ghidra.app.util.viewer.field.SpacerFieldFactory
-
- All Implemented Interfaces:
ExtensionPoint
public class SpacerFieldFactory extends FieldFactory
Generates Spacer Fields.This field is not meant to be loaded by the
ClassSearcher
, hence the X in the name.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
FIELD_NAME
-
Fields inherited from class ghidra.app.util.viewer.field.FieldFactory
baseFont, color, colorOptionName, DEFAULT_FIELD_FONT, displayOptions, enabled, FONT_OPTION_NAME, hlProvider, model, name, startX, style, styleOptionName, underlineColor, width
-
-
Constructor Summary
Constructors Constructor Description SpacerFieldFactory()
ConstructorSpacerFieldFactory(java.lang.String text, FieldFormatModel model, HighlightProvider hsProvider, Options displayOptions, Options fieldOptions)
Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
acceptsType(int category, java.lang.Class<?> proxyObjectClass)
Used to specify which format models this field can belong to.ListingField
getField(ProxyObj<?> proxy, int varWidth)
Generates a Field based on the given information.FieldLocation
getFieldLocation(ListingField bf, java.math.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'sFieldFactory.getFieldLocation(ListingField, BigInteger, int, ProgramLocation)
.java.lang.String
getFieldText()
Returns a description of the fields generated by this factory.ProgramLocation
getProgramLocation(int row, int col, ListingField bf)
Returns the Program location for the given object, row, col, and groupPathjava.lang.String
getStringToHighlight(ListingTextField bf, int row, int col, ProgramLocation loc)
Returns the string to highlightjava.lang.String
getText()
Returns the spacer field's textFieldFactory
newInstance(FieldFormatModel formatModel, HighlightProvider 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.void
setText()
Sets the literal text to display in this field.void
setText(java.lang.String text)
Sets the text for the spacer field-
Methods inherited from class ghidra.app.util.viewer.field.FieldFactory
displayOptionsChanged, fieldOptionsChanged, getDefaultColor, getFieldModel, getFieldName, getMetrics, getMetrics, getStartX, getWidth, hasSamePath, initDisplayOptions, isEnabled, optionsChanged, servicesChanged, setEnabled, setStartX, setWidth
-
-
-
-
Field Detail
-
FIELD_NAME
public static final java.lang.String FIELD_NAME
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
SpacerFieldFactory
public SpacerFieldFactory()
Constructor
-
SpacerFieldFactory
public SpacerFieldFactory(java.lang.String text, FieldFormatModel model, HighlightProvider hsProvider, Options displayOptions, Options fieldOptions)
Constructor- Parameters:
text
- The text to display in the field.model
- The Field model that will use this Address factory.hsProvider
- the HightLightProvider.displayOptions
- the Options for display properties.fieldOptions
- the Options for field specific properties.
-
-
Method Detail
-
setText
public void setText(java.lang.String text)
Sets the text for the spacer field- Parameters:
text
- the text to display in the listing
-
setText
public void setText()
Sets the literal text to display in this field.
-
getText
public java.lang.String getText()
Returns the spacer field's text
-
getField
public ListingField getField(ProxyObj<?> proxy, int varWidth)
Description copied from class:FieldFactory
Generates a Field based on the given information.- Specified by:
getField
in classFieldFactory
- 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.
-
getFieldText
public java.lang.String getFieldText()
Description copied from class:FieldFactory
Returns a description of the fields generated by this factory.- Overrides:
getFieldText
in classFieldFactory
-
getFieldLocation
public FieldLocation getFieldLocation(ListingField bf, java.math.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'sFieldFactory.getFieldLocation(ListingField, BigInteger, int, ProgramLocation)
. Each FieldFactory should generate and process a unique ProgramLocation class.- Specified by:
getFieldLocation
in classFieldFactory
- 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.
-
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 classFieldFactory
- Parameters:
row
- the row within this fieldcol
- the col on the given row within this field.bf
- the ListingField containing the cursor.
-
getStringToHighlight
public java.lang.String getStringToHighlight(ListingTextField bf, int row, int col, ProgramLocation loc)
Returns the string to highlight- Parameters:
bf
- the ListingTextFieldrow
- the row in the fieldcol
- the column in the fieldloc
- the programLocation.
-
acceptsType
public boolean acceptsType(int category, java.lang.Class<?> proxyObjectClass)
Description copied from class:FieldFactory
Used to specify which format models this field can belong to.- Specified by:
acceptsType
in classFieldFactory
- Parameters:
category
- the category for this fieldproxyObjectClass
- the type of proxy object used by this field- Returns:
- true if this class accepts the given category.
-
newInstance
public FieldFactory newInstance(FieldFormatModel formatModel, HighlightProvider 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.- Specified by:
newInstance
in classFieldFactory
- 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.
-
-