AutofitSourceRelations

Proxy object for methods related to AutoFit relations with different source objects and the current object as target

Methods:

add, addEventListener, count, exist, get, getElements, isActive, item, list, removeEventListener, resetAllToDefaults, toSource, toSpecifier

Hierarchy:

Superclass: Preference

Class: AutofitSourceRelations

Property Listing

Property

Type

Access

Description

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

parent

AutofitPageItemSettings

readonly

The parent of the AutofitSourceRelations (a AutofitPageItemSettings).

properties

Object

read/write

A property that allows setting of several properties at the same time.

Method Listing

AutofitRelation add (sourceObject:Varies PageItem Graphic, sourceAnchor:AnchorPoint, targetAnchor:AnchorPoint, withProperties:Object)

Add a relation from an anchor point of some source object to an anchor point of this object

Parameter

Type

Description

sourceObject

PageItem

Graphic

The page item to link from. Can accept: PageItem or Graphic.

sourceAnchor

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

The anchor point of this object to link from

targetAnchor

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

The anchor point of the other object to link to

withProperties

Object

Initial values for properties of the new AutofitSourceRelations (Optional)

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

Number count (sourceObject:Varies PageItem Graphic, sourceAnchor:AnchorPoint, targetAnchor:AnchorPoint)

Get the number of AutoFit relations from other objects to this object. Could be limited by the given parameters

Parameter

Type

Description

sourceObject

PageItem

Graphic

The frame from where the relation starts. Can accept: PageItem or Graphic. (Optional)

sourceAnchor

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

The anchor point of the other object to link from (Optional)

targetAnchor

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

The anchor point of this object to link to (Optional)

Boolean exist (sourceObject:Varies PageItem Graphic, sourceAnchor:AnchorPoint, targetAnchor:AnchorPoint)

Test whether at least one AutoFit relation exists from other objects to this object. Could be limited by the given parameters

Parameter

Type

Description

sourceObject

PageItem

Graphic

The frame from where the relation starts. Can accept: PageItem or Graphic. (Optional)

sourceAnchor

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

The anchor point of the other object to link from (Optional)

targetAnchor

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

The anchor point of this object to link to (Optional)

AutofitRelation get (sourceObject:Varies PageItem Graphic, sourceAnchor:AnchorPoint, targetAnchor:AnchorPoint)

Get the relation from an anchor point of some source object to an anchor point of this object

Parameter

Type

Description

sourceObject

PageItem

Graphic

The page item to link from. Can accept: PageItem or Graphic.

sourceAnchor

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

The anchor point of this object to link from

targetAnchor

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

The anchor point of the other object to link to

AutofitSourceRelations getElements ()

Resolves the object specifier, creating an array of object references.

Boolean isActive ()

Test whether AutofitSourceRelations is active in terms of AutoFit

AutofitRelation item (index:Number)

Get the nth relation from AutofitSourceRelations

Parameter

Type

Description

index

Number

The index into the list of AutofitSourceRelations

AutofitRelation list (sourceObject:Varies PageItem Graphic, sourceAnchor:AnchorPoint, targetAnchor:AnchorPoint)

Get the list of AutoFit relations from other objects to this object. Could be limited by the given parameters

Parameter

Type

Description

sourceObject

PageItem

Graphic

The frame from where the relation starts. Can accept: PageItem or Graphic. (Optional)

sourceAnchor

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

The anchor point of the other object to link from (Optional)

targetAnchor

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

The anchor point of this object to link to (Optional)

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

undefined resetAllToDefaults ()

Reset the AutoFit specific data of AutofitSourceRelations to the default values

String toSource ()

Generates a string which, if executed, will return the AutofitSourceRelations.

String toSpecifier ()

Retrieves the object specifier.

Object of

AutofitPageItemSettings.sourceRelations

Event.parent

EventListener.parent

MutationEvent.parent

Return

AutofitSourceRelations.getElements()