Package | com.adobe.incopy |
Class | public class XMLExportMap |
Inheritance | XMLExportMap ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
eventListeners : EventListeners [read-only]
A collection of event listeners. | XMLExportMap | ||
events : Events [read-only]
A collection of events. | XMLExportMap | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
includeEmptyStories : Boolean
If true, includes empty stories when mapping styles to tags. | XMLExportMap | ||
includeMasterPageStories : Boolean
If true, includes stories on master spreads when mapping styles to tags. | XMLExportMap | ||
includePasteboardStories : Boolean
If true, includes stories on the pasteboard when mapping styles to tags. | XMLExportMap | ||
index : Number [read-only]
The index of the XMLExportMap within its containing object. | XMLExportMap | ||
isValid : Boolean [read-only]
Returns true if the object specifier resolves to valid objects. | XMLExportMap | ||
mappedStyle : Object [read-only]
The style mapped to the XML tag. | XMLExportMap | ||
markupTag : XMLTag
The XML tag applied to the element. | XMLExportMap | ||
parent : Object [read-only]
The parent of the XMLExportMap (a Application or Document). | XMLExportMap | ||
properties : Object
A property that allows setting of several properties at the same time. | XMLExportMap |
Method | Defined By | ||
---|---|---|---|
addEventListenerXMLExportMap(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | XMLExportMap | ||
![]() | 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. | XMLExportMap | ||
![]() | 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 | |
remove():void
Deletes the XMLExportMap. | XMLExportMap | ||
removeEventListenerXMLExportMap(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | XMLExportMap | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String
Retrieves the object specifier. | XMLExportMap | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
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
includeEmptyStories | property |
includeEmptyStories:Boolean
Since : | CS5 |
If true, includes empty stories when mapping styles to tags.
public function get includeEmptyStories():Boolean
public function set includeEmptyStories(value:Boolean):void
includeMasterPageStories | property |
includeMasterPageStories:Boolean
Since : | CS5 |
If true, includes stories on master spreads when mapping styles to tags.
public function get includeMasterPageStories():Boolean
public function set includeMasterPageStories(value:Boolean):void
includePasteboardStories | property |
includePasteboardStories:Boolean
Since : | CS5 |
If true, includes stories on the pasteboard when mapping styles to tags.
public function get includePasteboardStories():Boolean
public function set includePasteboardStories(value:Boolean):void
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the XMLExportMap 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
mappedStyle | property |
mappedStyle:Object
[read-only] Since : | CS5 |
The style mapped to the XML tag. Can return: ParagraphStyle, CharacterStyle, TableStyle or CellStyle. Can also accept: String.
public function get mappedStyle():Object
markupTag | property |
markupTag:XMLTag
Since : | CS5 |
The XML tag applied to the element. Can also accept: String.
public function get markupTag():XMLTag
public function set markupTag(value:XMLTag):void
parent | property |
parent:Object
[read-only] Since : | CS5 |
The parent of the XMLExportMap (a Application or Document).
public function get parent():Object
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
addEventListenerXMLExportMap | () | method |
public function addEventListenerXMLExportMap(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 |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
remove | () | method |
public function remove():void
Since : | CS5 |
Deletes the XMLExportMap.
removeEventListenerXMLExportMap | () | method |
public function removeEventListenerXMLExportMap(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 |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |