AutofitPageItemRelations

Proxy object for methods related to AutoFit relations associated with a page item

Methods:

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

Hierarchy:

Superclass: Preference

Class: AutofitPageItemRelations

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 AutofitPageItemRelations (a AutofitPageItemSettings).

properties

Object

read/write

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

Method Listing

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, targetObject:Varies PageItem Graphic)

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

Parameter

Type

Description

sourceObject

PageItem

Graphic

The frame from where we start. Can accept: PageItem or Graphic. (Optional)

targetObject

PageItem

Graphic

The page item to link to. Can accept: PageItem or Graphic. (Optional)

Boolean exist (sourceObject:Varies PageItem Graphic, targetObject:Varies PageItem Graphic)

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

Parameter

Type

Description

sourceObject

PageItem

Graphic

The frame from where we start. Can accept: PageItem or Graphic. (Optional)

targetObject

PageItem

Graphic

The page item to link to. Can accept: PageItem or Graphic. (Optional)

AutofitPageItemRelations getElements ()

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

Boolean isActive ()

Test whether AutofitPageItemRelations is active in terms of AutoFit

AutofitRelation item (index:Number)

Get the nth relation from AutofitPageItemRelations

Parameter

Type

Description

index

Number

The index into the list of AutofitPageItemRelations

AutofitRelation list (sourceObject:Varies PageItem Graphic, targetObject:Varies PageItem Graphic)

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

Parameter

Type

Description

sourceObject

PageItem

Graphic

The frame from where we start. Can accept: PageItem or Graphic. (Optional)

targetObject

PageItem

Graphic

The page item to link to. Can accept: PageItem or Graphic. (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 AutofitPageItemRelations to the default values

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

AutofitPageItemSettings.relations

Event.parent

EventListener.parent

MutationEvent.parent

Return

AutofitPageItemRelations.getElements()