Packagecom.adobe.indesign
Classpublic class TextFramePreference
InheritanceTextFramePreference Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
TextFramePreference
  events : Events
[override] [read-only] A collection of events.
TextFramePreference
  firstBaselineOffset : FirstBaseline
The distance between the baseline of the text and the top inset of the text frame or cell.
TextFramePreference
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  ignoreWrap : Boolean
If true, ignores text wrap settings for drawn or placed objects in the text frame.
TextFramePreference
  insetSpacing : Object
The amount to offset text from the edges of the text frame, specified either as a single value applied uniformly to all sides of the text frame or as an array of 4 values in the format [top inset, left inset, bottom inset, right inset].
TextFramePreference
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
TextFramePreference
  minimumFirstBaselineOffset : Object
The minimum distance between the baseline of the text and the top inset of the text frame or cell.
TextFramePreference
  parent : Object
[override] [read-only] The parent of the TextFramePreference (a Application, Document, TextFrame or ObjectStyle).
TextFramePreference
  properties : Object
[override] A property that allows setting of several properties at the same time.
TextFramePreference
  textColumnCount : Number
The number of columns in the text frame.
TextFramePreference
  textColumnFixedWidth : Object
The column width of the columns in the text frame.
TextFramePreference
  textColumnGutter : Object
The space between columns in the text frame.
TextFramePreference
  useFixedColumnWidth : Boolean
If true, maintains column width when the text frame is resized.
TextFramePreference
  verticalBalanceColumns : Boolean
Vertically justify balanced across all columns.
TextFramePreference
  verticalJustification : VerticalJustification
The vertical alignment of the text content.
TextFramePreference
  verticalThreshold : Object
The maximum amount of vertical space between two paragraphs.
TextFramePreference
Public Methods
 MethodDefined By
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
  
addEventListenerTextFramePreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
TextFramePreference
 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.
TextFramePreference
 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
  
removeEventListenerTextFramePreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
TextFramePreference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
TextFramePreference
 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
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
firstBaselineOffsetproperty 
firstBaselineOffset:FirstBaseline

The distance between the baseline of the text and the top inset of the text frame or cell.


Implementation
    public function get firstBaselineOffset():FirstBaseline
    public function set firstBaselineOffset(value:FirstBaseline):void
ignoreWrapproperty 
ignoreWrap:Boolean

If true, ignores text wrap settings for drawn or placed objects in the text frame.


Implementation
    public function get ignoreWrap():Boolean
    public function set ignoreWrap(value:Boolean):void
insetSpacingproperty 
insetSpacing:Object

The amount to offset text from the edges of the text frame, specified either as a single value applied uniformly to all sides of the text frame or as an array of 4 values in the format [top inset, left inset, bottom inset, right inset]. Can return: Unit (0 - 8640 points) or Array of 4 Units (0 - 8640 points).


Implementation
    public function get insetSpacing():Object
    public function set insetSpacing(value:Object):void
isValidproperty 
isValid:Boolean  [read-only] [override]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
minimumFirstBaselineOffsetproperty 
minimumFirstBaselineOffset:Object

The minimum distance between the baseline of the text and the top inset of the text frame or cell.


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

The parent of the TextFramePreference (a Application, Document, TextFrame or ObjectStyle).


Implementation
    public function get parent():Object
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
textColumnCountproperty 
textColumnCount:Number

The number of columns in the text frame. Note: Depending on the value of use fixed column width, the number of columns can change automatically when the text frame size changes.


Implementation
    public function get textColumnCount():Number
    public function set textColumnCount(value:Number):void
textColumnFixedWidthproperty 
textColumnFixedWidth:Object

The column width of the columns in the text frame.


Implementation
    public function get textColumnFixedWidth():Object
    public function set textColumnFixedWidth(value:Object):void
textColumnGutterproperty 
textColumnGutter:Object

The space between columns in the text frame.


Implementation
    public function get textColumnGutter():Object
    public function set textColumnGutter(value:Object):void
useFixedColumnWidthproperty 
useFixedColumnWidth:Boolean

If true, maintains column width when the text frame is resized. If false, causes columns to resize when the text frame is resized. Note: When true, resizing the frame can change the number of columns in the frame.


Implementation
    public function get useFixedColumnWidth():Boolean
    public function set useFixedColumnWidth(value:Boolean):void
verticalBalanceColumnsproperty 
verticalBalanceColumns:Boolean

Vertically justify balanced across all columns.


Implementation
    public function get verticalBalanceColumns():Boolean
    public function set verticalBalanceColumns(value:Boolean):void
verticalJustificationproperty 
verticalJustification:VerticalJustification

The vertical alignment of the text content.


Implementation
    public function get verticalJustification():VerticalJustification
    public function set verticalJustification(value:VerticalJustification):void
verticalThresholdproperty 
verticalThreshold:Object

The maximum amount of vertical space between two paragraphs. Note: Valid only when vertical justification is justified; the specified amount is applied in addition to the space before or space after values defined for the paragraph.


Implementation
    public function get verticalThreshold():Object
    public function set verticalThreshold(value:Object):void
Method Detail
addEventListenerTextFramePreference()method
public function addEventListenerTextFramePreference(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
removeEventListenerTextFramePreference()method 
public function removeEventListenerTextFramePreference(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