Songbird / Development / Songbird Add-Ons API Documentation

sbIFaceplateManager Interface Reference

Manages the panes that are displayed in faceplate widgets. More...

import "sbIFaceplateManager.idl";

List of all members.

Public Member Functions

void showPane (in sbIFaceplatePane aPane)
 Cause a faceplate pane to be created in all faceplates using the given XBL binding url.Cause all faceplate widgets to immediately switch to the given faceplate pane.
sbIFaceplatePane getPane (in AString aID)
 Cause all faceplate widgets to immediately destory their instances of the given faceplate pane. Get an interface representing all instances of a particular faceplate pane.
nsISimpleEnumerator getPanes ()
 Gets an enumerator for all instantiated faceplate panes.
sbIFaceplatePane getDefaultPane ()
 Get the pane used in the most recent call to showPane. Used to determine what pane a faceplate should display on load.
void addListener (in sbIFaceplateManagerListener aListener)
 Register to receive notification when panes are added, removed, and shown. Make sure you remove any listeners you add.
void removeListener (in sbIFaceplateManagerListener aListener)
 Unregister notification callbacks.

Public Attributes

readonly attribute unsigned
long 
paneCount
 The number of registered faceplate panes.


Detailed Description

Manages the panes that are displayed in faceplate widgets.

WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING

We are redesigning this integration point to better balance user and developer value. In the meantime, the faceplate interface will be disabled to avoid premature use.

If you need to display status information please open a tab, open a window, or use the status bar area for the time being.

Please submit any suggestions/feedback as bug reports to http://bugzilla.songbirdnest.com

WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING

To use the generic progress display faceplate:

         var manager =  Components.classes["@songbirdnest.com/faceplate/manager;1"]
                           .getService(Components.interfaces.sbIFaceplateManager);  
         var pane = manager.createPane("test", "test", 
                      "chrome://songbird/content/bindings/facePlate.xml#progress-pane");
         pane.setData("label1", "This is a demo of the");
         pane.setData("label2", "progress faceplate");
         pane.setData("progress-mode", "determined"); 
         pane.setData("progress-value", 60);         
         pane.setData("label1-hidden", false);      
         pane.setData("label2-hidden", false);      
         pane.setData("progress-hidden", false); 

To make a custom faceplate, see the facePlate.xml. Create a binding to act as a pane, register it using sbIFaceplateManager.createPane, communicate with it via sbIFaceplatePane, and then remove it via sbIFaceplateManager.destroyPane when finished.

See also:
sbIFaceplatePane facePlate.xml

Definition at line 84 of file sbIFaceplateManager.idl.


Member Function Documentation

void sbIFaceplateManager::showPane ( in sbIFaceplatePane  aPane  ) 

Cause a faceplate pane to be created in all faceplates using the given XBL binding url.Cause all faceplate widgets to immediately switch to the given faceplate pane.

Parameters:
aPane An active, instantiated, faceplate pane interface.

sbIFaceplatePane sbIFaceplateManager::getPane ( in AString  aID  ) 

Cause all faceplate widgets to immediately destory their instances of the given faceplate pane. Get an interface representing all instances of a particular faceplate pane.

Parameters:
aID A unique string identifier for this pane.
Returns:
An interface that can be used to communicate with all the instances of this faceplate pane.

nsISimpleEnumerator sbIFaceplateManager::getPanes (  ) 

Gets an enumerator for all instantiated faceplate panes.

Returns:
An enumerator containing sbIFaceplatePane interfaces

sbIFaceplatePane sbIFaceplateManager::getDefaultPane (  ) 

Get the pane used in the most recent call to showPane. Used to determine what pane a faceplate should display on load.

Returns:
An active, instantiated, faceplate pane interface.

void sbIFaceplateManager::addListener ( in sbIFaceplateManagerListener  aListener  ) 

Register to receive notification when panes are added, removed, and shown. Make sure you remove any listeners you add.

Parameters:
aListener Callback interface

void sbIFaceplateManager::removeListener ( in sbIFaceplateManagerListener  aListener  ) 

Unregister notification callbacks.

Parameters:
aListener Previously added callback interface


The documentation for this interface was generated from the following file:
Generated on Tue Mar 10 14:28:58 2009 for Songbird by  doxygen 1.5.2