Packagecom.elad.framework.autosuggest
Classpublic class UIAutoSuggest
InheritanceUIAutoSuggest Inheritance AbstractAutoSuggest
ImplementsIUIAutoSuggestClient

Auto Suggest User interface handle the TileBase and TextInput related operations and events.



Public Properties
 PropertyDefined by
  input : TextInput
[write-only] Set the TextInput that will be used in the user interface
UIAutoSuggest
  output : TileBase
[write-only] Set the TileBase that will be used in the user interface.
UIAutoSuggest
 Inheritedresult : String
AbstractAutoSuggest
Protected Properties
 PropertyDefined by
 InheritedkeywordsList : Array
AbstractAutoSuggest
 InheritedsortedKeywordsList : Array
AbstractAutoSuggest
  textInput : TextInput
UIAutoSuggest
  tileList : TileBase
UIAutoSuggest
Public Methods
 MethodDefined by
 Inherited
convertXMLToArray(xml:XML):Array
Converts an xml list into an array.
AbstractAutoSuggest
 Inherited
Method to get the list of keyword after the list was sorted.
AbstractAutoSuggest
  
setKeywordsList(xml:XML):void
Method to feed the list of keywords.
UIAutoSuggest
 Inherited
sortList(text:String):Array
method to sort the list of keywords for specific letter/s or word/s.
AbstractAutoSuggest
Protected Methods
 MethodDefined by
  
ChangeEventHandler(event:Event):void
Event handler after a change in the input box is made.
UIAutoSuggest
  
Initiate the event listners.
UIAutoSuggest
  
ListKeyDownEventHandler(event:KeyboardEvent):void
Event handler to trace certain keyboard strokes in tile list.
UIAutoSuggest
  
ListMouseClickedEventHandler(event:MouseEvent):void
Event handler after a change in the tile list is made.
UIAutoSuggest
  
PressEnterEventHandler(event:FlexEvent):void
Event handler for user clicking the enter key.
UIAutoSuggest
 Inherited
removePunctuationAndSplitWords(text:String):Array
Remove punctuations and split words.
AbstractAutoSuggest
 Inherited
searchForTextInList(list:Array, text:String):Array
Search a list of words for a specific text.
AbstractAutoSuggest
  
selectedWord(word:String):void
Set the result.
UIAutoSuggest
 Inherited
stringContainsSubstringCheck(keyword:String, text:String):Boolean
Method to check for a letter/s whithin any part of the keyword.
AbstractAutoSuggest
 Inherited
substringBeginsWithString(keyword:String, text:String):Boolean
Method to check for a letter/s whithin the beginning of the keyword.
AbstractAutoSuggest
  
TextInputKeyboardEventHandler(event:KeyboardEvent):void
Event handler to trace certain keyboard strokes in text input.
UIAutoSuggest
  
Update the tile list information with the sorted list.
UIAutoSuggest
Property detail
inputproperty
input:TextInput  [write-only]

Set the TextInput that will be used in the user interface

Implementation
    public function set input(value:TextInput):void

See also

outputproperty 
output:TileBase  [write-only]

Set the TileBase that will be used in the user interface.

Implementation
    public function set output(value:TileBase):void

See also

textInputproperty 
protected var textInput:TextInput
tileListproperty 
protected var tileList:TileBase
Method detail
ChangeEventHandler()method
protected function ChangeEventHandler(event:Event):void

Event handler after a change in the input box is made.

Parameters
event:Event — the event returned with the value from the keyboard.
initEventListners()method 
protected function initEventListners():void

Initiate the event listners.

ListKeyDownEventHandler()method 
protected function ListKeyDownEventHandler(event:KeyboardEvent):void

Event handler to trace certain keyboard strokes in tile list.

Parameters
event:KeyboardEvent — The event returned with the value from the keyboard.
ListMouseClickedEventHandler()method 
protected function ListMouseClickedEventHandler(event:MouseEvent):void

Event handler after a change in the tile list is made.

Parameters
event:MouseEvent — The event returned with the value from the keyboard.
PressEnterEventHandler()method 
protected function PressEnterEventHandler(event:FlexEvent):void

Event handler for user clicking the enter key.

Parameters
event:FlexEvent — the event returned with the value from the keyboard.
selectedWord()method 
protected function selectedWord(word:String):void

Set the result. This method can also be changed to add an option to lunch coringorm event.

This method also set the text input to the value and closes the tile list.

Parameters
word:String — the keyword that need to be searched.
setKeywordsList()method 
public override function setKeywordsList(xml:XML):void

Method to feed the list of keywords.

Parameters
xml:XML — The XML which will be used as original list to sort from.
TextInputKeyboardEventHandler()method 
protected function TextInputKeyboardEventHandler(event:KeyboardEvent):void

Event handler to trace certain keyboard strokes in text input.

Parameters
event:KeyboardEvent — the event returned with the value from the keyboard.
updateTileListDataProivder()method 
protected function updateTileListDataProivder():void

Update the tile list information with the sorted list.