Package | com.adobe.indesign |
Class | public class XMLImportPreference |
Inheritance | XMLImportPreference ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined 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 | ||
![]() | hostObjectDelegate : 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 |
Method | Defined By | ||
---|---|---|---|
![]() | 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 | ||
![]() | 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 [override]
Resolves the object specifier, creating an array of object references. | XMLImportPreference | ||
![]() | 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 | |
![]() | 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 | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | XMLImportPreference | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
allowTransform | property |
allowTransform:Boolean
Since : | CS5 |
If true, transforms the XML using an XSLT file.
public function get allowTransform():Boolean
public function set allowTransform(value:Boolean):void
createLinkToXML | property |
createLinkToXML:Boolean
Since : | CS5 |
If true, creates a link to the imported XML file. If false, embeds the file.
public function get createLinkToXML():Boolean
public function set createLinkToXML(value:Boolean):void
eventListeners | property |
eventListeners:EventListeners
[read-only] [override] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] [override] Since : | CS5 |
A collection of events.
public function get events():Events
ignoreUnmatchedIncoming | property |
ignoreUnmatchedIncoming:Boolean
Since : | CS5 |
If true, ignores elements that do not match the existing structure. Note: Valid only when import style is merge.
public function get ignoreUnmatchedIncoming():Boolean
public function set ignoreUnmatchedIncoming(value:Boolean):void
ignoreWhitespace | property |
ignoreWhitespace:Boolean
Since : | CS5 |
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.
public function get ignoreWhitespace():Boolean
public function set ignoreWhitespace(value:Boolean):void
importCALSTables | property |
importCALSTables:Boolean
Since : | CS5 |
If true, imports CALS tables as InDesign tables.
public function get importCALSTables():Boolean
public function set importCALSTables(value:Boolean):void
importStyle | property |
importStyle:XMLImportStyles
Since : | CS5 |
The style of incorporating imported XML content into the document.
public function get importStyle():XMLImportStyles
public function set importStyle(value:XMLImportStyles):void
importTextIntoTables | property |
importTextIntoTables:Boolean
Since : | CS5 |
If true, imports text into tables if tags match placeholder tables and their cells. Note: Valid only when import style is merge.
public function get importTextIntoTables():Boolean
public function set importTextIntoTables(value:Boolean):void
importToSelected | property |
importToSelected:Boolean
Since : | CS5 |
If true, imports into the selected XML element. If false, imports at the root element.
public function get importToSelected():Boolean
public function set importToSelected(value:Boolean):void
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the XMLImportPreference (a Application or Document).
public function get parent():Object
properties | property |
properties:Object
[override] 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
removeUnmatchedExisting | property |
removeUnmatchedExisting:Boolean
Since : | CS5 |
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.
public function get removeUnmatchedExisting():Boolean
public function set removeUnmatchedExisting(value:Boolean):void
repeatTextElements | property |
repeatTextElements:Boolean
Since : | CS5 |
If true, repeating text elements inherit the formatting applied to placeholder text. Note: Valid only when import style is merge.
public function get repeatTextElements():Boolean
public function set repeatTextElements(value:Boolean):void
transformFilename | property |
transformFilename:Object
Since : | CS5 |
The name of the XSLT file. Note: Valid when allow transform is true. Can return: File or XMLTransformFile enumerator.
public function get transformFilename():Object
public function set transformFilename(value:Object):void
transformParameters | property |
transformParameters:Object
Since : | CS5 |
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.
public function get transformParameters():Object
public function set transformParameters(value:Object):void
addEventListenerXMLImportPreference | () | method |
public function addEventListenerXMLImportPreference(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 |
getElements | () | method |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
removeEventListenerXMLImportPreference | () | method |
public function removeEventListenerXMLImportPreference(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 |
toSpecifier | () | method |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |