« Documentation Home

opera.extension.tabGroups.getAll()

This documentation relates to Opera's now deprecated .oex Extension API framework for Opera versions <= 12.15 and also provided by our OEX2NEX shim library.

For the latest Opera Extensions API documentation for Opera versions > 12.15 please consult the latest Opera Extensions API documentation online.

Description:

The getAll() method provides a way to obtain a tab group collection. The value returned is based on the following algorithm:

1. If this is the global tab group manager, return an array of BrowserTabGroup objects representing each browser tab group that is currently open.
2. If this is a window tab group manager, return an array of BrowserTabGroup objects representing each browser tab group that is currently open within the context window.

Parameters:

None

Syntax:

BrowserTabGroup[] getAll ()

Example:

The following example creates a button on the toolbar. When the button is clicked, the number of browser tab groups currently open is shown in the button's badge.

//
// The background process (e.g. index.html) 
//

// Specify the properties of the button before creating it.
var UIItemProperties = {
  disabled: false,
  title: "Example extension",
  icon: "images/icon_18.png",
  badge: {
    backgroundColor: '#cc0000',
    color: '#ffffff'
  }
};

// Create the button and add it to the toolbar.
var button = opera.contexts.toolbar.createItem( UIItemProperties );  
opera.contexts.toolbar.addItem(button);

button.addEventListener('click', handleClick, false);

function handleClick() {
  var groups = opera.extension.tabGroups.getAll();
  button.badge.textContent = groups.length;
}