Package ghidra.app.util.datatype

Class DataTypeDropDownSelectionDataModel

java.lang.Object

ghidra.app.util.datatype.DataTypeDropDownSelectionDataModel

All Implemented Interfaces:

DropDownTextFieldDataModel<DataType>

public class DataTypeDropDownSelectionDataModel
extends Object
implements DropDownTextFieldDataModel<DataType>

The data model for DropDownSelectionTextField that allows the text field to work with DataTypes.

Nested Class Summary

Nested classes/interfaces inherited from interface docking.widgets.DropDownTextFieldDataModel

DropDownTextFieldDataModel.SearchMode

Constructor Summary

Constructors

Constructor	Description
DataTypeDropDownSelectionDataModel(ServiceProvider serviceProvider)
DataTypeDropDownSelectionDataModel(DataTypeManager preferredDtm, DataTypeManagerService dataTypeService)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
String	getDescription(DataType value)	Returns a description for this item that gives that will be displayed along side of the DropDownSelectionTextField's matching window.
String	getDisplayText(DataType value)	Returns the text for the given item that will be entered into the DropDownSelectionTextField when the user makes a selection.
int	getIndexOfFirstMatchingEntry(List<DataType> data, String text)	Returns the index in the given list of the first item that matches the given text.
ListCellRenderer<DataType>	getListRenderer()	Returns the renderer to be used to paint the contents of the list returned by DropDownTextFieldDataModel.getMatchingData(String).
List<DataType>	getMatchingData(String searchText)	Returns a list of data that matches the given searchText.
List<DataType>	getMatchingData(String searchText, DropDownTextFieldDataModel.SearchMode mode)	Returns a list of data that matches the given searchText.
List<DropDownTextFieldDataModel.SearchMode>	getSupportedSearchModes()	Subclasses can override this to return all supported search modes.

Methods inherited from class java.lang.Object

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

Constructor Details

DataTypeDropDownSelectionDataModel

public DataTypeDropDownSelectionDataModel(ServiceProvider serviceProvider)

DataTypeDropDownSelectionDataModel

public DataTypeDropDownSelectionDataModel(DataTypeManager preferredDtm,
 DataTypeManagerService dataTypeService)

Creates a new instance.

Parameters:

preferredDtm - the preferred DataTypeManager. Data types that are found in multiple data type managers will be pruned to just the ones already in the preferred data type manager.

dataTypeService - DataTypeManagerService

Method Details

getSupportedSearchModes

public List<DropDownTextFieldDataModel.SearchMode> getSupportedSearchModes()

Description copied from interface: DropDownTextFieldDataModel

Subclasses can override this to return all supported search modes. The order of the modes is the order which they will cycle when requested by the user. The first mode is the default search mode.

Specified by:

getSupportedSearchModes in interface DropDownTextFieldDataModel<DataType>

Returns:

the supported search modes

getListRenderer

public ListCellRenderer<DataType> getListRenderer()

Description copied from interface: DropDownTextFieldDataModel

Returns the renderer to be used to paint the contents of the list returned by DropDownTextFieldDataModel.getMatchingData(String).

Specified by:

getListRenderer in interface DropDownTextFieldDataModel<DataType>

Returns:

the renderer.

getDescription

public String getDescription(DataType value)

Description copied from interface: DropDownTextFieldDataModel

Returns a description for this item that gives that will be displayed along side of the DropDownSelectionTextField's matching window.

Specified by:

getDescription in interface DropDownTextFieldDataModel<DataType>

Parameters:

value - the value.

Returns:

the description.

getDisplayText

public String getDisplayText(DataType value)

Description copied from interface: DropDownTextFieldDataModel

Returns the text for the given item that will be entered into the DropDownSelectionTextField when the user makes a selection.

Specified by:

getDisplayText in interface DropDownTextFieldDataModel<DataType>

Parameters:

value - the value.

Returns:

the description.

getMatchingData

public List<DataType> getMatchingData(String searchText)

Description copied from interface: DropDownTextFieldDataModel

Returns a list of data that matches the given searchText. A list is returned to allow for multiple matches. The type of matching performed is determined by the current search mode. If the implementation of this model does not support search modes, then it is up the the implementor to determine how matches are found.

Implementation Note: a client request for all data will happen using the empty string. If your data model is sufficiently large, then you may choose to not return any data in this case. Smaller data sets should return all data when given the empty string

Specified by:

getMatchingData in interface DropDownTextFieldDataModel<DataType>

Parameters:

searchText - The text used to find matches.

Returns:

a list of items matching the given text.

See Also:

• DropDownTextFieldDataModel.getMatchingData(String, SearchMode)

getMatchingData

public List<DataType> getMatchingData(String searchText,
 DropDownTextFieldDataModel.SearchMode mode)

Description copied from interface: DropDownTextFieldDataModel

Returns a list of data that matches the given searchText. A list is returned to allow for multiple matches. The type of matching performed is determined by the current search mode. If the implementation of this model does not support search modes, then it is up the the implementor to determine how matches are found.

Implementation Note: a client request for all data will happen using the empty string. If your data model is sufficiently large, then you may choose to not return any data in this case. Smaller data sets should return all data when given the empty string

Specified by:

getMatchingData in interface DropDownTextFieldDataModel<DataType>

Parameters:

searchText - the text used to find matches.

mode - the search mode to use

Returns:

a list of items matching the given text.

See Also:

• DropDownTextFieldDataModel.getMatchingData(String, SearchMode)

getIndexOfFirstMatchingEntry

public int getIndexOfFirstMatchingEntry(List<DataType> data,
 String text)

Description copied from interface: DropDownTextFieldDataModel

Returns the index in the given list of the first item that matches the given text. For data sets that do not allow duplicates, this is simply the index of the item that matches the text in the list. For items that allow duplicates, the is the index of the first match.

Specified by:

getIndexOfFirstMatchingEntry in interface DropDownTextFieldDataModel<DataType>

Parameters:

data - the list to search.

text - the text to match against the items in the list.

Returns:

the index in the given list of the first item that matches the given text.