Package | com.adobe.incopy |
Class | public class TextWrapPreference |
Inheritance | TextWrapPreference ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
applyToMasterPageOnly : Boolean
If true, text wraps on the master spread apply to that spread only, and not to any pages the master spread has been applied to. | TextWrapPreference | ||
contourOptions : ContourOption [read-only]
The contour of the text wrap. | TextWrapPreference | ||
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | TextWrapPreference | ||
events : Events [override] [read-only]
A collection of events. | TextWrapPreference | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
inverse : Boolean
If true, inverts the text wrap. | TextWrapPreference | ||
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | TextWrapPreference | ||
parent : Object [override] [read-only]
The parent of the TextWrapPreference (a PageItem, FormField, MultiStateObject, Button, MediaItem, Sound, Movie, EPSText, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Graphic, ImportedPage, PICT, WMF, PDF, EPS, Image, Group, TextFrame, Application or Document). | TextWrapPreference | ||
paths : Paths [read-only]
A collection of paths. | TextWrapPreference | ||
preferences : Preferences [read-only]
A collection of preferences objects. | TextWrapPreference | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | TextWrapPreference | ||
textWrapMode : TextWrapModes
The text wrap mode. | TextWrapPreference | ||
textWrapOffset : Object
The minimum space between text and the edges of the wrapped object. | TextWrapPreference | ||
textWrapSide : TextWrapSideOptions
Text wrap side options. | TextWrapPreference | ||
userModifiedWrap : Boolean [read-only]
If true, the text wrap path has been explicitly modified by the user. | TextWrapPreference |
Method | Defined By | ||
---|---|---|---|
![]() | addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Preference | |
addEventListenerTextWrapPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | TextWrapPreference | ||
![]() | 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. | TextWrapPreference | ||
![]() | 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 | |
removeEventListenerTextWrapPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | TextWrapPreference | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | TextWrapPreference | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
applyToMasterPageOnly | property |
applyToMasterPageOnly:Boolean
Since : | CS5 |
If true, text wraps on the master spread apply to that spread only, and not to any pages the master spread has been applied to.
public function get applyToMasterPageOnly():Boolean
public function set applyToMasterPageOnly(value:Boolean):void
contourOptions | property |
contourOptions:ContourOption
[read-only] Since : | CS5 |
The contour of the text wrap. Valid only when when text wrap type is contour.
public function get contourOptions():ContourOption
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
inverse | property |
inverse:Boolean
Since : | CS5 |
If true, inverts the text wrap.
public function get inverse():Boolean
public function set inverse(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
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the TextWrapPreference (a PageItem, FormField, MultiStateObject, Button, MediaItem, Sound, Movie, EPSText, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Graphic, ImportedPage, PICT, WMF, PDF, EPS, Image, Group, TextFrame, Application or Document).
public function get parent():Object
paths | property |
paths:Paths
[read-only] Since : | CS5 |
A collection of paths.
public function get paths():Paths
preferences | property |
preferences:Preferences
[read-only] Since : | CS5 |
A collection of preferences objects.
public function get preferences():Preferences
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
textWrapMode | property |
textWrapMode:TextWrapModes
Since : | CS5 |
The text wrap mode.
public function get textWrapMode():TextWrapModes
public function set textWrapMode(value:TextWrapModes):void
textWrapOffset | property |
textWrapOffset:Object
Since : | CS5 |
The minimum space between text and the edges of the wrapped object. The format for defining text wrap offset values depends on the text wrap type. If text wrap type is jump object text wrap, specify 2 values in the format [top, bottom]. If text wrap type is next column text wrap or contour, specify a single value. For bounding box text wrap, specify 4 values in the format in the format [top, left, bottom, right]. . Can return: Unit, Array of Units or NothingEnum enumerator.
public function get textWrapOffset():Object
public function set textWrapOffset(value:Object):void
textWrapSide | property |
textWrapSide:TextWrapSideOptions
Since : | CS5 |
Text wrap side options.
public function get textWrapSide():TextWrapSideOptions
public function set textWrapSide(value:TextWrapSideOptions):void
userModifiedWrap | property |
userModifiedWrap:Boolean
[read-only] Since : | CS5 |
If true, the text wrap path has been explicitly modified by the user.
public function get userModifiedWrap():Boolean
addEventListenerTextWrapPreference | () | method |
public function addEventListenerTextWrapPreference(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 |
removeEventListenerTextWrapPreference | () | method |
public function removeEventListenerTextWrapPreference(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 |