Songbird Web Page API UI Objects WebPlaylist |
WebPlaylistThe WebPlaylist UI object. This object controls the UI that appears at the bottom of the page. The information accessible here and operations available here correspond to the the actual UI. Selection, column modification and setting of the MediaList that serves as the data for the UI. ColumnsA note about columns. All the columns in the UI are driven by the existance of global level properties in Songbird. There are a number of types available to the developer ( see appendColumn() ). Each column must have a unique name and there are a number system default names we use to get the default set of columns. They are set when Songbird starts. When a column name is required as a parameter to a function the default names can be used provided the operation is not trying to add a column of that name. They can be passed in for the before column, or they can be hidden via hideColumn(). The default columns have names of this format - http://songbirdnest.com/data/1.0#<columnIdentifier> The complete list of column names can be found in http://publicsvn.songbirdnest.com- /browser- /trunk- /components- /property- /src- /sbStandardProperties.h Summary
selectionThe current selection in the WebPlaylist. TypeEnumerator, contains MediaItems. Example//Get the current webplaylist. See AlsoPlease see http://www.xulplanet.com- /references- /xpcomref- /ifaces- /nsISimpleEnumerator.html for nsISimpleEnumerator interface reference. setSelectionByIndex()Set the selection in the WebPlaylist. PrototypesetSelectionByIndex(Number index, Boolean selected) Parameters
Example//Get the current webPlaylist. hiddenIs the WebPlaylist hidden? Setting mediaList on the WebPlaylist will automatically make the WebPlaylist visible. hidden is intended for more advanced uses where a web page might want to manipulate the visiblity of the WebPlaylist directly. Typeboolean Example// show the webplaylist insertColumnBefore()Insert a column into the web playlist Arguments
|