Package | com.adobe.indesign |
Class | public class UserDictionary |
Inheritance | UserDictionary ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
addedWords : Object
A list of words added to the user dictionary. | UserDictionary | ||
eventListeners : EventListeners [read-only]
A collection of event listeners. | UserDictionary | ||
events : Events [read-only]
A collection of events. | UserDictionary | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
index : Number [read-only]
The index of the UserDictionary within its containing object. | UserDictionary | ||
isValid : Boolean [read-only]
Returns true if the object specifier resolves to valid objects. | UserDictionary | ||
name : String [read-only]
The name of the UserDictionary. | UserDictionary | ||
parent : Application [read-only]
The parent of the UserDictionary (a Application). | UserDictionary | ||
properties : Object
A property that allows setting of several properties at the same time. | UserDictionary | ||
removedWords : Object
A list of words removed from the user dictionary. | UserDictionary |
Method | Defined By | ||
---|---|---|---|
addEventListenerUserDictionary(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | UserDictionary | ||
addWord(addedWordsParam:Array = null, removedListParam:Boolean = false):void
Adds the specified words to the specified list in the dictionary. | UserDictionary | ||
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
![]() | getClassObjectForName(className:String):HostObject [static] This returns a "Class" object, meaning, a HostObject that can be used
to make static function calls or get static properties
| CSHostObject | |
getElements():Object
Resolves the object specifier, creating an array of object references. | UserDictionary | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):* [static]
Implements a safe get of a static property on the host
Used by for instance, all the enum implementations. | CSHostObject | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
![]() | isDescendedFrom(clz:Class, ancClass:Class):Boolean [static] Efficiently determines whether or not one class descends from
another in inheritance hierarchy- class relationships are cached
by the ClassUtils implementation-
(uses org.as3commons lib to quickly discover class hierarchy. | CSHostObject | |
removeEventListenerUserDictionary(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | UserDictionary | ||
removeWord(removedWordsParam:Array = null, removedListParam:Boolean = false):void
Removes the specified words from the specified list in the dictionary. | UserDictionary | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String
Retrieves the object specifier. | UserDictionary | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
addedWords | property |
addedWords:Object
Since : | CS5 |
A list of words added to the user dictionary.
public function get addedWords():Object
public function set addedWords(value:Object):void
eventListeners | property |
eventListeners:EventListeners
[read-only] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] Since : | CS5 |
A collection of events.
public function get events():Events
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the UserDictionary within its containing object.
public function get index():Number
isValid | property |
isValid:Boolean
[read-only] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
name | property |
name:String
[read-only] Since : | CS5 |
The name of the UserDictionary.
public function get name():String
parent | property |
parent:Application
[read-only] Since : | CS5 |
The parent of the UserDictionary (a Application).
public function get parent():Application
properties | property |
properties:Object
Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
removedWords | property |
removedWords:Object
Since : | CS5 |
A list of words removed from the user dictionary.
public function get removedWords():Object
public function set removedWords(value:Object):void
addEventListenerUserDictionary | () | method |
public function addEventListenerUserDictionary(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
Adds an event listener.
Parameters
eventTypeParam:String (default = null ) — (String) The event type.
| |
handlerParam:Object (default = null ) — (Object) The event handler. Can accept: File or JavaScript Function.
| |
capturesParam:Boolean (default = false ) — (Boolean) This parameter is obsolete. (Optional)
|
EventListener |
addWord | () | method |
public function addWord(addedWordsParam:Array = null, removedListParam:Boolean = false):void
Since : | CS5 |
Adds the specified words to the specified list in the dictionary.
Parameters
addedWordsParam:Array (default = null ) — (Array) The words to add.
| |
removedListParam:Boolean (default = false ) — (Boolean) If true, adds the words to the removed words list. If false or unspecified, adds the words to the added words list. (Optional)
|
getElements | () | method |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
removeEventListenerUserDictionary | () | method |
public function removeEventListenerUserDictionary(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
Removes the event listener.
Parameters
eventTypeParam:String (default = null ) — (String) The registered event type.
| |
handlerParam:Object (default = null ) — (Object) The registered event handler. Can accept: File or JavaScript Function.
| |
capturesParam:Boolean (default = false ) — (Boolean) This parameter is obsolete. (Optional)
|
Boolean |
removeWord | () | method |
public function removeWord(removedWordsParam:Array = null, removedListParam:Boolean = false):void
Since : | CS5 |
Removes the specified words from the specified list in the dictionary.
Parameters
removedWordsParam:Array (default = null ) — (Array) The words to remove.
| |
removedListParam:Boolean (default = false ) — (Boolean) If true, removes the words from the removed words list. If false or unspecified, removes the words from the added words list. (Optional)
|
toSpecifier | () | method |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |