Package ghidra.util.table.field

Class CodeUnitTableColumn

java.lang.Object

docking.widgets.table.AbstractDynamicTableColumn<ROW_TYPE,COLUMN_TYPE,DATA_SOURCE>

docking.widgets.table.DynamicTableColumnExtensionPoint<ROW_TYPE,COLUMN_TYPE,Program>

ghidra.util.table.field.ProgramLocationTableColumnExtensionPoint<ProgramLocation,CodeUnitTableCellData>

ghidra.util.table.field.CodeUnitTableColumn

All Implemented Interfaces:

DynamicTableColumn<ProgramLocation,CodeUnitTableCellData,Program>, ExtensionPoint, ProgramBasedDynamicTableColumn<ProgramLocation,CodeUnitTableCellData>, ProgramLocationTableColumn<ProgramLocation,CodeUnitTableCellData>

public class CodeUnitTableColumn
extends ProgramLocationTableColumnExtensionPoint<ProgramLocation,CodeUnitTableCellData>

Table column to display CodeUnits

Nested Class Summary

Nested classes/interfaces inherited from interface ghidra.util.classfinder.ExtensionPoint

ExtensionPoint.Exclude, ExtensionPoint.Util

Field Summary

Fields inherited from class docking.widgets.table.AbstractDynamicTableColumn

FLOATING_POINT_PRECISION_SETTING, FLOATING_POINT_SETTINGS_DEFINITIONS, INTEGER_RADIX_SETTING, INTEGER_SETTINGS_DEFINITIONS, INTEGER_SIGNEDNESS_MODE_SETTING, NO_SETTINGS_DEFINITIONS

Constructor Summary

Constructors

Constructor	Description
CodeUnitTableColumn()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getColumnDisplayName(Settings settings)	Determines the column heading that will be displayed.
java.lang.String	getColumnName()	Determines the unique column heading that may be used to identify a column instance.
GColumnRenderer<CodeUnitTableCellData>	getColumnRenderer()	Returns the optional cell renderer for this column; null if no renderer is used.
int	getMaxLines(Settings settings)	Gets the maximum number of text display lines needed for any given cell with the specified settings.
ProgramLocation	getProgramLocation(ProgramLocation rowObject, Settings settings, Program program, ServiceProvider serviceProvider)	Determines an appropriate program location associated with this field for the indicated row object.
SettingsDefinition[]	getSettingsDefinitions()	Returns a list of settings definitions for this field.
CodeUnitTableCellData	getValue(ProgramLocation rowObject, Settings settings, Program data, ServiceProvider serviceProvider)	Creates an object that is appropriate for this field (table column) and for the object that is associated with this row of the table.

Methods inherited from class docking.widgets.table.AbstractDynamicTableColumn

equals, getColumnClass, getColumnDescription, getColumnPreferredWidth, getComparator, getSupportedRowType, getUniqueIdentifier, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface docking.widgets.table.DynamicTableColumn

getColumnClass, getColumnDescription, getColumnPreferredWidth, getComparator, getSupportedRowType, getUniqueIdentifier

Constructor Detail

CodeUnitTableColumn

public CodeUnitTableColumn()

Method Detail

getColumnName

public java.lang.String getColumnName()

Description copied from interface: DynamicTableColumn

Determines the unique column heading that may be used to identify a column instance. This name must be non-changing and is used to save/restore state information.

Specified by:

getColumnName in interface DynamicTableColumn<ProgramLocation,CodeUnitTableCellData,Program>

Specified by:

getColumnName in class AbstractDynamicTableColumn<ProgramLocation,CodeUnitTableCellData,Program>

Returns:

the field instance name.

getColumnDisplayName

public java.lang.String getColumnDisplayName(Settings settings)

Description copied from interface: DynamicTableColumn

Determines the column heading that will be displayed.

Specified by:

getColumnDisplayName in interface DynamicTableColumn<ProgramLocation,CodeUnitTableCellData,Program>

Overrides:

getColumnDisplayName in class AbstractDynamicTableColumn<ProgramLocation,CodeUnitTableCellData,Program>

Returns:

the field name to display as the column heading.

getValue

public CodeUnitTableCellData getValue(ProgramLocation rowObject,
                                      Settings settings,
                                      Program data,
                                      ServiceProvider serviceProvider)
                               throws java.lang.IllegalArgumentException

Description copied from interface: DynamicTableColumn

Creates an object that is appropriate for this field (table column) and for the object that is associated with this row of the table.

Specified by:

getValue in interface DynamicTableColumn<ProgramLocation,CodeUnitTableCellData,Program>

Specified by:

getValue in class AbstractDynamicTableColumn<ProgramLocation,CodeUnitTableCellData,Program>

Parameters:

rowObject - the object associated with the row in the table.

settings - field settings

data - the expected data object, as defined by the DATA_SOURCE type

serviceProvider - the ServiceProvider associated with the table.

Returns:

the object for the model to display in the table cell.

Throws:

java.lang.IllegalArgumentException - if the rowObject is not one supported by this class.

getProgramLocation

public ProgramLocation getProgramLocation(ProgramLocation rowObject,
                                          Settings settings,
                                          Program program,
                                          ServiceProvider serviceProvider)

Description copied from interface: ProgramLocationTableColumn

Determines an appropriate program location associated with this field for the indicated row object. The most probable use is for navigating from the field.

Parameters:

rowObject - the object associated with the table row.

settings - field settings

program - the program associated with the table.

serviceProvider - the plugin tool associated with the table.

Returns:

the address associated with the field.

getColumnRenderer

public GColumnRenderer<CodeUnitTableCellData> getColumnRenderer()

Description copied from interface: DynamicTableColumn

Returns the optional cell renderer for this column; null if no renderer is used.

This method allows columns to define custom rendering. The interface returned here ensures that the text used for filtering matches what the users sees (via the GColumnRenderer.getFilterString(Object, Settings) method).

Note: some types should not make use of the aforementioned filter string. These types include the Number wrapper types, Date and Enums. (This is because the filtering system works naturally with these types.) See GColumnRenderer.

Specified by:

getColumnRenderer in interface DynamicTableColumn<ProgramLocation,CodeUnitTableCellData,Program>

Overrides:

getColumnRenderer in class AbstractDynamicTableColumn<ProgramLocation,CodeUnitTableCellData,Program>

Returns:

the renderer

getSettingsDefinitions

public SettingsDefinition[] getSettingsDefinitions()

Description copied from interface: DynamicTableColumn

Returns a list of settings definitions for this field.

Specified by:

getSettingsDefinitions in interface DynamicTableColumn<ProgramLocation,CodeUnitTableCellData,Program>

Overrides:

getSettingsDefinitions in class AbstractDynamicTableColumn<ProgramLocation,CodeUnitTableCellData,Program>

Returns:

list of settings definitions for this field.

getMaxLines

public int getMaxLines(Settings settings)

Description copied from interface: DynamicTableColumn

Gets the maximum number of text display lines needed for any given cell with the specified settings.

Specified by:

getMaxLines in interface DynamicTableColumn<ProgramLocation,CodeUnitTableCellData,Program>

Overrides:

getMaxLines in class AbstractDynamicTableColumn<ProgramLocation,CodeUnitTableCellData,Program>

Parameters:

settings - field settings

Returns:

maximum number of lines needed