Package | com.adobe.indesign |
Class | public class TextPreference |
Inheritance | TextPreference ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined 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 | ||
![]() | hostObjectDelegate : 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 |
Method | Defined By | ||
---|---|---|---|
![]() | 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 | ||
![]() | 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. | TextPreference | ||
![]() | 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 | |
removeEventListenerTextPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | TextPreference | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | TextPreference | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
abutTextToTextWrap | property |
abutTextToTextWrap:Boolean
Since : | CS5 |
If true, moves wrapped text to the next available leading increment below the text wrap objects (skip by leading).
public function get abutTextToTextWrap():Boolean
public function set abutTextToTextWrap(value:Boolean):void
addPages | property |
addPages:AddPageOptions
Since : | CS5 |
Specifies where to insert new pages in response to overset text.
public function get addPages():AddPageOptions
public function set addPages(value:AddPageOptions):void
baselineShiftKeyIncrement | property |
baselineShiftKeyIncrement:Object
Since : | CS5 |
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)
public function get baselineShiftKeyIncrement():Object
public function set baselineShiftKeyIncrement(value:Object):void
deleteEmptyPages | property |
deleteEmptyPages:Boolean
Since : | CS5 |
Enable auto-deletion of pages containing empty threaded text frames.
public function get deleteEmptyPages():Boolean
public function set deleteEmptyPages(value:Boolean):void
enableStylePreviewMode | property |
enableStylePreviewMode:Boolean
Since : | CS5 |
If true, highlights character and paragraph styles with colored backgrounds.
public function get enableStylePreviewMode():Boolean
public function set enableStylePreviewMode(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
highlightCustomSpacing | property |
highlightCustomSpacing:Boolean
Since : | CS5 |
If true, highlights custom kerned or tracked characters.
public function get highlightCustomSpacing():Boolean
public function set highlightCustomSpacing(value:Boolean):void
highlightHjViolations | property |
highlightHjViolations:Boolean
Since : | CS5 |
If true, highlights hyphenation and justification rule violations in the text.
public function get highlightHjViolations():Boolean
public function set highlightHjViolations(value:Boolean):void
highlightKeeps | property |
highlightKeeps:Boolean
Since : | CS5 |
If true, highlights paragraphs that violate keep options.
public function get highlightKeeps():Boolean
public function set highlightKeeps(value:Boolean):void
highlightKinsoku | property |
highlightKinsoku:Boolean
Since : | CS5 |
If true, uses on-screen highlighting to identify kinsoku.
public function get highlightKinsoku():Boolean
public function set highlightKinsoku(value:Boolean):void
highlightSubstitutedFonts | property |
highlightSubstitutedFonts:Boolean
Since : | CS5 |
If true, highlights missing fonts.
public function get highlightSubstitutedFonts():Boolean
public function set highlightSubstitutedFonts(value:Boolean):void
highlightSubstitutedGlyphs | property |
highlightSubstitutedGlyphs:Boolean
Since : | CS5 |
If true, highlights substituted glyphs.
public function get highlightSubstitutedGlyphs():Boolean
public function set highlightSubstitutedGlyphs(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
justifyTextWraps | property |
justifyTextWraps:Boolean
Since : | CS5 |
If true, justifies text around text wrap objects.
public function get justifyTextWraps():Boolean
public function set justifyTextWraps(value:Boolean):void
kerningKeyIncrement | property |
kerningKeyIncrement:Number
Since : | CS5 |
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)
public function get kerningKeyIncrement():Number
public function set kerningKeyIncrement(value:Number):void
leadingKeyIncrement | property |
leadingKeyIncrement:Object
Since : | CS5 |
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)
public function get leadingKeyIncrement():Object
public function set leadingKeyIncrement(value:Object):void
limitToMasterTextFrames | property |
limitToMasterTextFrames:Boolean
Since : | CS5 |
Restrict the adding of pages during smart text reflow to overridden master text frames.
public function get limitToMasterTextFrames():Boolean
public function set limitToMasterTextFrames(value:Boolean):void
linkTextFilesWhenImporting | property |
linkTextFilesWhenImporting:Boolean
Since : | CS5 |
If true, links placed text files and spreadsheet files. If false, embeds the files.
public function get linkTextFilesWhenImporting():Boolean
public function set linkTextFilesWhenImporting(value:Boolean):void
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the TextPreference (a Application or Document).
public function get parent():Object
preserveFacingPageSpreads | property |
preserveFacingPageSpreads:Boolean
Since : | CS5 |
Preserve left-hand and right-and pages when facing pages are enabled during smart text reflow.
public function get preserveFacingPageSpreads():Boolean
public function set preserveFacingPageSpreads(value:Boolean):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
showInvisibles | property |
showInvisibles:Boolean
Since : | CS5 |
If true, shows hidden characters.
public function get showInvisibles():Boolean
public function set showInvisibles(value:Boolean):void
smallCap | property |
smallCap:Number
Since : | CS5 |
The size of text formatted as small caps, specified as a percentage of the font size. (Range: 1 to 200)
public function get smallCap():Number
public function set smallCap(value:Number):void
smartTextReflow | property |
smartTextReflow:Boolean
Since : | CS5 |
If true, enable automatic adding and deleting of pages in response to text reflow.
public function get smartTextReflow():Boolean
public function set smartTextReflow(value:Boolean):void
subscriptPosition | property |
subscriptPosition:Number
Since : | CS5 |
The position of subscript characters, specified as a percentage of the regular leading. (Range: -500 to 500)
public function get subscriptPosition():Number
public function set subscriptPosition(value:Number):void
subscriptSize | property |
subscriptSize:Number
Since : | CS5 |
The size of subscript characters, specified as a percentage of the font size. (Range: 0 to 200)
public function get subscriptSize():Number
public function set subscriptSize(value:Number):void
superscriptPosition | property |
superscriptPosition:Number
Since : | CS5 |
The position of superscript characters, specified as a percentage of the regular leading. (Range: -500 to 500)
public function get superscriptPosition():Number
public function set superscriptPosition(value:Number):void
superscriptSize | property |
superscriptSize:Number
Since : | CS5 |
The size of superscript characters, specified as a percentage of the font size. (Range: 0 to 200)
public function get superscriptSize():Number
public function set superscriptSize(value:Number):void
typographersQuotes | property |
typographersQuotes:Boolean
Since : | CS5 |
If true, converts straight quotes to typographic quotes.
public function get typographersQuotes():Boolean
public function set typographersQuotes(value:Boolean):void
useCidMojikumi | property |
useCidMojikumi:Boolean
Since : | CS5 |
If true, uses the glyph CID to get the mojikumi class of the character.
public function get useCidMojikumi():Boolean
public function set useCidMojikumi(value:Boolean):void
useNewVerticalScaling | property |
useNewVerticalScaling:Boolean
Since : | CS5 |
If true, reverses X and Y scaling on Roman characters in vertical text.
public function get useNewVerticalScaling():Boolean
public function set useNewVerticalScaling(value:Boolean):void
useOpticalSize | property |
useOpticalSize:Boolean
Since : | CS5 |
If true, automatically selects the correct optical size.
public function get useOpticalSize():Boolean
public function set useOpticalSize(value:Boolean):void
useParagraphLeading | property |
useParagraphLeading:Boolean
Since : | CS5 |
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.
public function get useParagraphLeading():Boolean
public function set useParagraphLeading(value:Boolean):void
zOrderTextWrap | property |
zOrderTextWrap:Boolean
Since : | CS5 |
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.
public function get zOrderTextWrap():Boolean
public function set zOrderTextWrap(value:Boolean):void
addEventListenerTextPreference | () | method |
public function addEventListenerTextPreference(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 |
removeEventListenerTextPreference | () | method |
public function removeEventListenerTextPreference(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 |