Package | com.adobe.indesign |
Class | public class LibraryPanel |
Inheritance | LibraryPanel ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined 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 | ||
![]() | hostObjectDelegate : 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 |
Method | Defined By | ||
---|---|---|---|
addEventListenerLibraryPanel(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | LibraryPanel | ||
![]() | addEventListenerPanel(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Panel | |
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
![]() | 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 | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | 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 | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
![]() | 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 | ||
![]() | removeEventListenerPanel(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Panel | |
![]() | 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 | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
associatedLibrary | property |
associatedLibrary:Library
[read-only] Since : | CS5 |
The library displayed in this LibraryPanel
public function get associatedLibrary():Library
eventListeners | property |
eventListeners:EventListeners
[read-only] [override] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] [override] Since : | CS5 |
A collection of events.
public function get events():Events
index | property |
index:Number
[read-only] [override] Since : | CS5 |
The index of the LibraryPanel within its containing object.
public function get index():Number
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
name | property |
name:String
[read-only] [override] Since : | CS5 |
The name of the LibraryPanel.
public function get name():String
parent | property |
parent:Application
[read-only] [override] Since : | CS5 |
The parent of the LibraryPanel (a Application).
public function get parent():Application
properties | property |
properties:Object
[override] Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
selection | property |
selection:Object
Since : | CS5 |
The selected object(s). Can also accept: Object or NothingEnum enumerator.
public function get selection():Object
public function set selection(value:Object):void
sortOrder | property |
sortOrder:SortAssets
Since : | CS5 |
The sort order of the assets in the LibraryPanel
public function get sortOrder():SortAssets
public function set sortOrder(value:SortAssets):void
view | property |
view:LibraryPanelViews
Since : | CS5 |
LibraryPanel view
public function get view():LibraryPanelViews
public function set view(value:LibraryPanelViews):void
visible | property |
visible:Boolean
[override] Since : | CS5 |
If true, the panel is visible.
public function get visible():Boolean
public function set visible(value:Boolean):void
addEventListenerLibraryPanel | () | method |
public function addEventListenerLibraryPanel(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
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)
|
EventListener |
getElements | () | method |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
removeEventListenerLibraryPanel | () | method |
public function removeEventListenerLibraryPanel(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
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)
|
Boolean |
select | () | method |
public function select(selectableItemsParam:Object = null, existingSelectionParam:SelectionOptions = null):void
Since : | CS5 |
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
Since : | CS5 |
Show all assets
toSpecifier | () | method |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |