Package ghidra.app.util.viewer.field
Class ListingTextField
- java.lang.Object
-
- ghidra.app.util.viewer.field.ListingTextField
-
- All Implemented Interfaces:
Field
,TextField
,ListingField
- Direct Known Subclasses:
ErrorListingField
public class ListingTextField extends java.lang.Object implements ListingField, TextField
ListingField implementation for text fields.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
ListingTextField(FieldFactory factory, ProxyObj<?> proxy, TextField field)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
contains(int x, int y)
Returns true if the given point is in this fieldstatic ListingTextField
createMultilineTextField(FieldFactory factory, ProxyObj<?> proxy, FieldElement[] textElements, int startX, int width, int maxLines, HighlightProvider provider)
Displays the given array of text, each on its own line.static ListingTextField
createPackedTextField(FieldFactory factory, ProxyObj<?> proxy, FieldElement[] textElements, int startX, int width, int maxLines, HighlightProvider provider)
Displays the list of text strings, packing as many as it can on a line before wrapping to the next line.static ListingTextField
createSingleLineTextField(FieldFactory factory, ProxyObj<?> proxy, FieldElement fieldElement, int startX, int width, HighlightProvider provider)
Creates a new ListingTextField that displays the text on a single line, clipping as needed.static ListingTextField
createSingleLineTextFieldWithReverseClipping(AddressFieldFactory factory, ProxyObj<?> proxy, FieldElement fieldElement, int startX, int width, HighlightProvider provider)
static ListingTextField
createWordWrappedTextField(FieldFactory factory, ProxyObj<?> proxy, FieldElement fieldElement, int startX, int width, int maxLines, HighlightProvider provider)
Displays the given text, word-wrapping as needed to avoid clipping (up to the max number of lines.)RowColLocation
dataToScreenLocation(int dataRow, int dataColumn)
Translates a data row and column into a screen row and column.java.lang.Object
getClickedObject(FieldLocation fieldLocation)
Returns the object that was clicked on a Field for the given FieldLocation.int
getCol(int row, int x)
Returns the cursor column position for the given x coordinate on the given rowjava.awt.Rectangle
getCursorBounds(int row, int col)
Returns a bounding rectangle for the cursor at the given positionFieldElement
getFieldElement(int screenRow, int screenColumn)
Returns the FieldElement at the given screen location.FieldFactory
getFieldFactory()
Returns the FieldFactory that generated this FieldFieldFormatModel
getFieldModel()
Returns the fieldModel that has the FieldFactory that generated this field.int
getHeight()
Returns the height of this field when populated with the given dataint
getHeightAbove()
Returns the height above the imaginary base line used for alignment of fields.int
getHeightBelow()
Returns the height below the imaginary base line used for alignment of fields.int
getNumCols(int row)
Returns the number of columns in the given rowint
getNumDataRows()
Returns the number of data model rows represented by this field.int
getNumRows()
Returns the number of rows in this fieldint
getPreferredWidth()
The minimum required width to paint the contents of this fieldProxyObj<?>
getProxy()
Returns the object that the fieldFactory used to generate the information in this field.int
getRow(int y)
Returns the row containing the given y coordinateint
getScrollableUnitIncrement(int topOfScreen, int direction, int max)
Returns the amount to scroll to the next or previous lineint
getStartX()
Returns the horizontal position of this fieldjava.lang.String
getText()
Returns a string containing all the text in the fieldjava.lang.String
getTextWithLineSeparators()
Returns a string containing all the text in the field with extra newlinesint
getWidth()
Returns the current width of this fieldint
getX(int row, int col)
Returns the x coordinate for the given cursor positionint
getY(int row)
Returns the y coordinate for the given rowboolean
isClipped()
Returns true if the field is not displaying all the text informationboolean
isPrimary()
Returns true if this field is "primary" (the most important) field; used to determine the "primary" line in the layoutboolean
isValid(int row, int col)
Returns true if the given row and column represent a valid location for this field with the given datavoid
paint(javax.swing.JComponent c, java.awt.Graphics g, PaintContext context, java.awt.Rectangle clip, FieldBackgroundColorManager map, RowColLocation cursorLoc, int rowHeight)
Paints this fieldvoid
rowHeightChanged(int heightAbove, int heightBelow)
notifies field that the rowHeight changedint
screenLocationToTextOffset(int row, int col)
Returns the text offset in the overall field text string for the given row and columnRowColLocation
screenToDataLocation(int screenRow, int screenColumn)
Translates a screen coordinate to a row and column in the data from the factoryvoid
setPrimary(boolean b)
Sets this field to be primary such that its row is primaryRowColLocation
textOffsetToScreenLocation(int textOffset)
Returns the row, column position for an offset into the string returned by getText()java.lang.String
toString()
-
-
-
Field Detail
-
field
protected TextField field
-
-
Constructor Detail
-
ListingTextField
protected ListingTextField(FieldFactory factory, ProxyObj<?> proxy, TextField field)
-
-
Method Detail
-
createSingleLineTextField
public static ListingTextField createSingleLineTextField(FieldFactory factory, ProxyObj<?> proxy, FieldElement fieldElement, int startX, int width, HighlightProvider provider)
Creates a new ListingTextField that displays the text on a single line, clipping as needed.- Parameters:
factory
- the field factory that generated this fieldproxy
- the object used to populate this fieldfieldElement
- the individual element within the field. This holds text, attributes and location information.startX
- the starting X position of the fieldwidth
- the width of the fieldprovider
- the highlight provider.- Returns:
- the text field.
-
createSingleLineTextFieldWithReverseClipping
public static ListingTextField createSingleLineTextFieldWithReverseClipping(AddressFieldFactory factory, ProxyObj<?> proxy, FieldElement fieldElement, int startX, int width, HighlightProvider provider)
-
createWordWrappedTextField
public static ListingTextField createWordWrappedTextField(FieldFactory factory, ProxyObj<?> proxy, FieldElement fieldElement, int startX, int width, int maxLines, HighlightProvider provider)
Displays the given text, word-wrapping as needed to avoid clipping (up to the max number of lines.)- Parameters:
factory
- the field factory that generated this fieldproxy
- the object used to populate this fieldfieldElement
- the individual element within the field. This holds text, attributes and location information.startX
- the starting X position of the fieldwidth
- the width of the fieldmaxLines
- the maxLines to display.provider
- the highlight provider.- Returns:
- the text field.
-
createPackedTextField
public static ListingTextField createPackedTextField(FieldFactory factory, ProxyObj<?> proxy, FieldElement[] textElements, int startX, int width, int maxLines, HighlightProvider provider)
Displays the list of text strings, packing as many as it can on a line before wrapping to the next line.- Parameters:
factory
- the field factory that generated this fieldproxy
- the object used to populate this fieldtextElements
- the array of elements for the field. Each of these holds text, attributes and location information.startX
- the starting X position of the fieldwidth
- the width of the fieldmaxLines
- the maxLines to display.provider
- the highlight provider.- Returns:
- the text field.
-
createMultilineTextField
public static ListingTextField createMultilineTextField(FieldFactory factory, ProxyObj<?> proxy, FieldElement[] textElements, int startX, int width, int maxLines, HighlightProvider provider)
Displays the given array of text, each on its own line.- Parameters:
factory
- the field factory that generated this fieldproxy
- the object used to populate this fieldtextElements
- the array of elements for the field. Each of these holds text, attributes and location information.startX
- the starting X position of the fieldwidth
- the width of the fieldmaxLines
- the maxLines to display.provider
- the highlight provider- Returns:
- the text field.
-
setPrimary
public void setPrimary(boolean b)
Description copied from interface:TextField
Sets this field to be primary such that its row is primary- Specified by:
setPrimary
in interfaceTextField
- Parameters:
b
- this field to be primary such that its row is primary
-
dataToScreenLocation
public RowColLocation dataToScreenLocation(int dataRow, int dataColumn)
Description copied from interface:TextField
Translates a data row and column into a screen row and column.- Specified by:
dataToScreenLocation
in interfaceTextField
- Parameters:
dataRow
- row as defined by the factorydataColumn
- the character offset into the dataRow- Returns:
- row and column in the screen coordinate system; a
DefaultRowColLocation
if this field does not contain the given column
-
screenToDataLocation
public RowColLocation screenToDataLocation(int screenRow, int screenColumn)
Description copied from interface:TextField
Translates a screen coordinate to a row and column in the data from the factory- Specified by:
screenToDataLocation
in interfaceTextField
- Parameters:
screenRow
- the row in the displayed field text.screenColumn
- the column in the displayed field text.- Returns:
- a RowColLocation containing the row and column within the data from the factory.
-
getWidth
public int getWidth()
Description copied from interface:Field
Returns the current width of this field
-
getPreferredWidth
public int getPreferredWidth()
Description copied from interface:Field
The minimum required width to paint the contents of this field- Specified by:
getPreferredWidth
in interfaceField
- Returns:
- the minimum required width to paint the contents of this field
-
getHeight
public int getHeight()
Description copied from interface:Field
Returns the height of this field when populated with the given data
-
getHeightAbove
public int getHeightAbove()
Description copied from interface:ListingField
Returns the height above the imaginary base line used for alignment of fields.- Specified by:
getHeightAbove
in interfaceField
- Specified by:
getHeightAbove
in interfaceListingField
- Returns:
- the height above
-
getHeightBelow
public int getHeightBelow()
Description copied from interface:ListingField
Returns the height below the imaginary base line used for alignment of fields.- Specified by:
getHeightBelow
in interfaceField
- Specified by:
getHeightBelow
in interfaceListingField
- Returns:
- the height below
-
getStartX
public int getStartX()
Description copied from interface:Field
Returns the horizontal position of this field
-
paint
public void paint(javax.swing.JComponent c, java.awt.Graphics g, PaintContext context, java.awt.Rectangle clip, FieldBackgroundColorManager map, RowColLocation cursorLoc, int rowHeight)
Description copied from interface:Field
Paints this field- Specified by:
paint
in interfaceField
- Parameters:
c
- the component to paint ontog
- the graphics contextcontext
- common paint parametersclip
- the clipping region to paint intomap
- contains background color information for the fieldcursorLoc
- the row,column cursor location within the field or null if the field does not contain the cursorrowHeight
- the number of pixels in each row of text in the field
-
contains
public boolean contains(int x, int y)
Description copied from interface:Field
Returns true if the given point is in this field
-
getNumDataRows
public int getNumDataRows()
Description copied from interface:Field
Returns the number of data model rows represented by this field. Some fields may change the row count by wrapping or truncating. The value returned here will be the original data row count before any transformations were applied.- Specified by:
getNumDataRows
in interfaceField
- Returns:
- the number of data rows
-
getNumRows
public int getNumRows()
Description copied from interface:Field
Returns the number of rows in this field- Specified by:
getNumRows
in interfaceField
- Returns:
- the number of rows in this field
-
getNumCols
public int getNumCols(int row)
Description copied from interface:Field
Returns the number of columns in the given row- Specified by:
getNumCols
in interfaceField
- Parameters:
row
- the row from which to get the number of columns; this is the screen row- Returns:
- the number of columns
-
getX
public int getX(int row, int col)
Description copied from interface:Field
Returns the x coordinate for the given cursor position
-
getY
public int getY(int row)
Description copied from interface:Field
Returns the y coordinate for the given row
-
getRow
public int getRow(int y)
Description copied from interface:Field
Returns the row containing the given y coordinate
-
getCol
public int getCol(int row, int x)
Description copied from interface:Field
Returns the cursor column position for the given x coordinate on the given row
-
isValid
public boolean isValid(int row, int col)
Description copied from interface:Field
Returns true if the given row and column represent a valid location for this field with the given data
-
getCursorBounds
public java.awt.Rectangle getCursorBounds(int row, int col)
Description copied from interface:Field
Returns a bounding rectangle for the cursor at the given position- Specified by:
getCursorBounds
in interfaceField
- Parameters:
row
- the text rowcol
- the character position- Returns:
- the rectangle
-
getScrollableUnitIncrement
public int getScrollableUnitIncrement(int topOfScreen, int direction, int max)
Description copied from interface:Field
Returns the amount to scroll to the next or previous line- Specified by:
getScrollableUnitIncrement
in interfaceField
- Parameters:
topOfScreen
- the current y position of the top of the screendirection
- the direction of the scroll (1 down, -1 up)max
- the maximum amount to scroll for the entire row - will be positive for down, and negative for up)- Returns:
- the scroll amount
-
isPrimary
public boolean isPrimary()
Description copied from interface:Field
Returns true if this field is "primary" (the most important) field; used to determine the "primary" line in the layout
-
rowHeightChanged
public void rowHeightChanged(int heightAbove, int heightBelow)
Description copied from interface:Field
notifies field that the rowHeight changed- Specified by:
rowHeightChanged
in interfaceField
- Parameters:
heightAbove
- the height above the baselineheightBelow
- the height below the baseline
-
getText
public java.lang.String getText()
Description copied from interface:Field
Returns a string containing all the text in the field
-
getTextWithLineSeparators
public java.lang.String getTextWithLineSeparators()
Description copied from interface:Field
Returns a string containing all the text in the field with extra newlines- Specified by:
getTextWithLineSeparators
in interfaceField
- Returns:
- a string containing all the text in the field with extra newlines
-
textOffsetToScreenLocation
public RowColLocation textOffsetToScreenLocation(int textOffset)
Description copied from interface:Field
Returns the row, column position for an offset into the string returned by getText()- Specified by:
textOffsetToScreenLocation
in interfaceField
- Parameters:
textOffset
- the offset into the entire text string for this field- Returns:
- a RowColLocation that contains the row,column location in the field for a position in the overall field text
-
screenLocationToTextOffset
public int screenLocationToTextOffset(int row, int col)
Description copied from interface:Field
Returns the text offset in the overall field text string for the given row and column- Specified by:
screenLocationToTextOffset
in interfaceField
- Parameters:
row
- the rowcol
- the column- Returns:
- the offset
-
getFieldFactory
public FieldFactory getFieldFactory()
Description copied from interface:ListingField
Returns the FieldFactory that generated this Field- Specified by:
getFieldFactory
in interfaceListingField
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
getProxy
public ProxyObj<?> getProxy()
Description copied from interface:ListingField
Returns the object that the fieldFactory used to generate the information in this field.- Specified by:
getProxy
in interfaceListingField
-
getFieldModel
public FieldFormatModel getFieldModel()
Description copied from interface:ListingField
Returns the fieldModel that has the FieldFactory that generated this field.- Specified by:
getFieldModel
in interfaceListingField
-
isClipped
public boolean isClipped()
Description copied from interface:TextField
Returns true if the field is not displaying all the text information
-
getClickedObject
public java.lang.Object getClickedObject(FieldLocation fieldLocation)
Description copied from interface:ListingField
Returns the object that was clicked on a Field for the given FieldLocation. This may be the field itself or a lower-level entity, such as a FieldElement.- Specified by:
getClickedObject
in interfaceListingField
- Parameters:
fieldLocation
- The location that was clicked.- Returns:
- the object that was clicked
-
getFieldElement
public FieldElement getFieldElement(int screenRow, int screenColumn)
Description copied from interface:TextField
Returns the FieldElement at the given screen location.- Specified by:
getFieldElement
in interfaceTextField
- Parameters:
screenRow
- the row on the screenscreenColumn
- the column on the screen- Returns:
- the FieldElement at the given screen location.
-
-