Packagegs.util.autosuggest
Classpublic class AutoSuggestMatch

The AutoSuggestMatch class represents a matched search term that was found in an AutoSuggest instance.

It provide you with the unchanged original term from the auto suggest, as well as a highlighted term that is wrapped in HTML to provide you with a way to do highlighting

Consider this example of a "highlightedTerm":

 
  <span class='suggestedTerm'><span class="matchedLetters">Georg</span>e Bush</span>
  

In that example, the original term was "George Bush" and the matched part of the term was "Georg".

The highlightedTerm is provided specifically for working with textfields and styles. You can set the style of both the span class's to provide a highlight effect.



Public Properties
 PropertyDefined by
  highlightedTerm : String
An HTML representation of the term that provides a way to use styles on a textfield for highlights.
AutoSuggestMatch
  term : String
The un-changed full term from the auto suggest searchable terms.
AutoSuggestMatch
Public Methods
 MethodDefined by
  
AutoSuggestMatch(term:String, highlightedTerm:String)
Constructor for AutoSuggestMatch instances.
AutoSuggestMatch
  
dispose():void
Dispose of internal objects in memory.
AutoSuggestMatch
Property detail
highlightedTermproperty
public var highlightedTerm:String

An HTML representation of the term that provides a way to use styles on a textfield for highlights.


Example
A highlighted term string:
 
   <span class='suggestedTerm'><span class="matchedLetters">Georg</span>e Bush</span>
   

termproperty 
public var term:String

The un-changed full term from the auto suggest searchable terms.

Constructor detail
AutoSuggestMatch()constructor
public function AutoSuggestMatch(term:String, highlightedTerm:String)

Constructor for AutoSuggestMatch instances.

Parameters
term:String — The un-changed term from the auto suggest search terms.
 
highlightedTerm:String — An HTML wrapped representation of the term.
Method detail
dispose()method
public function dispose():void

Dispose of internal objects in memory.