AutocompleteComponent (Graphene: API for Components encapsulation using Page Fragments 2.0.0.Alpha3 API)

```
public interface AutocompleteComponent<T>
```
Autocomplete component represents an input with autocomplete function.

That is when you start typing, some suggestions are offered to you, which you can choose from, to fill in the input faster.

Author:

Juraj Huska

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`areSuggestionsAvailable()` Determines whether the suggestion list is visible, that is whether there are some suggestions rendered.
`boolean`	`autocompleteWithSuggestion(Suggestion<T> sugg)` Autocompletes the input with given suggestion
`boolean`	`autocompleteWithSuggestion(Suggestion<T> sugg, ScrollingType scrollingType)` Autocompletes the input with suggestion determined by param `sugg`, and the suggestion is chosen by the way determined by param `scrollingType`
`void`	`clear(ClearType... clearType)` Clears the input.
`void`	`finish()` Finishes the filling in the input, that is, fill in the input not by selecting from the suggestions list, but by direct typing in.
`List<Suggestion<T>>`	`getAllSuggestions()` Returns all suggestions available, also these which need to be scrolled down to be visible.
`String`	`getFirstInputValue()` Returns the first input value, the values are separated according to the currently set separator, default one is space.
`List<Suggestion<T>>`	`getFirstNSuggestions(int n)` Returns first n suggestions, that is the the first n most top suggestions, if there are some available.
`Suggestion<T>`	`getFirstSuggestion()` Returns the first suggestion if available, that is, the top suggestion from the list of suggestions.
`String`	`getInputValue()` Returns the current value of input
`List<String>`	`getInputValues()` Returns the list of the input values, the values are separated according to the currently set separator, default one is space.
`Suggestion<T>`	`getNthSuggestion(int order)` Returns the suggestion which is in order determined by param `order`.
`List<Suggestion<T>>`	`getSelectedSuggestions()` Returns the selected suggestions from the input, the way of suggestions separating is determined by the currently set separator, the default one is space.
`void`	`setSeparator(String regex)` Sets the separator of the input values.
`void`	`setSuggestionParser(SuggestionParser<T> parser)` Sets the suggestion parser.
`void`	`type(String value)` Types to the autocomplete input provided value and waits for suggestions.
`List<Suggestion<T>>`	`typeAndReturn(String value)` Types to the autocomplete input the provided string and returns the suggestions if available.

- Method Detail
  - areSuggestionsAvailable
```
boolean areSuggestionsAvailable()
```
    Determines whether the suggestion list is visible, that is whether there are some suggestions rendered.
    
    Returns:
    true when there are suggestions visible, false otherwise
  - clear
```
void clear(ClearType... clearType)
```
    Clears the input. The method of clearing can be passed as argument to determine the way the input will be cleared
    
    Parameters:
    clearType -
    
    Throws:
    
    IllegalArgumentException - when there is illegal number of arguements passed
  - finish
```
void finish()
```
    Finishes the filling in the input, that is, fill in the input not by selecting from the suggestions list, but by direct typing in.
  - getAllSuggestions
```
List<Suggestion<T>> getAllSuggestions()
```
    Returns all suggestions available, also these which need to be scrolled down to be visible. The suggestions value are determined according to the parser object which need to be set prior of executing this method.
    
    Returns:
    all suggestions or null if there are no suggestions
    
    Throws:
    
    IllegalStateException - if the suggestion parser was not set prior to execution of this method
  - getSelectedSuggestions
```
List<Suggestion<T>> getSelectedSuggestions()
```
    Returns the selected suggestions from the input, the way of suggestions separating is determined by the currently set separator, the default one is space.
    
    Note that it does not return the values of the input which was filled in directly, not by choosing from suggestion list.
    
    Returns:
    See Also:
    setSeparator(String)
  - getInputValues
```
List<String> getInputValues()
```
    Returns the list of the input values, the values are separated according to the currently set separator, default one is space.
    
    Returns:
    See Also:
    setSeparator(String)
  - getInputValue
```
String getInputValue()
```
    Returns the current value of input
    
    Returns:
  - getFirstInputValue
```
String getFirstInputValue()
```
    Returns the first input value, the values are separated according to the currently set separator, default one is space.
    
    Returns:
    See Also:
    setSeparator(String)
  - setSeparator
```
void setSeparator(String regex)
```
    Sets the separator of the input values. This separator is then used when retrieving input values.
    
    Parameters:
    regex -
  - setSuggestionParser
```
void setSuggestionParser(SuggestionParser<T> parser)
```
    Sets the suggestion parser. The default one is StringSuggestionParser
    
    The suggestion parser determines how can be value of suggestion parsed and the suggestion object created
    
    Parameters:
    parser -
  - getFirstNSuggestions
```
List<Suggestion<T>> getFirstNSuggestions(int n)
```
    Returns first n suggestions, that is the the first n most top suggestions, if there are some available. The suggestions are determined according to the suggestion parser, which was set prior of executing of this method.
    
    If there are no suggestions rendered null is returned.
    
    If the requested number of suggestions is bigger than the actual number of suggestions, then only available suggestions are returned.
    
    Returns:
    the first n suggestions or null if there are no suggestions
    
    Throws:
    
    IllegalStateException - if the suggestion parser was not set prior to execution of this method
  - getFirstSuggestion
```
Suggestion<T> getFirstSuggestion()
```
    Returns the first suggestion if available, that is, the top suggestion from the list of suggestions. If there are no suggestions, null is returned.
    
    Returns:
    the first suggestion from the list of suggestions, of no suggestions available null is returned
    
    Throws:
    
    IllegalStateException - if the suggestion parser was not set prior to execution of this method
  - getNthSuggestion
```
Suggestion<T> getNthSuggestion(int order)
```
    Returns the suggestion which is in order determined by param order. If there is no so many suggestions, then null is returned. Note that the suggestions are ordered from the top of the suggestion list and the ordering begins from 1.
    
    Parameters:
    order -
    
    Returns:
    the suggestion which order is determined by the param order or null if there is not such a suggestion
    
    Throws:
    
    IllegalStateException - if the suggestion parser was not set prior to execution of this method
  - type
```
void type(String value)
```
    Types to the autocomplete input provided value and waits for suggestions. If there are no suggestions available nothing happen.
    
    The wait timeout is determined by GUI_WAIT
    
    Parameters:
    value -
  - typeAndReturn
```
List<Suggestion<T>> typeAndReturn(String value)
```
    Types to the autocomplete input the provided string and returns the suggestions if available.
    
    That is it types the whole value of the param string to the input on which the autocomplete function is bound and returns all available suggestions. If there are no suggestions, null is returned.
    
    Parameters:
    value - the characters which are about to write to the autocomplete input
    
    Returns:
    list with all provided suggestions, if there are no suggestions after typing null is returned
    
    Throws:
    
    IllegalStateException - if the suggestion parser was not set prior to execution of this method
  - autocompleteWithSuggestion
```
boolean autocompleteWithSuggestion(Suggestion<T> sugg)
```
    Autocompletes the input with given suggestion
    
    That is it chooses the suggestion from the list of available suggestions. If that particular suggestion is not available, or there are no suggestions at all, then it is just ignored, and false is returned.
    
    Parameters:
    sugg - the suggestion, it will be autocompleted with
    
    Returns:
    true when it was successfully autocompleted by provided suggestion, false otherwise
    
    Throws:
    
    IllegalArgumentException - when suggestion is null
  - autocompleteWithSuggestion
```
boolean autocompleteWithSuggestion(Suggestion<T> sugg,
                                 ScrollingType scrollingType)
```
    Autocompletes the input with suggestion determined by param sugg, and the suggestion is chosen by the way determined by param scrollingType
    
    That is, it chooses the suggestion from the list of available suggestions. If that particular suggestion is not available, or there are no suggestions at all, then it is just ignored, and false is returned.
    
    Parameters:
    sugg - the suggestion, it will be autocompleted with
    scrollingType - the scrolling type of the suggestion selection
    
    Returns:
    true when it was successfully autocompleted by provided suggestion, false otherwise
    
    Throws:
    
    IllegalArgumentException - if sugg or scrollingType is null

Interface AutocompleteComponent<T>

Method Summary

Method Detail

areSuggestionsAvailable

clear

finish

getAllSuggestions

getSelectedSuggestions

getInputValues

getInputValue

getFirstInputValue

setSeparator

setSuggestionParser

getFirstNSuggestions

getFirstSuggestion

getNthSuggestion

type

typeAndReturn

autocompleteWithSuggestion

autocompleteWithSuggestion