Package | com.adobe.incopy |
Class | public class XMLExportPreference |
Inheritance | XMLExportPreference ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
allowTransform : Boolean
If true, transforms the XML using an XSLT file. | XMLExportPreference | ||
characterReferences : Boolean
If true, replaces special characters with character references. | XMLExportPreference | ||
copyFormattedImages : Boolean
If true, copies formatted images to the images subfolder. | XMLExportPreference | ||
copyOptimizedImages : Boolean
If true, copies optimized images to the images subfolder. | XMLExportPreference | ||
copyOriginalImages : Boolean
If true, copies original images to the images subfolder. | XMLExportPreference | ||
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | XMLExportPreference | ||
events : Events [override] [read-only]
A collection of events. | XMLExportPreference | ||
excludeDtd : Boolean
If true, excludes the DTD from the exported XML content. | XMLExportPreference | ||
exportFromSelected : Boolean
If true, exports XML content from the selected XML element. | XMLExportPreference | ||
exportUntaggedTablesFormat : XMLExportUntaggedTablesFormat
The export format for untagged tables in tagged stories. | XMLExportPreference | ||
fileEncoding : XMLFileEncoding
The file encoding type for exporting XML content. | XMLExportPreference | ||
gifOptionsInterlaced : Boolean
If true, generates interlaced GIFs. | XMLExportPreference | ||
gifOptionsPalette : GIFOptionsPalette
The color palette for GIF conversion. | XMLExportPreference | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
imageConversion : ImageConversion
The file format to use for converted images. | XMLExportPreference | ||
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | XMLExportPreference | ||
jpegOptionsFormat : JPEGOptionsFormat
The formatting method for converted JPEG images. | XMLExportPreference | ||
jpegOptionsQuality : JPEGOptionsQuality
The quality of converted JPEG images. | XMLExportPreference | ||
parent : Object [override] [read-only]
The parent of the XMLExportPreference (a Application or Document). | XMLExportPreference | ||
preferredBrowser : Object
The preferred browser for viewing XML. | XMLExportPreference | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | XMLExportPreference | ||
ruby : Boolean
If true, includes Ruby text in the exported XML content. | XMLExportPreference | ||
transformFilename : Object
The name of the XSLT file. | XMLExportPreference | ||
viewAfterExport : Boolean
If true, displays exported XML content in a specified viewer. | XMLExportPreference |
Method | Defined By | ||
---|---|---|---|
![]() | addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Preference | |
addEventListenerXMLExportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | XMLExportPreference | ||
![]() | 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. | XMLExportPreference | ||
![]() | 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 | |
removeEventListenerXMLExportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | XMLExportPreference | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | XMLExportPreference | ||
![]() | 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
characterReferences | property |
characterReferences:Boolean
Since : | CS5 |
If true, replaces special characters with character references.
public function get characterReferences():Boolean
public function set characterReferences(value:Boolean):void
copyFormattedImages | property |
copyFormattedImages:Boolean
Since : | CS5 |
If true, copies formatted images to the images subfolder.
public function get copyFormattedImages():Boolean
public function set copyFormattedImages(value:Boolean):void
copyOptimizedImages | property |
copyOptimizedImages:Boolean
Since : | CS5 |
If true, copies optimized images to the images subfolder.
public function get copyOptimizedImages():Boolean
public function set copyOptimizedImages(value:Boolean):void
copyOriginalImages | property |
copyOriginalImages:Boolean
Since : | CS5 |
If true, copies original images to the images subfolder.
public function get copyOriginalImages():Boolean
public function set copyOriginalImages(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
excludeDtd | property |
excludeDtd:Boolean
Since : | CS5 |
If true, excludes the DTD from the exported XML content.
public function get excludeDtd():Boolean
public function set excludeDtd(value:Boolean):void
exportFromSelected | property |
exportFromSelected:Boolean
Since : | CS5 |
If true, exports XML content from the selected XML element. If false, exports the entire document.
public function get exportFromSelected():Boolean
public function set exportFromSelected(value:Boolean):void
exportUntaggedTablesFormat | property |
exportUntaggedTablesFormat:XMLExportUntaggedTablesFormat
Since : | CS5 |
The export format for untagged tables in tagged stories.
public function get exportUntaggedTablesFormat():XMLExportUntaggedTablesFormat
public function set exportUntaggedTablesFormat(value:XMLExportUntaggedTablesFormat):void
fileEncoding | property |
fileEncoding:XMLFileEncoding
Since : | CS5 |
The file encoding type for exporting XML content.
public function get fileEncoding():XMLFileEncoding
public function set fileEncoding(value:XMLFileEncoding):void
gifOptionsInterlaced | property |
gifOptionsInterlaced:Boolean
Since : | CS5 |
If true, generates interlaced GIFs. Note: Not valid when image conversion is JPEG.
public function get gifOptionsInterlaced():Boolean
public function set gifOptionsInterlaced(value:Boolean):void
gifOptionsPalette | property |
gifOptionsPalette:GIFOptionsPalette
Since : | CS5 |
The color palette for GIF conversion. Note: Not valid when image conversion is JPEG.
public function get gifOptionsPalette():GIFOptionsPalette
public function set gifOptionsPalette(value:GIFOptionsPalette):void
imageConversion | property |
imageConversion:ImageConversion
Since : | CS5 |
The file format to use for converted images. Note: Valid only when copy optimized images and/or copy formatted images is true.
public function get imageConversion():ImageConversion
public function set imageConversion(value:ImageConversion):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
jpegOptionsFormat | property |
jpegOptionsFormat:JPEGOptionsFormat
Since : | CS5 |
The formatting method for converted JPEG images. Note: Not valid when image conversion is GIF.
public function get jpegOptionsFormat():JPEGOptionsFormat
public function set jpegOptionsFormat(value:JPEGOptionsFormat):void
jpegOptionsQuality | property |
jpegOptionsQuality:JPEGOptionsQuality
Since : | CS5 |
The quality of converted JPEG images. Note: Not valid when image conversion is GIF.
public function get jpegOptionsQuality():JPEGOptionsQuality
public function set jpegOptionsQuality(value:JPEGOptionsQuality):void
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the XMLExportPreference (a Application or Document).
public function get parent():Object
preferredBrowser | property |
preferredBrowser:Object
Since : | CS5 |
The preferred browser for viewing XML. Can return: File or NothingEnum enumerator.
public function get preferredBrowser():Object
public function set preferredBrowser(value:Object):void
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
ruby | property |
ruby:Boolean
Since : | CS5 |
If true, includes Ruby text in the exported XML content.
public function get ruby():Boolean
public function set ruby(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
viewAfterExport | property |
viewAfterExport:Boolean
Since : | CS5 |
If true, displays exported XML content in a specified viewer.
public function get viewAfterExport():Boolean
public function set viewAfterExport(value:Boolean):void
addEventListenerXMLExportPreference | () | method |
public function addEventListenerXMLExportPreference(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 |
removeEventListenerXMLExportPreference | () | method |
public function removeEventListenerXMLExportPreference(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 |