LibraryPanel

Methods:

addEventListener, getElements, removeEventListener, select, showAll, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Library, LibraryPanelViews, NothingEnum, Number, Object, SortAssets, String

Hierarchy:

Superclass: Panel

Class: LibraryPanel

Property Listing

Property	Type	Access	Description
associatedLibrary	Library	readonly	The library displayed in this LibraryPanel
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
index	Number	readonly	The index of the LibraryPanel within its containing object.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
name	String	readonly	The name of the LibraryPanel.
parent	Application	readonly	The parent of the LibraryPanel (a Application).
properties	Object	read/write	A property that allows setting of several properties at the same time.
selection	Array of Object NothingEnum.NOTHING	read/write	The selected object(s). Can also accept: Object or NothingEnum enumerator.
sortOrder	SortAssets SortAssets.BY_NAME SortAssets.BY_NEWEST SortAssets.BY_OLDEST SortAssets.BY_TYPE	read/write	The sort order of the assets in the LibraryPanel
view	LibraryPanelViews LibraryPanelViews.LARGE_THUMBNAIL_VIEW LibraryPanelViews.LIST_VIEW LibraryPanelViews.THUMBNAIL_VIEW	read/write	LibraryPanel view
visible	Boolean	read/write	If true, the panel is visible.

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)

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)

LibraryPanel 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)

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 select (selectableItems:Array of Varies Objects NothingEnum Object SelectAll, [existingSelection:SelectionOptions=SelectionOptions])

Selects the specified object(s).

Parameter	Type	Description
selectableItems	Array of Objects NothingEnum.NOTHING Object SelectAll SelectAll.ALL	The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator.
existingSelection	SelectionOptions SelectionOptions.ADD_TO SelectionOptions.REMOVE_FROM SelectionOptions.REPLACE_WITH SelectionOptions.SET_KEY	The selection status of the LibraryPanel in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH)

Parameter

Type

Description

selectableItems

Array of Objects

NothingEnum.NOTHING

Object

SelectAll

SelectAll.ALL

The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator.

existingSelection

SelectionOptions