Class
Library panel Base Class: Panel addEventListener, getElements, removeEventListener, select, showAll, toSource, toSpecifier
LibraryPanel
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| associatedLibrary | Library | readonly | The library displayed in this LibraryPanel |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| index | number | readonly | The index of the LibraryPanel within its containing object. |
| isValid | bool | 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 | r/w | A property that allows setting of several properties at the same time. |
| selection | Array of NothingEnum Object Object |
r/w | The selected object(s). Can also accept: Object or NothingEnum enumerator. |
| sortOrder | SortAssets: SortAssets.BY_NAME SortAssets.BY_OLDEST SortAssets.BY_NEWEST SortAssets.BY_TYPE |
r/w | The sort order of the assets in the LibraryPanel |
| view | LibraryPanelViews: LibraryPanelViews.LIST_VIEW LibraryPanelViews.THUMBNAIL_VIEW LibraryPanelViews.LARGE_THUMBNAIL_VIEW |
r/w | LibraryPanel view |
| visible | bool | r/w | If true, the panel is visible. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
Array of LibraryPanel getElements ()
Resolves the object specifier, creating an array of object references.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
void select (selectableItems:
varies[, existingSelection:
SelectionOptions=SelectionOptions.REPLACE_WITH])
Selects the specified object(s).
| Parameter | Type | Description |
|---|---|---|
| selectableItems | Array of Objects NothingEnum Object SelectAll | 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 | The selection status of the LibraryPanel in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH) |
void showAll ()
Show all assets
string toSource ()
Generates a string which, if executed, will return the LibraryPanel.
string toSpecifier ()
Retrieves the object specifier.
Return
Array of LibraryPanel LibraryPanel.getElements ()
| Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |