Packagecom.adobe.indesign
Classpublic class AnchoredObjectSetting
InheritanceAnchoredObjectSetting Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  anchoredPosition : AnchorPosition
The position of the anchored object relative to the anchor.
AnchoredObjectSetting
  anchorPoint : AnchorPoint
The point in the anchored object to position.
AnchoredObjectSetting
  anchorSpaceAbove : Object
The space above an above-line anchored object.
AnchoredObjectSetting
  anchorXoffset : Object
The horizontal (x) offset of the anchored object.
AnchoredObjectSetting
  anchorYoffset : Object
The vertical (y) offset of the anchored object.
AnchoredObjectSetting
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
AnchoredObjectSetting
  events : Events
[override] [read-only] A collection of events.
AnchoredObjectSetting
  horizontalAlignment : HorizontalAlignment
When anchored position is above line, the position of the anchored object is relative to the text area.
AnchoredObjectSetting
  horizontalReferencePoint : AnchoredRelativeTo
The horizontal reference point on the page.
AnchoredObjectSetting
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
AnchoredObjectSetting
  lockPosition : Boolean
If true, prevents manual positioning of the anchored object.
AnchoredObjectSetting
  parent : Object
[override] [read-only] The parent of the AnchoredObjectSetting (a Application, Document, EPSText, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, TextFrame, Button, FormField, MultiStateObject or ObjectStyle).
AnchoredObjectSetting
  pinPosition : Boolean
If true, pins the position of the anchored object within the text frame top and bottom.
AnchoredObjectSetting
  properties : Object
[override] A property that allows setting of several properties at the same time.
AnchoredObjectSetting
  spineRelative : Boolean
If true, the position of the anchored object is relative to the binding spine of the page or spread.
AnchoredObjectSetting
  verticalAlignment : VerticalAlignment
The vertical alignment of the anchored object reference point with the vertical reference point on the page.
AnchoredObjectSetting
  verticalReferencePoint : VerticallyRelativeTo
The vertical reference point on the page.
AnchoredObjectSetting
Public Methods
 MethodDefined By
  
addEventListenerAnchoredObjectSetting(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
AnchoredObjectSetting
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
 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.
AnchoredObjectSetting
 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
  
Releases the anchored object from its associated text.
AnchoredObjectSetting
  
removeEventListenerAnchoredObjectSetting(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
AnchoredObjectSetting
 Inherited
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
AnchoredObjectSetting
 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
anchoredPositionproperty
anchoredPosition:AnchorPosition

The position of the anchored object relative to the anchor.


Implementation
    public function get anchoredPosition():AnchorPosition
    public function set anchoredPosition(value:AnchorPosition):void
anchorPointproperty 
anchorPoint:AnchorPoint

The point in the anchored object to position.


Implementation
    public function get anchorPoint():AnchorPoint
    public function set anchorPoint(value:AnchorPoint):void
anchorSpaceAboveproperty 
anchorSpaceAbove:Object

The space above an above-line anchored object.


Implementation
    public function get anchorSpaceAbove():Object
    public function set anchorSpaceAbove(value:Object):void
anchorXoffsetproperty 
anchorXoffset:Object

The horizontal (x) offset of the anchored object.


Implementation
    public function get anchorXoffset():Object
    public function set anchorXoffset(value:Object):void
anchorYoffsetproperty 
anchorYoffset:Object

The vertical (y) offset of the anchored object. Corresponds to the space after property for above line positioning.


Implementation
    public function get anchorYoffset():Object
    public function set anchorYoffset(value:Object):void
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
horizontalAlignmentproperty 
horizontalAlignment:HorizontalAlignment

When anchored position is above line, the position of the anchored object is relative to the text area. When anchored position is custom, the horizontal alignment of the anchored object is set by the horizontal reference point. Note: Not valid when anchored position is inline.


Implementation
    public function get horizontalAlignment():HorizontalAlignment
    public function set horizontalAlignment(value:HorizontalAlignment):void
horizontalReferencePointproperty 
horizontalReferencePoint:AnchoredRelativeTo

The horizontal reference point on the page. Valid only when anchored position is custom.


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

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
lockPositionproperty 
lockPosition:Boolean

If true, prevents manual positioning of the anchored object.


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

The parent of the AnchoredObjectSetting (a Application, Document, EPSText, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, TextFrame, Button, FormField, MultiStateObject or ObjectStyle).


Implementation
    public function get parent():Object
pinPositionproperty 
pinPosition:Boolean

If true, pins the position of the anchored object within the text frame top and bottom.


Implementation
    public function get pinPosition():Boolean
    public function set pinPosition(value:Boolean):void
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
spineRelativeproperty 
spineRelative:Boolean

If true, the position of the anchored object is relative to the binding spine of the page or spread.


Implementation
    public function get spineRelative():Boolean
    public function set spineRelative(value:Boolean):void
verticalAlignmentproperty 
verticalAlignment:VerticalAlignment

The vertical alignment of the anchored object reference point with the vertical reference point on the page. Notes: Valid only when anchored position is custom.


Implementation
    public function get verticalAlignment():VerticalAlignment
    public function set verticalAlignment(value:VerticalAlignment):void
verticalReferencePointproperty 
verticalReferencePoint:VerticallyRelativeTo

The vertical reference point on the page. Valid when anchored position is custom.


Implementation
    public function get verticalReferencePoint():VerticallyRelativeTo
    public function set verticalReferencePoint(value:VerticallyRelativeTo):void
Method Detail
addEventListenerAnchoredObjectSetting()method
public function addEventListenerAnchoredObjectSetting(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
releaseAnchoredObject()method 
public function releaseAnchoredObject():void

Releases the anchored object from its associated text.

removeEventListenerAnchoredObjectSetting()method 
public function removeEventListenerAnchoredObjectSetting(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