| Package | com.adobe.linguistics.spelling |
| Class | public class UserDictionary |
| Inheritance | UserDictionary  Object |
This class represents a user dictionary that is used by the SpellingService class. This class itself is an in-memory object
and doesn't store persistent data. However, developers can import/export a UserDictionary object from/to a vector of String,
and use other flash classes to keep the data persistent. You may want to consider using one of the following options for permanent storage:
If you are using our SpellingUI class the UserDictionary will be created behind the scene and stored in a SharedObject.
| Property | Defined By | ||
|---|---|---|---|
| wordList : Vector.<String> [read-only]
All words in this user dictionary. | UserDictionary | ||
| Method | Defined By | ||
|---|---|---|---|
UserDictionary(wordList:Vector.<String> = null)
Constructs a new UserDictionary which can later be added to a SpellingService object. | UserDictionary | ||
addWord(word:String):Boolean
Add a word to the user dictionary. | UserDictionary | ||
removeWord(word:String):Boolean
Removes a word from the user dicitonary. | UserDictionary | ||
| wordList | property |
wordList:Vector.<String> [read-only] All words in this user dictionary.
public function get wordList():Vector.<String>| UserDictionary | () | Constructor |
public function UserDictionary(wordList:Vector.<String> = null)
Constructs a new UserDictionary which can later be added to a SpellingService object.
wordList:Vector.<String> (default = null)UserDictionary
|
See also
| addWord | () | method |
public function addWord(word:String):BooleanAdd a word to the user dictionary.
Parameters
word:String — A word to be added to this UserDictionary.
|
Boolean — true if the operation is successful. false if the operation is failed, for example if the word is already added.
|
See also
| removeWord | () | method |
public function removeWord(word:String):BooleanRemoves a word from the user dicitonary.
Parameters
word:String — A word to be removed from this UserDictionary.
|
Boolean — True if the operation was successful, false if the operation was failed, for example if the word doesn't exist in the dictionary.
|
See also