Package ghidra.util.table.field

Class LabelTableColumn

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,java.lang.String>

ghidra.util.table.field.LabelTableColumn

All Implemented Interfaces:

DynamicTableColumn<ProgramLocation,java.lang.String,Program>, ExtensionPoint, ProgramBasedDynamicTableColumn<ProgramLocation,java.lang.String>, ProgramLocationTableColumn<ProgramLocation,java.lang.String>

public class LabelTableColumn
extends ProgramLocationTableColumnExtensionPoint<ProgramLocation,java.lang.String>

This table column displays the Label for either the program location or the address associated with a row in the table.

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
LabelTableColumn()

Method Summary

Modifier and Type	Method	Description
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.
ProgramLocation	getProgramLocation(ProgramLocation rowObject, Settings settings, Program program, ServiceProvider serviceProvider)	Determines an appropriate program location associated with this field for the indicated row object.
java.lang.String	getValue(ProgramLocation 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, getColumnDisplayName, getColumnRenderer, getComparator, getMaxLines, getSettingsDefinitions, 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, getColumnDisplayName, getColumnRenderer, getComparator, getMaxLines, getSettingsDefinitions, getSupportedRowType, getUniqueIdentifier

Constructor Detail

LabelTableColumn

public LabelTableColumn()

Method Detail

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.

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,java.lang.String,Program>

Specified by:

getColumnName in class AbstractDynamicTableColumn<ProgramLocation,java.lang.String,Program>

Returns:

the field instance name.

getValue

public java.lang.String getValue(ProgramLocation 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 interface DynamicTableColumn<ProgramLocation,java.lang.String,Program>

Specified by:

getValue in class AbstractDynamicTableColumn<ProgramLocation,java.lang.String,Program>

Parameters:

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

settings - field settings

program - 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.

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 interface DynamicTableColumn<ProgramLocation,java.lang.String,Program>

Overrides:

getColumnPreferredWidth in class AbstractDynamicTableColumn<ProgramLocation,java.lang.String,Program>

Returns:

the preferred width for this column.