Module org.autogui

Package org.autogui.swing.util

Class SearchTextFieldFilePath.SearchTextFieldModelFilePath

java.lang.Object

org.autogui.swing.util.SearchTextFieldFilePath.SearchTextFieldModelFilePath

All Implemented Interfaces:

SearchTextField.SearchTextFieldModel

Direct Known Subclasses:

GuiSwingTableColumnFilePath.SearchTextFieldModelFilePathEmpty

Enclosing class:

SearchTextFieldFilePath

public static class SearchTextFieldFilePath.SearchTextFieldModelFilePath
extends Object
implements SearchTextField.SearchTextFieldModel

the model definition for the completing file items

Field Summary

Fields

Modifier and Type	Field	Description
protected FileSystemView	iconSource
protected PopupCategorized.CategorizedMenuItem	selection

Constructor Summary

Constructors

Constructor	Description
SearchTextFieldModelFilePath()

Method Summary

Modifier and Type	Method	Description
int	compare(Path p1, Path p2)
List<PopupCategorized.CategorizedMenuItem>	getCandidates(String text, boolean editable, SearchTextField.SearchTextFieldPublisher publisher)	the method is executed under the background thread of SwingWorker.
List<SearchTextFieldFilePath.FileItem>	getChildItems(Path path)
List<SearchTextFieldFilePath.FileItem>	getCompletionItems(String text, Path path)
SearchTextFieldFilePath.FileItem	getDefaultCurrent()
List<SearchTextFieldFilePath.FileItem>	getDefaultItems()
SearchTextFieldFilePath.FileItem	getFileItem(Path path, String category, boolean nameOnly)
List<SearchTextFieldFilePath.FileItem>	getParentItems(Path path)
PopupCategorized.CategorizedMenuItem	getSelection()	After SearchTextField.SearchTextFieldModel.getCandidates(String, boolean, SearchTextField.SearchTextFieldPublisher), an exact matching item might be found, and then the method returns the item.
boolean	isFixedCategorySize()
void	select(PopupCategorized.CategorizedMenuItem item)	The method is executed under the event dispatching thread.
Path	setSelection(String text)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.autogui.swing.util.SearchTextField.SearchTextFieldModel

isBackgroundTask

Field Details

selection

protected PopupCategorized.CategorizedMenuItem selection

iconSource

protected FileSystemView iconSource

Constructor Details

SearchTextFieldModelFilePath

public SearchTextFieldModelFilePath()

Method Details

isFixedCategorySize

public boolean isFixedCategorySize()

Specified by:

isFixedCategorySize in interface SearchTextField.SearchTextFieldModel

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

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

setSelection

public Path setSelection(String text)

getCompletionItems

public List<SearchTextFieldFilePath.FileItem> getCompletionItems(String text,
 Path path)

getParentItems

public List<SearchTextFieldFilePath.FileItem> getParentItems(Path path)

getChildItems

public List<SearchTextFieldFilePath.FileItem> getChildItems(Path path)

compare

public int compare(Path p1,
 Path p2)

getDefaultItems

public List<SearchTextFieldFilePath.FileItem> getDefaultItems()

getDefaultCurrent

public SearchTextFieldFilePath.FileItem getDefaultCurrent()

getFileItem

public SearchTextFieldFilePath.FileItem getFileItem(Path path,
 String category,
 boolean nameOnly)

select

public void select(PopupCategorized.CategorizedMenuItem item)

Description copied from interface: SearchTextField.SearchTextFieldModel

The method is executed under the event dispatching thread. The user selects the item from a menu and then this method will be called.

Specified by:

select in interface SearchTextField.SearchTextFieldModel

Parameters:

item - the selected item

getSelection

public PopupCategorized.CategorizedMenuItem getSelection()

Description copied from interface: SearchTextField.SearchTextFieldModel

After SearchTextField.SearchTextFieldModel.getCandidates(String, boolean, SearchTextField.SearchTextFieldPublisher), an exact matching item might be found, and then the method returns the item. Otherwise, returns null. The method is executed under the event dispatching thread.

Specified by:

getSelection in interface SearchTextField.SearchTextFieldModel

Returns:

the exact matched item or null