Packagecom.adobe.indesign
Classpublic class LibraryPanel
InheritanceLibraryPanel Inheritance Panel Inheritance CSHostObject Inheritance flash.utils.Proxy

Panel



Public Properties
 PropertyDefined By
  associatedLibrary : Library
[read-only] The library displayed in this LibraryPanel
LibraryPanel
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
LibraryPanel
  events : Events
[override] [read-only] A collection of events.
LibraryPanel
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  index : Number
[override] [read-only] The index of the LibraryPanel within its containing object.
LibraryPanel
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
LibraryPanel
  name : String
[override] [read-only] The name of the LibraryPanel.
LibraryPanel
  parent : Application
[override] [read-only] The parent of the LibraryPanel (a Application).
LibraryPanel
  properties : Object
[override] A property that allows setting of several properties at the same time.
LibraryPanel
  selection : Object
The selected object(s).
LibraryPanel
  sortOrder : SortAssets
The sort order of the assets in the LibraryPanel
LibraryPanel
  view : LibraryPanelViews
LibraryPanel view
LibraryPanel
  visible : Boolean
[override] If true, the panel is visible.
LibraryPanel
Public Methods
 MethodDefined By
  
addEventListenerLibraryPanel(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
LibraryPanel
 Inherited
addEventListenerPanel(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Panel
 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
[override] Resolves the object specifier, creating an array of object references.
LibraryPanel
 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
  
removeEventListenerLibraryPanel(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
LibraryPanel
 Inherited
removeEventListenerPanel(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Panel
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
select(selectableItemsParam:Object = null, existingSelectionParam:SelectionOptions = null):void
Selects the specified object(s).
LibraryPanel
  
showAll():void
Show all assets
LibraryPanel
  
toSpecifier():String
[override] Retrieves the object specifier.
LibraryPanel
 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
associatedLibraryproperty
associatedLibrary:Library  [read-only]

The library displayed in this LibraryPanel


Implementation
    public function get associatedLibrary():Library
eventListenersproperty 
eventListeners:EventListeners  [read-only] [override]

A collection of event listeners.


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

A collection of events.


Implementation
    public function get events():Events
indexproperty 
index:Number  [read-only] [override]

The index of the LibraryPanel within its containing object.


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

Returns true if the object specifier resolves to valid objects.


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

The name of the LibraryPanel.


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

The parent of the LibraryPanel (a Application).


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

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
selectionproperty 
selection:Object

The selected object(s). Can also accept: Object or NothingEnum enumerator.


Implementation
    public function get selection():Object
    public function set selection(value:Object):void
sortOrderproperty 
sortOrder:SortAssets

The sort order of the assets in the LibraryPanel


Implementation
    public function get sortOrder():SortAssets
    public function set sortOrder(value:SortAssets):void
viewproperty 
view:LibraryPanelViews

LibraryPanel view


Implementation
    public function get view():LibraryPanelViews
    public function set view(value:LibraryPanelViews):void
visibleproperty 
visible:Boolean[override]

If true, the panel is visible.


Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
Method Detail
addEventListenerLibraryPanel()method
public function addEventListenerLibraryPanel(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
getElements()method 
override public function getElements():Object

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

Returns
Object
removeEventListenerLibraryPanel()method 
public function removeEventListenerLibraryPanel(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
select()method 
public function select(selectableItemsParam:Object = null, existingSelectionParam:SelectionOptions = null):void

Selects the specified object(s).

Parameters

selectableItemsParam:Object (default = null) — (Object) The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator.
 
existingSelectionParam:SelectionOptions (default = null) — (SelectionOptions) The selection status of the LibraryPanel in relation to previously selected objects. (Optional)

showAll()method 
public function showAll():void

Show all assets

toSpecifier()method 
override public function toSpecifier():String

Retrieves the object specifier.

Returns
String