Packagecom.adobe.indesign
Classpublic class TextPreference
InheritanceTextPreference Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  abutTextToTextWrap : Boolean
If true, moves wrapped text to the next available leading increment below the text wrap objects (skip by leading).
TextPreference
  addPages : AddPageOptions
Specifies where to insert new pages in response to overset text.
TextPreference
  baselineShiftKeyIncrement : Object
The amount that the baseline shift increases each time the user presses the option/alt-shift-up arrow keys or decreases each time the user presses the option/alt-shift-down arrow keys.
TextPreference
  deleteEmptyPages : Boolean
Enable auto-deletion of pages containing empty threaded text frames.
TextPreference
  enableStylePreviewMode : Boolean
If true, highlights character and paragraph styles with colored backgrounds.
TextPreference
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
TextPreference
  events : Events
[override] [read-only] A collection of events.
TextPreference
  highlightCustomSpacing : Boolean
If true, highlights custom kerned or tracked characters.
TextPreference
  highlightHjViolations : Boolean
If true, highlights hyphenation and justification rule violations in the text.
TextPreference
  highlightKeeps : Boolean
If true, highlights paragraphs that violate keep options.
TextPreference
  highlightKinsoku : Boolean
If true, uses on-screen highlighting to identify kinsoku.
TextPreference
  highlightSubstitutedFonts : Boolean
If true, highlights missing fonts.
TextPreference
  highlightSubstitutedGlyphs : Boolean
If true, highlights substituted glyphs.
TextPreference
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
TextPreference
  justifyTextWraps : Boolean
If true, justifies text around text wrap objects.
TextPreference
  kerningKeyIncrement : Number
The amount the kerning value per 1000 ems increases each time the user presses of the option/alt-right arrow keys or decreases each time the user presses the option/alt-left arrow keys.
TextPreference
  leadingKeyIncrement : Object
The amount that leading increases each time the user presses the option/alt-up arrow keys or decreases each time the user presses the option/alt-down arrow keys.
TextPreference
  limitToMasterTextFrames : Boolean
Restrict the adding of pages during smart text reflow to overridden master text frames.
TextPreference
  linkTextFilesWhenImporting : Boolean
If true, links placed text files and spreadsheet files.
TextPreference
  parent : Object
[override] [read-only] The parent of the TextPreference (a Application or Document).
TextPreference
  preserveFacingPageSpreads : Boolean
Preserve left-hand and right-and pages when facing pages are enabled during smart text reflow.
TextPreference
  properties : Object
[override] A property that allows setting of several properties at the same time.
TextPreference
  showInvisibles : Boolean
If true, shows hidden characters.
TextPreference
  smallCap : Number
The size of text formatted as small caps, specified as a percentage of the font size.
TextPreference
  smartTextReflow : Boolean
If true, enable automatic adding and deleting of pages in response to text reflow.
TextPreference
  subscriptPosition : Number
The position of subscript characters, specified as a percentage of the regular leading.
TextPreference
  subscriptSize : Number
The size of subscript characters, specified as a percentage of the font size.
TextPreference
  superscriptPosition : Number
The position of superscript characters, specified as a percentage of the regular leading.
TextPreference
  superscriptSize : Number
The size of superscript characters, specified as a percentage of the font size.
TextPreference
  typographersQuotes : Boolean
If true, converts straight quotes to typographic quotes.
TextPreference
  useCidMojikumi : Boolean
If true, uses the glyph CID to get the mojikumi class of the character.
TextPreference
  useNewVerticalScaling : Boolean
If true, reverses X and Y scaling on Roman characters in vertical text.
TextPreference
  useOpticalSize : Boolean
If true, automatically selects the correct optical size.
TextPreference
  useParagraphLeading : Boolean
If true, applies the leading changes made to a text range to the entire paragraph.
TextPreference
  zOrderTextWrap : Boolean
If true, text wrap does not affect text on layers above the layer that contains the text wrap object.
TextPreference
Public Methods
 MethodDefined By
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
  
addEventListenerTextPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
TextPreference
 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.
TextPreference
 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
  
removeEventListenerTextPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
TextPreference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
TextPreference
 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
abutTextToTextWrapproperty
abutTextToTextWrap:Boolean

If true, moves wrapped text to the next available leading increment below the text wrap objects (skip by leading).


Implementation
    public function get abutTextToTextWrap():Boolean
    public function set abutTextToTextWrap(value:Boolean):void
addPagesproperty 
addPages:AddPageOptions

Specifies where to insert new pages in response to overset text.


Implementation
    public function get addPages():AddPageOptions
    public function set addPages(value:AddPageOptions):void
baselineShiftKeyIncrementproperty 
baselineShiftKeyIncrement:Object

The amount that the baseline shift increases each time the user presses the option/alt-shift-up arrow keys or decreases each time the user presses the option/alt-shift-down arrow keys. (Range: .001 to 100)


Implementation
    public function get baselineShiftKeyIncrement():Object
    public function set baselineShiftKeyIncrement(value:Object):void
deleteEmptyPagesproperty 
deleteEmptyPages:Boolean

Enable auto-deletion of pages containing empty threaded text frames.


Implementation
    public function get deleteEmptyPages():Boolean
    public function set deleteEmptyPages(value:Boolean):void
enableStylePreviewModeproperty 
enableStylePreviewMode:Boolean

If true, highlights character and paragraph styles with colored backgrounds.


Implementation
    public function get enableStylePreviewMode():Boolean
    public function set enableStylePreviewMode(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
highlightCustomSpacingproperty 
highlightCustomSpacing:Boolean

If true, highlights custom kerned or tracked characters.


Implementation
    public function get highlightCustomSpacing():Boolean
    public function set highlightCustomSpacing(value:Boolean):void
highlightHjViolationsproperty 
highlightHjViolations:Boolean

If true, highlights hyphenation and justification rule violations in the text.


Implementation
    public function get highlightHjViolations():Boolean
    public function set highlightHjViolations(value:Boolean):void
highlightKeepsproperty 
highlightKeeps:Boolean

If true, highlights paragraphs that violate keep options.


Implementation
    public function get highlightKeeps():Boolean
    public function set highlightKeeps(value:Boolean):void
highlightKinsokuproperty 
highlightKinsoku:Boolean

If true, uses on-screen highlighting to identify kinsoku.


Implementation
    public function get highlightKinsoku():Boolean
    public function set highlightKinsoku(value:Boolean):void
highlightSubstitutedFontsproperty 
highlightSubstitutedFonts:Boolean

If true, highlights missing fonts.


Implementation
    public function get highlightSubstitutedFonts():Boolean
    public function set highlightSubstitutedFonts(value:Boolean):void
highlightSubstitutedGlyphsproperty 
highlightSubstitutedGlyphs:Boolean

If true, highlights substituted glyphs.


Implementation
    public function get highlightSubstitutedGlyphs():Boolean
    public function set highlightSubstitutedGlyphs(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
justifyTextWrapsproperty 
justifyTextWraps:Boolean

If true, justifies text around text wrap objects.


Implementation
    public function get justifyTextWraps():Boolean
    public function set justifyTextWraps(value:Boolean):void
kerningKeyIncrementproperty 
kerningKeyIncrement:Number

The amount the kerning value per 1000 ems increases each time the user presses of the option/alt-right arrow keys or decreases each time the user presses the option/alt-left arrow keys. (Range: 1 to 100)


Implementation
    public function get kerningKeyIncrement():Number
    public function set kerningKeyIncrement(value:Number):void
leadingKeyIncrementproperty 
leadingKeyIncrement:Object

The amount that leading increases each time the user presses the option/alt-up arrow keys or decreases each time the user presses the option/alt-down arrow keys. (Range: .001 to 100)


Implementation
    public function get leadingKeyIncrement():Object
    public function set leadingKeyIncrement(value:Object):void
limitToMasterTextFramesproperty 
limitToMasterTextFrames:Boolean

Restrict the adding of pages during smart text reflow to overridden master text frames.


Implementation
    public function get limitToMasterTextFrames():Boolean
    public function set limitToMasterTextFrames(value:Boolean):void
linkTextFilesWhenImportingproperty 
linkTextFilesWhenImporting:Boolean

If true, links placed text files and spreadsheet files. If false, embeds the files.


Implementation
    public function get linkTextFilesWhenImporting():Boolean
    public function set linkTextFilesWhenImporting(value:Boolean):void
parentproperty 
parent:Object  [read-only] [override]

The parent of the TextPreference (a Application or Document).


Implementation
    public function get parent():Object
preserveFacingPageSpreadsproperty 
preserveFacingPageSpreads:Boolean

Preserve left-hand and right-and pages when facing pages are enabled during smart text reflow.


Implementation
    public function get preserveFacingPageSpreads():Boolean
    public function set preserveFacingPageSpreads(value:Boolean):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
showInvisiblesproperty 
showInvisibles:Boolean

If true, shows hidden characters.


Implementation
    public function get showInvisibles():Boolean
    public function set showInvisibles(value:Boolean):void
smallCapproperty 
smallCap:Number

The size of text formatted as small caps, specified as a percentage of the font size. (Range: 1 to 200)


Implementation
    public function get smallCap():Number
    public function set smallCap(value:Number):void
smartTextReflowproperty 
smartTextReflow:Boolean

If true, enable automatic adding and deleting of pages in response to text reflow.


Implementation
    public function get smartTextReflow():Boolean
    public function set smartTextReflow(value:Boolean):void
subscriptPositionproperty 
subscriptPosition:Number

The position of subscript characters, specified as a percentage of the regular leading. (Range: -500 to 500)


Implementation
    public function get subscriptPosition():Number
    public function set subscriptPosition(value:Number):void
subscriptSizeproperty 
subscriptSize:Number

The size of subscript characters, specified as a percentage of the font size. (Range: 0 to 200)


Implementation
    public function get subscriptSize():Number
    public function set subscriptSize(value:Number):void
superscriptPositionproperty 
superscriptPosition:Number

The position of superscript characters, specified as a percentage of the regular leading. (Range: -500 to 500)


Implementation
    public function get superscriptPosition():Number
    public function set superscriptPosition(value:Number):void
superscriptSizeproperty 
superscriptSize:Number

The size of superscript characters, specified as a percentage of the font size. (Range: 0 to 200)


Implementation
    public function get superscriptSize():Number
    public function set superscriptSize(value:Number):void
typographersQuotesproperty 
typographersQuotes:Boolean

If true, converts straight quotes to typographic quotes.


Implementation
    public function get typographersQuotes():Boolean
    public function set typographersQuotes(value:Boolean):void
useCidMojikumiproperty 
useCidMojikumi:Boolean

If true, uses the glyph CID to get the mojikumi class of the character.


Implementation
    public function get useCidMojikumi():Boolean
    public function set useCidMojikumi(value:Boolean):void
useNewVerticalScalingproperty 
useNewVerticalScaling:Boolean

If true, reverses X and Y scaling on Roman characters in vertical text.


Implementation
    public function get useNewVerticalScaling():Boolean
    public function set useNewVerticalScaling(value:Boolean):void
useOpticalSizeproperty 
useOpticalSize:Boolean

If true, automatically selects the correct optical size.


Implementation
    public function get useOpticalSize():Boolean
    public function set useOpticalSize(value:Boolean):void
useParagraphLeadingproperty 
useParagraphLeading:Boolean

If true, applies the leading changes made to a text range to the entire paragraph. If false, applies leading changes only to the text range.


Implementation
    public function get useParagraphLeading():Boolean
    public function set useParagraphLeading(value:Boolean):void
zOrderTextWrapproperty 
zOrderTextWrap:Boolean

If true, text wrap does not affect text on layers above the layer that contains the text wrap object. If false, text wrap affects text on all visible layers.


Implementation
    public function get zOrderTextWrap():Boolean
    public function set zOrderTextWrap(value:Boolean):void
Method Detail
addEventListenerTextPreference()method
public function addEventListenerTextPreference(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
removeEventListenerTextPreference()method 
public function removeEventListenerTextPreference(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