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.

Field Summary

Fields

Modifier and Type	Field	Description
protected TextField	field

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ListingTextField(FieldFactory factory, ProxyObj proxy, TextField field)

Method Summary

Modifier and Type	Method	Description
boolean	contains(int x, int y)	Returns true if the given point is in this field.
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.
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 row.
java.awt.Rectangle	getCursorBounds(int row, int col)	Returns a bounding rectangle for the cursor at the given position.
FieldElement	getFieldElement(int screenRow, int screenColumn)	Returns the FieldElement at the given screen location.
FieldFactory	getFieldFactory()	Returns the FieldFactory that generated this Field
FieldFormatModel	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 data.
int	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 row.
int	getNumRows()	Returns the number of rows in this field
int	getPreferredWidth()	The minimum required width to paint the contents of this field
ProxyObj	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 coordinate.
int	getScrollableUnitIncrement(int topOfScreen, int direction, int max)	Returns the amount to scroll to the next or previous line
int	getStartX()	Returns the horizontal position of this field.
java.lang.String	getText()	Returns a string containing all the text in the field.
java.lang.String	getTextWithLineSeparators()	Returns a string containing all the text in the field with extra linefeeds
int	getWidth()	Returns the current width of this field.
int	getX(int row, int col)	Returns the x coordinate for the given cursor position.
int	getY(int row)	Returns the y coordinate for the given row.
boolean	isClipped()	Returns true if the field is not displaying all the text information
boolean	isPrimary()	Returns true if this field is "primary" (the most important) field; used to determine the "primary" line in the layout.
boolean	isValid(int row, int col)	Returns true if the given row and column represent a valid location for this field with the given data;
void	paint(javax.swing.JComponent c, java.awt.Graphics g, PaintContext context, FieldBackgroundColorManager map, RowColLocation cursorLoc, int rowHeight)	Paints this field.
void	rowHeightChanged(int heightAbove, int heightBelow)	notifies field that the rowHeight changed
int	screenLocationToTextOffset(int row, int col)	Returns the text offset in the overall field text string for the given row and column.
RowColLocation	screenToDataLocation(int screenRow, int screenColumn)	Translates a screen coordinate to a row and column in the data from the factory
void	setPrimary(boolean b)	Sets this field to be primary such that its row is primary
RowColLocation	textOffsetToScreenLocation(int textOffset)	Returns the row, column position for an offset into the string returned by getText().
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

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 field

proxy - the object used to populate this field

fieldElement - the individual element within the field. This holds text, attributes and location information.

startX - the starting X position of the field

width - the width of the field

provider - the highlight provider.

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 field

proxy - the object used to populate this field

fieldElement - the individual element within the field. This holds text, attributes and location information.

startX - the starting X position of the field

width - the width of the field

maxLines - the maxLines to display.

provider - the highlight provider.

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 field

proxy - the object used to populate this field

textElements - the array of elements for the field. Each of these holds text, attributes and location information.

startX - the starting X position of the field

width - the width of the field

maxLines - the maxLines to display.

provider - the highlight provider.

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 field

proxy - the object used to populate this field

textElements - the array of elements for the field. Each of these holds text, attributes and location information.

startX - the starting X position of the field

width - the widht of the field

maxLines - the maxLines to display.

provider - the highlight provider

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 interface TextField

See Also:

TextField.setPrimary(boolean)

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 interface TextField

Parameters:

dataRow - row as defined by the factory

dataColumn - the character offset into the dataRow

Returns:

row and column in the screen coordinate system.

See Also:

TextField.dataToScreenLocation(int, int)

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 interface TextField

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.

See Also:

TextField.screenToDataLocation(int, int)

getWidth

public int getWidth()

Description copied from interface: Field

Returns the current width of this field.

Specified by:

getWidth in interface Field

See Also:

Field.getWidth()

getPreferredWidth

public int getPreferredWidth()

Description copied from interface: Field

The minimum required width to paint the contents of this field

Specified by:

getPreferredWidth in interface Field

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.

Specified by:

getHeight in interface Field

See Also:

Field.getHeight()

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 interface Field

Specified by:

getHeightAbove in interface ListingField

See Also:

Field.getHeightAbove()

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 interface Field

Specified by:

getHeightBelow in interface ListingField

See Also:

Field.getHeightBelow()

getStartX

public int getStartX()

Description copied from interface: Field

Returns the horizontal position of this field.

Specified by:

getStartX in interface Field

See Also:

Field.getStartX()

paint

public void paint(javax.swing.JComponent c,
                  java.awt.Graphics g,
                  PaintContext context,
                  FieldBackgroundColorManager map,
                  RowColLocation cursorLoc,
                  int rowHeight)

Description copied from interface: Field

Paints this field.

Specified by:

paint in interface Field

g - the graphics context.

context - common paint parameters

map - contains background color information for the field.

cursorLoc - the row,column cursor location within the field or null if the field does not contain the cursor

See Also:

docking.widgets.fieldpanel.field.Field#paint(java.awt.Graphics, docking.widgets.fieldpanel.internal.PaintContext, boolean, docking.widgets.fieldpanel.support.RowColLocation)

contains

public boolean contains(int x,
                        int y)

Description copied from interface: Field

Returns true if the given point is in this field.

Specified by:

contains in interface Field

Parameters:

x - the horizontal coordinate of the point.

y - the relatve y position in this layout

See Also:

Field.contains(int, int)

getNumRows

public int getNumRows()

Description copied from interface: Field

Returns the number of rows in this field

Specified by:

getNumRows in interface Field

See Also:

Field.getNumRows()

getNumCols

public int getNumCols(int row)

Description copied from interface: Field

Returns the number of columns in the given row.

Specified by:

getNumCols in interface Field

Parameters:

row - the row from which to get the number of columns.

See Also:

Field.getNumCols(int)

getX

public int getX(int row,
                int col)

Description copied from interface: Field

Returns the x coordinate for the given cursor position.

Specified by:

getX in interface Field

Parameters:

row - the text row of interest.

col - the character column.

See Also:

Field.getX(int, int)

getY

public int getY(int row)

Description copied from interface: Field

Returns the y coordinate for the given row.

Specified by:

getY in interface Field

Parameters:

row - the text row of interest.

See Also:

Field.getY(int)

getRow

public int getRow(int y)

Description copied from interface: Field

Returns the row containing the given y coordinate.

Specified by:

getRow in interface Field

Parameters:

y - vertical pixel coordinate relative to the top of the screen.

See Also:

Field.getRow(int)

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.

Specified by:

getCol in interface Field

Parameters:

row - the text row to find the column on.

x - the horizontal pixel coordinate for which to find the character position.

See Also:

Field.getCol(int, int)

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;

Specified by:

isValid in interface Field

Parameters:

row - the text row.

col - the character position.

See Also:

Field.isValid(int, int)

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 interface Field

Parameters:

row - the text row.

col - the character postion.

See Also:

Field.getCursorBounds(int, int)

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 interface Field

Parameters:

topOfScreen - - the current y pos of the top of the screen.

direction - - 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)

See Also:

Field.getScrollableUnitIncrement(int, int, int)

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.

Specified by:

isPrimary in interface Field

See Also:

Field.isPrimary()

rowHeightChanged

public void rowHeightChanged(int heightAbove,
                             int heightBelow)

Description copied from interface: Field

notifies field that the rowHeight changed

Specified by:

rowHeightChanged in interface Field

Parameters:

heightAbove - the height above the baseline

heightBelow - the height below the baseline.

See Also:

Field.rowHeightChanged(int, int)

getText

public java.lang.String getText()

Description copied from interface: Field

Returns a string containing all the text in the field.

Specified by:

getText in interface Field

See Also:

Field.getText()

getTextWithLineSeparators

public java.lang.String getTextWithLineSeparators()

Description copied from interface: Field

Returns a string containing all the text in the field with extra linefeeds

Specified by:

getTextWithLineSeparators in interface Field

Returns:

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 interface Field

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.

See Also:

Field.textOffsetToScreenLocation(int)

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 interface Field

Parameters:

row - the row.

col - the column.

See Also:

Field.screenLocationToTextOffset(int, int)

getFieldFactory

public FieldFactory getFieldFactory()

Description copied from interface: ListingField

Returns the FieldFactory that generated this Field

Specified by:

getFieldFactory in interface ListingField

See Also:

ListingField.getFieldFactory()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

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 interface ListingField

See Also:

ListingField.getProxy()

getFieldModel

public FieldFormatModel getFieldModel()

Description copied from interface: ListingField

Returns the fieldModel that has the FieldFactory that generated this field.

Specified by:

getFieldModel in interface ListingField

See Also:

ListingField.getFieldModel()

isClipped

public boolean isClipped()

Description copied from interface: TextField

Returns true if the field is not displaying all the text information

Specified by:

isClipped in interface TextField

See Also:

TextField.isClipped()

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 interface ListingField

Parameters:

fieldLocation - The location that was clicked.

Returns:

the object that was clicked

See Also:

ListingField.getClickedObject(docking.widgets.fieldpanel.support.FieldLocation)

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 interface TextField

Parameters:

screenRow - the row on the screen

screenColumn - the column on the screen

Returns:

the FieldElement at the given screen location.