Package ghidra.util.table.field
Class FunctionSignatureTableColumn
- 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<Function,Function>
-
- ghidra.util.table.field.FunctionSignatureTableColumn
-
- All Implemented Interfaces:
DynamicTableColumn<Function,Function,Program>
,ExtensionPoint
,ProgramBasedDynamicTableColumn<Function,Function>
,ProgramLocationTableColumn<Function,Function>
public class FunctionSignatureTableColumn extends ProgramLocationTableColumnExtensionPoint<Function,Function>
This table field displays the Function Signature for either the program location or the address associated with a row in the table.
-
-
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 FunctionSignatureTableColumn()
-
Method Summary
All Methods Instance Methods Concrete Methods 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.int
getColumnPreferredWidth()
Returns the preferred width for this column.GColumnRenderer<Function>
getColumnRenderer()
Returns the optional cell renderer for this column; null if no renderer is used.ProgramLocation
getProgramLocation(Function 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.Function
getValue(Function rowObject, Settings settings, Program program, 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, getComparator, getMaxLines, 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, getComparator, getMaxLines, getSupportedRowType, getUniqueIdentifier
-
-
-
-
Method Detail
-
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 interfaceDynamicTableColumn<Function,Function,Program>
- Overrides:
getColumnDisplayName
in classAbstractDynamicTableColumn<Function,Function,Program>
- Parameters:
settings
- the settings- Returns:
- the field name to display as the column heading.
-
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 interfaceDynamicTableColumn<Function,Function,Program>
- Specified by:
getColumnName
in classAbstractDynamicTableColumn<Function,Function,Program>
- Returns:
- the field instance name.
-
getValue
public Function getValue(Function rowObject, Settings settings, Program program, 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 interfaceDynamicTableColumn<Function,Function,Program>
- Specified by:
getValue
in classAbstractDynamicTableColumn<Function,Function,Program>
- Parameters:
rowObject
- the object associated with the row in the table.settings
- field settingsprogram
- the expected data object, as defined by the DATA_SOURCE typeserviceProvider
- theServiceProvider
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(Function 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 settingsprogram
- the program associated with the table.serviceProvider
- the plugin tool associated with the table.- Returns:
- the address associated with the field.
-
getSettingsDefinitions
public SettingsDefinition[] getSettingsDefinitions()
Description copied from interface:DynamicTableColumn
Returns a list of settings definitions for this field.- Specified by:
getSettingsDefinitions
in interfaceDynamicTableColumn<Function,Function,Program>
- Overrides:
getSettingsDefinitions
in classAbstractDynamicTableColumn<Function,Function,Program>
- Returns:
- list of settings definitions for this field.
-
getColumnRenderer
public GColumnRenderer<Function> 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
andEnum
s. (This is because the filtering system works naturally with these types.) SeeGColumnRenderer
.- Specified by:
getColumnRenderer
in interfaceDynamicTableColumn<Function,Function,Program>
- Overrides:
getColumnRenderer
in classAbstractDynamicTableColumn<Function,Function,Program>
- Returns:
- the renderer
-
getColumnPreferredWidth
public int getColumnPreferredWidth()
Description copied from interface:DynamicTableColumn
Returns the preferred width for this column. Column should either return a valid positive preferred size or -1.- Specified by:
getColumnPreferredWidth
in interfaceDynamicTableColumn<Function,Function,Program>
- Overrides:
getColumnPreferredWidth
in classAbstractDynamicTableColumn<Function,Function,Program>
- Returns:
- the preferred width for this column.
-
-