Module org.autogui

Package org.autogui.swing.table

Class GuiSwingTableColumnFilePath.SearchTextFieldModelFilePathEmpty

java.lang.Object

org.autogui.swing.util.SearchTextFieldFilePath.SearchTextFieldModelFilePath

org.autogui.swing.table.GuiSwingTableColumnFilePath.SearchTextFieldModelFilePathEmpty

All Implemented Interfaces:

SearchTextField.SearchTextFieldModel

Enclosing class:

GuiSwingTableColumnFilePath

public static class GuiSwingTableColumnFilePath.SearchTextFieldModelFilePathEmpty
extends SearchTextFieldFilePath.SearchTextFieldModelFilePath

a dummy editor for just rending a file-path

Field Summary

Fields inherited from class org.autogui.swing.util.SearchTextFieldFilePath.SearchTextFieldModelFilePath

iconSource, selection

Constructor Summary

Constructors

Constructor	Description
SearchTextFieldModelFilePathEmpty()

Method Summary

Modifier and Type	Method	Description
List<PopupCategorized.CategorizedMenuItem>	getCandidates(String text, boolean editable, SearchTextField.SearchTextFieldPublisher publisher)	the method is executed under the background thread of SwingWorker.
boolean	isBackgroundTask()

Methods inherited from class org.autogui.swing.util.SearchTextFieldFilePath.SearchTextFieldModelFilePath

compare, getChildItems, getCompletionItems, getDefaultCurrent, getDefaultItems, getFileItem, getParentItems, getSelection, isFixedCategorySize, select, setSelection

Methods inherited from class java.lang.Object

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

Constructor Details

SearchTextFieldModelFilePathEmpty

public SearchTextFieldModelFilePathEmpty()

Method Details

isBackgroundTask

public boolean isBackgroundTask()

getCandidates

public List<PopupCategorized.CategorizedMenuItem> getCandidates(String text,
 boolean editable,
 SearchTextField.SearchTextFieldPublisher publisher)

Description copied from interface: SearchTextField.SearchTextFieldModel

the method is executed under the background thread of SwingWorker. The publisher is passed for checking cancellation and publishing intermediate result.

       List<CategorizedMenuItem> results = new ArrayList<>();
       for (CategorizedMenuItem item : ...) {
           if (publisher.isSearchCancelled()) {
               break;
           }
           results.add(item);
           publisher.publishSearch(results);
       }
       return results;
   

Note: the method is also called by selection of a searched menu item. Then the select is already set as the same value of the text.

Specified by:

getCandidates in interface SearchTextField.SearchTextFieldModel

Overrides:

getCandidates in class SearchTextFieldFilePath.SearchTextFieldModelFilePath

Parameters:

text - the input text

editable - whether the field is editable or not

publisher - the publisher for submitting the searched item

Returns:

the total results of searched items