Package ghidra.app.util.viewer.field
Class BytesFieldFactory
- java.lang.Object
-
- ghidra.app.util.viewer.field.FieldFactory
-
- ghidra.app.util.viewer.field.BytesFieldFactory
-
- All Implemented Interfaces:
ExtensionPoint
public class BytesFieldFactory extends FieldFactory
Generates Bytes Fields.
-
-
Field Summary
Fields Modifier and Type Field Description static java.awt.Color
ALIGNMENT_BYTES_COLOR
static java.lang.String
BYTE_GROUP_SIZE_MSG
static java.awt.Color
DEFAULT_COLOR
static java.lang.String
DELIMITER_MSG
static java.lang.String
DISPLAY_STRUCTURE_ALIGNMENT_BYTES_MSG
static java.lang.String
DISPLAY_UCASE_MSG
static java.lang.String
FIELD_NAME
static java.lang.String
GROUP_TITLE
static java.lang.String
MAX_DISPLAY_LINES_MSG
static java.lang.String
REVERSE_INSTRUCTION_BYTE_ORDERING
-
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 BytesFieldFactory()
Default 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.void
fieldOptionsChanged(Options options, java.lang.String optionName, java.lang.Object oldValue, java.lang.Object newValue)
Notifications that the field options changed.java.awt.Color
getDefaultColor()
Returns the default field color.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 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'sFieldFactory.getFieldLocation(ListingField, BigInteger, int, ProgramLocation)
.ProgramLocation
getProgramLocation(int row, int col, ListingField bf)
Returns the Program location for the given object, row, col, and groupPathFieldFactory
newInstance(FieldFormatModel formatModel, HighlightProvider 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, getFieldModel, getFieldName, getFieldText, 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
-
DEFAULT_COLOR
public static final java.awt.Color DEFAULT_COLOR
-
ALIGNMENT_BYTES_COLOR
public static final java.awt.Color ALIGNMENT_BYTES_COLOR
-
GROUP_TITLE
public static final java.lang.String GROUP_TITLE
- See Also:
- Constant Field Values
-
MAX_DISPLAY_LINES_MSG
public static final java.lang.String MAX_DISPLAY_LINES_MSG
- See Also:
- Constant Field Values
-
DELIMITER_MSG
public static final java.lang.String DELIMITER_MSG
- See Also:
- Constant Field Values
-
BYTE_GROUP_SIZE_MSG
public static final java.lang.String BYTE_GROUP_SIZE_MSG
- See Also:
- Constant Field Values
-
DISPLAY_UCASE_MSG
public static final java.lang.String DISPLAY_UCASE_MSG
- See Also:
- Constant Field Values
-
REVERSE_INSTRUCTION_BYTE_ORDERING
public static final java.lang.String REVERSE_INSTRUCTION_BYTE_ORDERING
- See Also:
- Constant Field Values
-
DISPLAY_STRUCTURE_ALIGNMENT_BYTES_MSG
public static final java.lang.String DISPLAY_STRUCTURE_ALIGNMENT_BYTES_MSG
- See Also:
- Constant Field Values
-
-
Method Detail
-
fieldOptionsChanged
public void fieldOptionsChanged(Options options, java.lang.String optionName, java.lang.Object oldValue, java.lang.Object newValue)
Description copied from class:FieldFactory
Notifications that the field options changed.- Overrides:
fieldOptionsChanged
in classFieldFactory
- Parameters:
options
- the Field Options object that changed.optionName
- the name of the property that changed.oldValue
- the old value of the property.newValue
- the new value of the property.
-
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.
-
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.
-
getFieldLocation
public FieldLocation getFieldLocation(ListingField bf, java.math.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'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.loc
- the ProgramLocation to be converted into a FieldLocation.
-
getDefaultColor
public java.awt.Color getDefaultColor()
Description copied from class:FieldFactory
Returns the default field color.- Overrides:
getDefaultColor
in classFieldFactory
-
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 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 classFieldFactory
- Parameters:
formatModel
- the model that the field belongs to.provider
- the HightLightProvider.displayOptions
- the Options for display properties.fieldOptions
- the Options for field specific properties.
-
-