Package | com.adobe.indesign |
Class | public class AnchoredObjectSetting |
Inheritance | AnchoredObjectSetting ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined 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 | ||
![]() | hostObjectDelegate : 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 |
Method | Defined By | ||
---|---|---|---|
addEventListenerAnchoredObjectSetting(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | AnchoredObjectSetting | ||
![]() | addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Preference | |
![]() | 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. | AnchoredObjectSetting | ||
![]() | 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 | |
insertAnchoredObject(storyOffsetParam:InsertionPoint = null, anchoredPositionParam:AnchorPosition = null):void
Inserts the anchored object into specified story. | AnchoredObjectSetting | ||
![]() | 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 | |
releaseAnchoredObject():void
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 | ||
![]() | removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Preference | |
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | AnchoredObjectSetting | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
anchoredPosition | property |
anchoredPosition:AnchorPosition
Since : | CS5 |
The position of the anchored object relative to the anchor.
public function get anchoredPosition():AnchorPosition
public function set anchoredPosition(value:AnchorPosition):void
anchorPoint | property |
anchorPoint:AnchorPoint
Since : | CS5 |
The point in the anchored object to position.
public function get anchorPoint():AnchorPoint
public function set anchorPoint(value:AnchorPoint):void
anchorSpaceAbove | property |
anchorSpaceAbove:Object
Since : | CS5 |
The space above an above-line anchored object.
public function get anchorSpaceAbove():Object
public function set anchorSpaceAbove(value:Object):void
anchorXoffset | property |
anchorXoffset:Object
Since : | CS5 |
The horizontal (x) offset of the anchored object.
public function get anchorXoffset():Object
public function set anchorXoffset(value:Object):void
anchorYoffset | property |
anchorYoffset:Object
Since : | CS5 |
The vertical (y) offset of the anchored object. Corresponds to the space after property for above line positioning.
public function get anchorYoffset():Object
public function set anchorYoffset(value:Object):void
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
horizontalAlignment | property |
horizontalAlignment:HorizontalAlignment
Since : | CS5 |
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.
public function get horizontalAlignment():HorizontalAlignment
public function set horizontalAlignment(value:HorizontalAlignment):void
horizontalReferencePoint | property |
horizontalReferencePoint:AnchoredRelativeTo
Since : | CS5 |
The horizontal reference point on the page. Valid only when anchored position is custom.
public function get horizontalReferencePoint():AnchoredRelativeTo
public function set horizontalReferencePoint(value:AnchoredRelativeTo):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
lockPosition | property |
lockPosition:Boolean
Since : | CS5 |
If true, prevents manual positioning of the anchored object.
public function get lockPosition():Boolean
public function set lockPosition(value:Boolean):void
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the AnchoredObjectSetting (a Application, Document, EPSText, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, TextFrame, Button, FormField, MultiStateObject or ObjectStyle).
public function get parent():Object
pinPosition | property |
pinPosition:Boolean
Since : | CS5 |
If true, pins the position of the anchored object within the text frame top and bottom.
public function get pinPosition():Boolean
public function set pinPosition(value:Boolean):void
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
spineRelative | property |
spineRelative:Boolean
Since : | CS5 |
If true, the position of the anchored object is relative to the binding spine of the page or spread.
public function get spineRelative():Boolean
public function set spineRelative(value:Boolean):void
verticalAlignment | property |
verticalAlignment:VerticalAlignment
Since : | CS5 |
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.
public function get verticalAlignment():VerticalAlignment
public function set verticalAlignment(value:VerticalAlignment):void
verticalReferencePoint | property |
verticalReferencePoint:VerticallyRelativeTo
Since : | CS5 |
The vertical reference point on the page. Valid when anchored position is custom.
public function get verticalReferencePoint():VerticallyRelativeTo
public function set verticalReferencePoint(value:VerticallyRelativeTo):void
addEventListenerAnchoredObjectSetting | () | method |
public function addEventListenerAnchoredObjectSetting(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 |
insertAnchoredObject | () | method |
public function insertAnchoredObject(storyOffsetParam:InsertionPoint = null, anchoredPositionParam:AnchorPosition = null):void
Since : | CS5.5 |
Inserts the anchored object into specified story.
Parameters
storyOffsetParam:InsertionPoint (default = null ) — (InsertionPoint) The location within the story, specified as an insertion point.
| |
anchoredPositionParam:AnchorPosition (default = null ) — (AnchorPosition) The position of the anchored object relative to the anchor. (Optional)
|
releaseAnchoredObject | () | method |
public function releaseAnchoredObject():void
Since : | CS5 |
Releases the anchored object from its associated text.
removeEventListenerAnchoredObjectSetting | () | method |
public function removeEventListenerAnchoredObjectSetting(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 |