Package | com.adobe.incopy |
Class | public class TextFramePreference |
Inheritance | TextFramePreference ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | TextFramePreference | ||
events : Events [override] [read-only]
A collection of events. | TextFramePreference | ||
firstBaselineOffset : FirstBaseline [read-only]
The distance between the baseline of the text and the top inset of the text frame or cell. | TextFramePreference | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
ignoreWrap : Boolean [read-only]
If true, ignores text wrap settings for drawn or placed objects in the text frame. | TextFramePreference | ||
insetSpacing : Object [read-only]
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 [read-only]
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 or TextFrame). | TextFramePreference | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | TextFramePreference | ||
textColumnCount : Number [read-only]
The number of columns in the text frame. | TextFramePreference | ||
textColumnFixedWidth : Object [read-only]
The column width of the columns in the text frame. | TextFramePreference | ||
textColumnGutter : Object [read-only]
The space between columns in the text frame. | TextFramePreference | ||
useFixedColumnWidth : Boolean [read-only]
If true, maintains column width when the text frame is resized. | TextFramePreference | ||
verticalBalanceColumns : Boolean
Vertically justify balanced across all columns. | TextFramePreference | ||
verticalJustification : VerticalJustification [read-only]
The vertical alignment of the text content. | TextFramePreference | ||
verticalThreshold : Object [read-only]
The maximum amount of vertical space between two paragraphs. | TextFramePreference |
Method | Defined By | ||
---|---|---|---|
![]() | 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 | ||
![]() | 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. | TextFramePreference | ||
![]() | 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 | |
removeEventListenerTextFramePreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | TextFramePreference | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | TextFramePreference | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
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
firstBaselineOffset | property |
firstBaselineOffset:FirstBaseline
[read-only] Since : | CS5 |
The distance between the baseline of the text and the top inset of the text frame or cell.
public function get firstBaselineOffset():FirstBaseline
ignoreWrap | property |
ignoreWrap:Boolean
[read-only] Since : | CS5 |
If true, ignores text wrap settings for drawn or placed objects in the text frame.
public function get ignoreWrap():Boolean
insetSpacing | property |
insetSpacing:Object
[read-only] Since : | CS5 |
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).
public function get insetSpacing():Object
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
minimumFirstBaselineOffset | property |
minimumFirstBaselineOffset:Object
[read-only] Since : | CS5 |
The minimum distance between the baseline of the text and the top inset of the text frame or cell.
public function get minimumFirstBaselineOffset():Object
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the TextFramePreference (a Application, Document or TextFrame).
public function get parent():Object
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
textColumnCount | property |
textColumnCount:Number
[read-only] Since : | CS5 |
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.
public function get textColumnCount():Number
textColumnFixedWidth | property |
textColumnFixedWidth:Object
[read-only] Since : | CS5 |
The column width of the columns in the text frame.
public function get textColumnFixedWidth():Object
textColumnGutter | property |
textColumnGutter:Object
[read-only] Since : | CS5 |
The space between columns in the text frame.
public function get textColumnGutter():Object
useFixedColumnWidth | property |
useFixedColumnWidth:Boolean
[read-only] Since : | CS5 |
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.
public function get useFixedColumnWidth():Boolean
verticalBalanceColumns | property |
verticalBalanceColumns:Boolean
Since : | CS5 |
Vertically justify balanced across all columns.
public function get verticalBalanceColumns():Boolean
public function set verticalBalanceColumns(value:Boolean):void
verticalJustification | property |
verticalJustification:VerticalJustification
[read-only] Since : | CS5 |
The vertical alignment of the text content.
public function get verticalJustification():VerticalJustification
verticalThreshold | property |
verticalThreshold:Object
[read-only] Since : | CS5 |
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.
public function get verticalThreshold():Object
addEventListenerTextFramePreference | () | method |
public function addEventListenerTextFramePreference(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 |
removeEventListenerTextFramePreference | () | method |
public function removeEventListenerTextFramePreference(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 |