Packagecom.adobe.indesign
Classpublic class LanguageWithVendors
InheritanceLanguageWithVendors Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  dictionaryPaths : Object
The user dictionaries for the language.
LanguageWithVendors
  doubleQuotes : String
The double quotes pair for the language.
LanguageWithVendors
  eventListeners : EventListeners
[read-only] A collection of event listeners.
LanguageWithVendors
  events : Events
[read-only] A collection of events.
LanguageWithVendors
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  hyphenationVendor : String
The hyphenation rules source.
LanguageWithVendors
  hyphenationVendorList : Object
[read-only] A list of hyphenation vendors.
LanguageWithVendors
  icuLocaleName : String
[read-only] The full name of the Language object's ICU locale.
LanguageWithVendors
  id : Number
[read-only] The unique ID of the LanguageWithVendors.
LanguageWithVendors
  index : Number
[read-only] The index of the LanguageWithVendors within its containing object.
LanguageWithVendors
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
LanguageWithVendors
  label : String
A property that can be set to any string.
LanguageWithVendors
  name : String
[read-only] The name of the LanguageWithVendors.
LanguageWithVendors
  parent : Application
[read-only] The parent of the LanguageWithVendors (a Application).
LanguageWithVendors
  properties : Object
A property that allows setting of several properties at the same time.
LanguageWithVendors
  singleQuotes : String
The single quotes pair for the language.
LanguageWithVendors
  spellingVendor : String
The spell-checking source.
LanguageWithVendors
  spellingVendorList : Object
[read-only] A list of spelling vendors.
LanguageWithVendors
  thesaurusVendor : String
The thesaurus source.
LanguageWithVendors
Public Methods
 MethodDefined By
  
addDictionaryPath(filePathParam:String = null):String
Adds the specified user dictionary.
LanguageWithVendors
  
addEventListenerLanguageWithVendors(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
LanguageWithVendors
  
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key.
LanguageWithVendors
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
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.
LanguageWithVendors
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
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
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
  
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key.
LanguageWithVendors
 Inherited
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
  
removeDictionaryPath(filePathParam:String = null):String
Removes the specified user dictionary.
LanguageWithVendors
  
removeEventListenerLanguageWithVendors(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
LanguageWithVendors
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
Retrieves the object specifier.
LanguageWithVendors
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
dictionaryPathsproperty
dictionaryPaths:Object

The user dictionaries for the language.


Implementation
    public function get dictionaryPaths():Object
    public function set dictionaryPaths(value:Object):void
doubleQuotesproperty 
doubleQuotes:String

The double quotes pair for the language.


Implementation
    public function get doubleQuotes():String
    public function set doubleQuotes(value:String):void
eventListenersproperty 
eventListeners:EventListeners  [read-only]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only]

A collection of events.


Implementation
    public function get events():Events
hyphenationVendorproperty 
hyphenationVendor:String

The hyphenation rules source.


Implementation
    public function get hyphenationVendor():String
    public function set hyphenationVendor(value:String):void
hyphenationVendorListproperty 
hyphenationVendorList:Object  [read-only]

A list of hyphenation vendors.


Implementation
    public function get hyphenationVendorList():Object
icuLocaleNameproperty 
icuLocaleName:String  [read-only]

The full name of the Language object's ICU locale.


Implementation
    public function get icuLocaleName():String
idproperty 
id:Number  [read-only]

The unique ID of the LanguageWithVendors.


Implementation
    public function get id():Number
indexproperty 
index:Number  [read-only]

The index of the LanguageWithVendors within its containing object.


Implementation
    public function get index():Number
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
labelproperty 
label:String

A property that can be set to any string.


Implementation
    public function get label():String
    public function set label(value:String):void
nameproperty 
name:String  [read-only]

The name of the LanguageWithVendors.


Implementation
    public function get name():String
parentproperty 
parent:Application  [read-only]

The parent of the LanguageWithVendors (a Application).


Implementation
    public function get parent():Application
propertiesproperty 
properties:Object

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
singleQuotesproperty 
singleQuotes:String

The single quotes pair for the language.


Implementation
    public function get singleQuotes():String
    public function set singleQuotes(value:String):void
spellingVendorproperty 
spellingVendor:String

The spell-checking source.


Implementation
    public function get spellingVendor():String
    public function set spellingVendor(value:String):void
spellingVendorListproperty 
spellingVendorList:Object  [read-only]

A list of spelling vendors.


Implementation
    public function get spellingVendorList():Object
thesaurusVendorproperty 
thesaurusVendor:String

The thesaurus source.


Implementation
    public function get thesaurusVendor():String
    public function set thesaurusVendor(value:String):void
Method Detail
addDictionaryPath()method
public function addDictionaryPath(filePathParam:String = null):String

Adds the specified user dictionary.

Parameters

filePathParam:String (default = null) — (String) The path to the dictionary file.

Returns
String
addEventListenerLanguageWithVendors()method 
public function addEventListenerLanguageWithVendors(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

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)

Returns
EventListener
extractLabel()method 
public function extractLabel(keyParam:String = null):String

Gets the label value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.

Returns
String
getElements()method 
public function getElements():Object

Resolves the object specifier, creating an array of object references.

Returns
Object
insertLabel()method 
public function insertLabel(keyParam:String = null, valueParam:String = null):void

Sets the label to the value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.
 
valueParam:String (default = null) — (String) The value.

removeDictionaryPath()method 
public function removeDictionaryPath(filePathParam:String = null):String

Removes the specified user dictionary.

Parameters

filePathParam:String (default = null) — (String) The path to the dictionary file.

Returns
String
removeEventListenerLanguageWithVendors()method 
public function removeEventListenerLanguageWithVendors(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

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)

Returns
Boolean
toSpecifier()method 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String