Library

An object library.

Methods:

addEventListener, close, getElements, removeEventListener, store, toSource, toSpecifier

Objects:

Assets, Boolean, EventListeners, Events, File, Number, Object, Panel, String

Property Listing

Property

Type

Access

Description

assets

Assets Asset

readonly

A collection of object library assets.

associatedPanel

Panel

readonly

The associated panel.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

filePath

File

readonly

The full path to the file.

fullName

File

readonly

The full path to the Library, including the name of the Library.

index

Number

readonly

The index of the Library within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

name

String

readonly

The name of the Library.

parent

Application

readonly

The parent of the Library (a Application).

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)

undefined close ()

Closes the Library.

Library getElements ()

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

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)

Asset store (using:Array of Varies PageItems Graphics Movies Sounds XMLElements, withProperties:Object)

Stores the specified object in the library.

Parameter

Type

Description

using

Array of PageItems

Array of Graphics Graphic

Array of Movies

Array of Sounds Sound

Array of XMLElements XMLElement

The page item(s) to store. Can accept: Array of PageItems, Movies, Sounds, Graphics or XMLElements.

withProperties

Object

Initial values for properties of the new Library (Optional)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

LibraryPanel.associatedLibrary

Asset.parent

Event.parent

EventListener.parent

MutationEvent.parent

Return

Libraries.add()

Library.getElements()

Libraries.anyItem()

Libraries.everyItem()

Libraries.itemByRange()

Libraries.nextItem()

Libraries.previousItem()

Libraries.item()

Libraries.[]()

Libraries.itemByName()

Libraries.firstItem()

Libraries.lastItem()

Libraries.middleItem()