Packagecom.adobe.indesign
Classpublic class Library
InheritanceLibrary Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  assets : Assets
[read-only] A collection of object library assets.
Library
  associatedPanel : Panel
[read-only] The associated panel.
Library
  eventListeners : EventListeners
[read-only] A collection of event listeners.
Library
  events : Events
[read-only] A collection of events.
Library
  filePath : File
[read-only] The full path to the file.
Library
  fullName : File
[read-only] The full path to the Library, including the name of the Library.
Library
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  index : Number
[read-only] The index of the Library within its containing object.
Library
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
Library
  name : String
[read-only] The name of the Library.
Library
  parent : Application
[read-only] The parent of the Library (a Application).
Library
  properties : Object
A property that allows setting of several properties at the same time.
Library
Public Methods
 MethodDefined By
  
addEventListenerLibrary(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Library
  
close():void
Closes the Library.
Library
 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
Resolves the object specifier, creating an array of object references.
Library
 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
  
removeEventListenerLibrary(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Library
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
store(usingParam:Array = null, withPropertiesParam:Object = null):Asset
Stores the specified object in the library.
Library
  
toSpecifier():String
Retrieves the object specifier.
Library
 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
assetsproperty
assets:Assets  [read-only]

A collection of object library assets.


Implementation
    public function get assets():Assets
associatedPanelproperty 
associatedPanel:Panel  [read-only]

The associated panel.


Implementation
    public function get associatedPanel():Panel
eventListenersproperty 
eventListeners:EventListeners  [read-only]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only]

A collection of events.


Implementation
    public function get events():Events
filePathproperty 
filePath:File  [read-only]

The full path to the file.


Implementation
    public function get filePath():File
fullNameproperty 
fullName:File  [read-only]

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


Implementation
    public function get fullName():File
indexproperty 
index:Number  [read-only]

The index of the Library within its containing object.


Implementation
    public function get index():Number
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
nameproperty 
name:String  [read-only]

The name of the Library.


Implementation
    public function get name():String
parentproperty 
parent:Application  [read-only]

The parent of the Library (a Application).


Implementation
    public function get parent():Application
propertiesproperty 
properties:Object

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
Method Detail
addEventListenerLibrary()method
public function addEventListenerLibrary(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
close()method 
public function close():void

Closes the Library.

getElements()method 
public function getElements():Object

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

Returns
Object
removeEventListenerLibrary()method 
public function removeEventListenerLibrary(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
store()method 
public function store(usingParam:Array = null, withPropertiesParam:Object = null):Asset

Stores the specified object in the library.

Parameters

usingParam:Array (default = null) — (Array) The page item(s) to store. Can accept: Array of PageItems, Movies, Sounds, Graphics or XMLElements.
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new Library (Optional)

Returns
Asset
toSpecifier()method 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String