Adobe InDesign CS5 (7.0) Object Model JS: LibraryPanel

InDesign CS5

Class

LibraryPanel

 Library panel Base Class: Panel

QuickLinks

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

Hierarchy

Application
Panel
LibraryPanel
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
associatedLibraryLibrary readonlyThe library displayed in this LibraryPanel
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
indexnumber readonlyThe index of the LibraryPanel within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
namestring readonlyThe name of the LibraryPanel.
parentApplication readonlyThe parent of the LibraryPanel (a Application).
propertiesObject r/wA property that allows setting of several properties at the same time.
selectionArray of NothingEnum
Object
Object
r/wThe selected object(s). Can also accept: Object or NothingEnum enumerator.
sortOrderSortAssets:
SortAssets.BY_NAME
SortAssets.BY_OLDEST
SortAssets.BY_NEWEST
SortAssets.BY_TYPE
r/wThe sort order of the assets in the LibraryPanel
viewLibraryPanelViews:
LibraryPanelViews.LIST_VIEW
LibraryPanelViews.THUMBNAIL_VIEW
LibraryPanelViews.LARGE_THUMBNAIL_VIEW
r/wLibraryPanel view
visiblebool r/wIf true, the panel is visible.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis 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.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

void select (selectableItems: varies[, existingSelection: SelectionOptions=SelectionOptions.REPLACE_WITH])
Selects the specified object(s).

ParameterTypeDescription
selectableItemsArray of Objects
NothingEnum
Object
SelectAll
The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator.
existingSelectionSelectionOptions:
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.3dContents :: Index