Packagecom.adobe.indesign
Classpublic class TextWrapPreference
InheritanceTextWrapPreference Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined 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
 InheritedhostObjectDelegate : 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, Document or ObjectStyle).
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
Public Methods
 MethodDefined By
 Inherited
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
 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.
TextWrapPreference
 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
  
removeEventListenerTextWrapPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
TextWrapPreference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
TextWrapPreference
 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
applyToMasterPageOnlyproperty
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.


Implementation
    public function get applyToMasterPageOnly():Boolean
    public function set applyToMasterPageOnly(value:Boolean):void
contourOptionsproperty 
contourOptions:ContourOption  [read-only]

The contour of the text wrap. Valid only when when text wrap type is contour.


Implementation
    public function get contourOptions():ContourOption
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
inverseproperty 
inverse:Boolean

If true, inverts the text wrap.


Implementation
    public function get inverse():Boolean
    public function set inverse(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
parentproperty 
parent:Object  [read-only] [override]

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, Document or ObjectStyle).


Implementation
    public function get parent():Object
pathsproperty 
paths:Paths  [read-only]

A collection of paths.


Implementation
    public function get paths():Paths
preferencesproperty 
preferences:Preferences  [read-only]

A collection of preferences objects.


Implementation
    public function get preferences():Preferences
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
textWrapModeproperty 
textWrapMode:TextWrapModes

The text wrap mode.


Implementation
    public function get textWrapMode():TextWrapModes
    public function set textWrapMode(value:TextWrapModes):void
textWrapOffsetproperty 
textWrapOffset:Object

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.


Implementation
    public function get textWrapOffset():Object
    public function set textWrapOffset(value:Object):void
textWrapSideproperty 
textWrapSide:TextWrapSideOptions

Text wrap side options.


Implementation
    public function get textWrapSide():TextWrapSideOptions
    public function set textWrapSide(value:TextWrapSideOptions):void
userModifiedWrapproperty 
userModifiedWrap:Boolean  [read-only]

If true, the text wrap path has been explicitly modified by the user.


Implementation
    public function get userModifiedWrap():Boolean
Method Detail
addEventListenerTextWrapPreference()method
public function addEventListenerTextWrapPreference(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
removeEventListenerTextWrapPreference()method 
public function removeEventListenerTextWrapPreference(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