org.biojava.nbio.structure.align.gui.autosuggest

Interface AutoSuggestProvider

All Known Implementing Classes:

DefaultAutoSuggestProvider, SCOPAutoSuggestProvider

public interface AutoSuggestProvider

A class that provides auto-completion suggestions for JAutoSuggest

Author:

AndreasPrlic

Method Summary

Modifier and Type	Method and Description
void	clear() reset all suggestions
int	getMaxNrSuggestions() Get the maximun nr of suggestions
java.util.Vector<java.lang.String>	getSuggestion(java.lang.String userInput) get a list of suggestions for a userInput
void	setMaxNrSuggestions(int maxNrSuggestions) set the maximum number of suggestions to return
void	stop() Interrupt searching for suggestions

Method Detail

getSuggestion

java.util.Vector<java.lang.String> getSuggestion(java.lang.String userInput)

get a list of suggestions for a userInput

Parameters:

userInput -

Returns:

list of suggestions

setMaxNrSuggestions

void setMaxNrSuggestions(int maxNrSuggestions)

set the maximum number of suggestions to return

Parameters:

maxNrSuggestions -

getMaxNrSuggestions

int getMaxNrSuggestions()

Get the maximun nr of suggestions

Returns:

maxNrSuggestions

clear

void clear()

reset all suggestions

stop

void stop()

Interrupt searching for suggestions