Packagecom.adobe.indesign
Classpublic class XMLImportPreference
InheritanceXMLImportPreference Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  allowTransform : Boolean
If true, transforms the XML using an XSLT file.
XMLImportPreference
  createLinkToXML : Boolean
If true, creates a link to the imported XML file.
XMLImportPreference
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
XMLImportPreference
  events : Events
[override] [read-only] A collection of events.
XMLImportPreference
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  ignoreUnmatchedIncoming : Boolean
If true, ignores elements that do not match the existing structure.
XMLImportPreference
  ignoreWhitespace : Boolean
If true, leaves existing content in place if the matching XML content contains only whitespace characters such as a carriage return or a tab character.
XMLImportPreference
  importCALSTables : Boolean
If true, imports CALS tables as InDesign tables.
XMLImportPreference
  importStyle : XMLImportStyles
The style of incorporating imported XML content into the document.
XMLImportPreference
  importTextIntoTables : Boolean
If true, imports text into tables if tags match placeholder tables and their cells.
XMLImportPreference
  importToSelected : Boolean
If true, imports into the selected XML element.
XMLImportPreference
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
XMLImportPreference
  parent : Object
[override] [read-only] The parent of the XMLImportPreference (a Application or Document).
XMLImportPreference
  properties : Object
[override] A property that allows setting of several properties at the same time.
XMLImportPreference
  removeUnmatchedExisting : Boolean
If true, deletes existing elements or placeholders in the document that do not have matches in the XML file.
XMLImportPreference
  repeatTextElements : Boolean
If true, repeating text elements inherit the formatting applied to placeholder text.
XMLImportPreference
  transformFilename : Object
The name of the XSLT file.
XMLImportPreference
  transformParameters : Object
Stylesheet parameters as a list of name/value pairs in the format [[name, value], [name, value], ...].
XMLImportPreference
Public Methods
 MethodDefined By
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
  
addEventListenerXMLImportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
XMLImportPreference
 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.
XMLImportPreference
 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
  
removeEventListenerXMLImportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
XMLImportPreference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
XMLImportPreference
 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
allowTransformproperty
allowTransform:Boolean

If true, transforms the XML using an XSLT file.


Implementation
    public function get allowTransform():Boolean
    public function set allowTransform(value:Boolean):void
createLinkToXMLproperty 
createLinkToXML:Boolean

If true, creates a link to the imported XML file. If false, embeds the file.


Implementation
    public function get createLinkToXML():Boolean
    public function set createLinkToXML(value:Boolean):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
ignoreUnmatchedIncomingproperty 
ignoreUnmatchedIncoming:Boolean

If true, ignores elements that do not match the existing structure. Note: Valid only when import style is merge.


Implementation
    public function get ignoreUnmatchedIncoming():Boolean
    public function set ignoreUnmatchedIncoming(value:Boolean):void
ignoreWhitespaceproperty 
ignoreWhitespace:Boolean

If true, leaves existing content in place if the matching XML content contains only whitespace characters such as a carriage return or a tab character. Note: Valid only when import style is merge.


Implementation
    public function get ignoreWhitespace():Boolean
    public function set ignoreWhitespace(value:Boolean):void
importCALSTablesproperty 
importCALSTables:Boolean

If true, imports CALS tables as InDesign tables.


Implementation
    public function get importCALSTables():Boolean
    public function set importCALSTables(value:Boolean):void
importStyleproperty 
importStyle:XMLImportStyles

The style of incorporating imported XML content into the document.


Implementation
    public function get importStyle():XMLImportStyles
    public function set importStyle(value:XMLImportStyles):void
importTextIntoTablesproperty 
importTextIntoTables:Boolean

If true, imports text into tables if tags match placeholder tables and their cells. Note: Valid only when import style is merge.


Implementation
    public function get importTextIntoTables():Boolean
    public function set importTextIntoTables(value:Boolean):void
importToSelectedproperty 
importToSelected:Boolean

If true, imports into the selected XML element. If false, imports at the root element.


Implementation
    public function get importToSelected():Boolean
    public function set importToSelected(value:Boolean):void
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 XMLImportPreference (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
removeUnmatchedExistingproperty 
removeUnmatchedExisting:Boolean

If true, deletes existing elements or placeholders in the document that do not have matches in the XML file. Note: Valid only when import style is merge.


Implementation
    public function get removeUnmatchedExisting():Boolean
    public function set removeUnmatchedExisting(value:Boolean):void
repeatTextElementsproperty 
repeatTextElements:Boolean

If true, repeating text elements inherit the formatting applied to placeholder text. Note: Valid only when import style is merge.


Implementation
    public function get repeatTextElements():Boolean
    public function set repeatTextElements(value:Boolean):void
transformFilenameproperty 
transformFilename:Object

The name of the XSLT file. Note: Valid when allow transform is true. Can return: File or XMLTransformFile enumerator.


Implementation
    public function get transformFilename():Object
    public function set transformFilename(value:Object):void
transformParametersproperty 
transformParameters:Object

Stylesheet parameters as a list of name/value pairs in the format [[name, value], [name, value], ...]. Can return: Ordered array containing name:String, value:String.


Implementation
    public function get transformParameters():Object
    public function set transformParameters(value:Object):void
Method Detail
addEventListenerXMLImportPreference()method
public function addEventListenerXMLImportPreference(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
removeEventListenerXMLImportPreference()method 
public function removeEventListenerXMLImportPreference(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