Packagecom.adobe.indesign
Classpublic class XMLPreference
InheritanceXMLPreference Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  defaultCellTagColor : Object
The color of the default cell tag, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color.
XMLPreference
  defaultCellTagName : String
The name of the default tag to use for new table cell elements.
XMLPreference
  defaultImageTagColor : Object
The color to give a new image tag, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color.
XMLPreference
  defaultImageTagName : String
The default name for new image elements created automatically.
XMLPreference
  defaultStoryTagColor : Object
The color of the default story tag, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color.
XMLPreference
  defaultStoryTagName : String
The name of the default tag to use for new story elements.
XMLPreference
  defaultTableTagColor : Object
The color of the default table tag, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color.
XMLPreference
  defaultTableTagName : String
The name of the default tag to use for new table elements.
XMLPreference
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
XMLPreference
  events : Events
[override] [read-only] A collection of events.
XMLPreference
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
XMLPreference
  parent : Object
[override] [read-only] The parent of the XMLPreference (a Application or Document).
XMLPreference
  properties : Object
[override] A property that allows setting of several properties at the same time.
XMLPreference
Public Methods
 MethodDefined By
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
  
addEventListenerXMLPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
XMLPreference
 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
[override] Resolves the object specifier, creating an array of object references.
XMLPreference
 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
 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
 Inherited
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
  
removeEventListenerXMLPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
XMLPreference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
XMLPreference
 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
defaultCellTagColorproperty
defaultCellTagColor:Object

The color of the default cell tag, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Note: Valid only when default cell tag name value creates a new tag. Does not update the color of an existing tag. . Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.


Implementation
    public function get defaultCellTagColor():Object
    public function set defaultCellTagColor(value:Object):void
defaultCellTagNameproperty 
defaultCellTagName:String

The name of the default tag to use for new table cell elements. Note: Either specifies an existing tag or creates a new tag.


Implementation
    public function get defaultCellTagName():String
    public function set defaultCellTagName(value:String):void
defaultImageTagColorproperty 
defaultImageTagColor:Object

The color to give a new image tag, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Note: Used only when the tag needs to be created. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.


Implementation
    public function get defaultImageTagColor():Object
    public function set defaultImageTagColor(value:Object):void
defaultImageTagNameproperty 
defaultImageTagName:String

The default name for new image elements created automatically.


Implementation
    public function get defaultImageTagName():String
    public function set defaultImageTagName(value:String):void
defaultStoryTagColorproperty 
defaultStoryTagColor:Object

The color of the default story tag, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Notes: Valid only when default story tag name value creates a new tag. Does not update the color of an existing tag. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.


Implementation
    public function get defaultStoryTagColor():Object
    public function set defaultStoryTagColor(value:Object):void
defaultStoryTagNameproperty 
defaultStoryTagName:String

The name of the default tag to use for new story elements. Note: Either specifies an existing tag or creates a new tag.


Implementation
    public function get defaultStoryTagName():String
    public function set defaultStoryTagName(value:String):void
defaultTableTagColorproperty 
defaultTableTagColor:Object

The color of the default table tag, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Notes: Valid only when default table tag name value creates a new tag. Does not update the color of an existing tag. . Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.


Implementation
    public function get defaultTableTagColor():Object
    public function set defaultTableTagColor(value:Object):void
defaultTableTagNameproperty 
defaultTableTagName:String

The name of the default tag to use for new table elements. Note: Either specifies an existing tag or creates a new tag.


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

A collection of event listeners.


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

A collection of events.


Implementation
    public function get events():Events
isValidproperty 
isValid:Boolean  [read-only] [override]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
parentproperty 
parent:Object  [read-only] [override]

The parent of the XMLPreference (a Application or Document).


Implementation
    public function get parent():Object
propertiesproperty 
properties:Object[override]

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
Method Detail
addEventListenerXMLPreference()method
public function addEventListenerXMLPreference(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
getElements()method 
override public function getElements():Object

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

Returns
Object
removeEventListenerXMLPreference()method 
public function removeEventListenerXMLPreference(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 
override public function toSpecifier():String

Retrieves the object specifier.

Returns
String