Packagecom.adobe.indesign
Classpublic class TextImportPreference
InheritanceTextImportPreference Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  characterSet : TextImportCharacterSet
The computer language character set used to create the text file.
TextImportPreference
  convertSpacesIntoTabs : Boolean
If true, converts the specified number of spaces into a tab.
TextImportPreference
  dictionary : String
The dictionary to use for the imported text.
TextImportPreference
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
TextImportPreference
  events : Events
[override] [read-only] A collection of events.
TextImportPreference
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
TextImportPreference
  parent : Object
[override] [read-only] The parent of the TextImportPreference (a Application).
TextImportPreference
  platform : ImportPlatform
The platform used to create the imported text file.
TextImportPreference
  properties : Object
[override] A property that allows setting of several properties at the same time.
TextImportPreference
  spacesIntoTabsCount : Number
The number of spaces to convert to a tab.
TextImportPreference
  stripReturnsBetweenLines : Boolean
If true, the import filter removes extra carriage returns at the ends of lines.
TextImportPreference
  stripReturnsBetweenParagraphs : Boolean
If true, the import filter removes extra carriage returns between paragraphs.
TextImportPreference
  useTypographersQuotes : Boolean
If true, convert straight quotes and apostrophes in the imported text to typographic quotation marks and apostrophes.
TextImportPreference
Public Methods
 MethodDefined By
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
  
addEventListenerTextImportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
TextImportPreference
 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.
TextImportPreference
 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
  
removeEventListenerTextImportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
TextImportPreference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
TextImportPreference
 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
characterSetproperty
characterSet:TextImportCharacterSet

The computer language character set used to create the text file.


Implementation
    public function get characterSet():TextImportCharacterSet
    public function set characterSet(value:TextImportCharacterSet):void
convertSpacesIntoTabsproperty 
convertSpacesIntoTabs:Boolean

If true, converts the specified number of spaces into a tab. For information on specifying the number of spaces, see spaces into tabs count.


Implementation
    public function get convertSpacesIntoTabs():Boolean
    public function set convertSpacesIntoTabs(value:Boolean):void
dictionaryproperty 
dictionary:String

The dictionary to use for the imported text.


Implementation
    public function get dictionary():String
    public function set dictionary(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 TextImportPreference (a Application).


Implementation
    public function get parent():Object
platformproperty 
platform:ImportPlatform

The platform used to create the imported text file.


Implementation
    public function get platform():ImportPlatform
    public function set platform(value:ImportPlatform):void
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
spacesIntoTabsCountproperty 
spacesIntoTabsCount:Number

The number of spaces to convert to a tab. Note: Valid when convert spaces into tabs is true.


Implementation
    public function get spacesIntoTabsCount():Number
    public function set spacesIntoTabsCount(value:Number):void
stripReturnsBetweenLinesproperty 
stripReturnsBetweenLines:Boolean

If true, the import filter removes extra carriage returns at the ends of lines.


Implementation
    public function get stripReturnsBetweenLines():Boolean
    public function set stripReturnsBetweenLines(value:Boolean):void
stripReturnsBetweenParagraphsproperty 
stripReturnsBetweenParagraphs:Boolean

If true, the import filter removes extra carriage returns between paragraphs.


Implementation
    public function get stripReturnsBetweenParagraphs():Boolean
    public function set stripReturnsBetweenParagraphs(value:Boolean):void
useTypographersQuotesproperty 
useTypographersQuotes:Boolean

If true, convert straight quotes and apostrophes in the imported text to typographic quotation marks and apostrophes.


Implementation
    public function get useTypographersQuotes():Boolean
    public function set useTypographersQuotes(value:Boolean):void
Method Detail
addEventListenerTextImportPreference()method
public function addEventListenerTextImportPreference(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
removeEventListenerTextImportPreference()method 
public function removeEventListenerTextImportPreference(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