Package docking.widgets.filechooser

Class FileDropDownSelectionDataModel

java.lang.Object

docking.widgets.filechooser.FileDropDownSelectionDataModel

All Implemented Interfaces:

DropDownTextFieldDataModel<File>

public class FileDropDownSelectionDataModel
extends Object
implements DropDownTextFieldDataModel<File>

A model that allows the DropDownSelectionTextField to work with File objects.

Nested Class Summary

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

DropDownTextFieldDataModel.SearchMode

Constructor Summary

Constructors

Constructor	Description
FileDropDownSelectionDataModel(GhidraFileChooser chooser)

Method Summary

Modifier and Type	Method	Description
String	getDescription(File file)	Returns a description for this item that gives that will be displayed along side of the DropDownSelectionTextField's matching window.
String	getDisplayText(File value)	Returns the text for the given item that will be entered into the DropDownSelectionTextField when the user makes a selection.
int	getIndexOfFirstMatchingEntry(List<File> data, String text)	Returns the index in the given list of the first item that matches the given text.
ListCellRenderer<File>	getListRenderer()	Returns the renderer to be used to paint the contents of the list returned by DropDownTextFieldDataModel.getMatchingData(String).
List<File>	getMatchingData(String searchText)	Returns a list of data that matches the given searchText.
List<File>	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

FileDropDownSelectionDataModel

public FileDropDownSelectionDataModel(GhidraFileChooser chooser)

Method Details

getDisplayText

public String getDisplayText(File 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<File>

Parameters:

value - the value.

Returns:

the description.

getIndexOfFirstMatchingEntry

public int getIndexOfFirstMatchingEntry(List<File> 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<File>

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.

getListRenderer

public ListCellRenderer<File> 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<File>

Returns:

the renderer.

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<File>

Returns:

the supported search modes

getMatchingData

public List<File> 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<File>

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<File> 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<File>

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)

getDescription

public String getDescription(File file)

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<File>

Parameters:

file - the value.

Returns:

the description.