开发者文档
sogouExplorer.browserAction

sogouExplorer.browserAction.*基本上对应于chrome.browserAction.*,其目的是在搜狗浏览器的“工具栏”上放置图标、文字、badge等信息,用户可以通过点击“工具栏”上的按钮来使用扩展的功能。

搜狗高速浏览器的工具栏 Image:toolbar.png

API参考: sogouExplorer.browserAction

方法

setBadgeBackgroundColor

sogouExplorer.browserAction.setBadgeBackgroundColor(object details)

 设置工具栏上badge的背景颜色
 
 参数  
 details( object )    
   color( array of integer )
     这个数组由4个数字组成,分别代表颜色中的RGBA,数字的范围在[0, 255]之间。每当指定了一个数组之后,badge的背
     景色就会随之改变。例子:[255, 0, 0, 255]代表不透明的红色。
   tabId ( 可选 integer )      
     设置了这个可选参数之后,所有对于扩展图标的操作只有在指定的tab标签页被选中的时候才会被执行。而且当这个标签页
     被关闭的时候,会恢复到之前的状态。 

setBadgeText

sogouExplorer.browserAction.setBadgeText(object details)

 设置工具栏上badge的文字
 
 参数 
 details( object )  
   text( string )      
     所要显示的文字
    tabId ( 可选 integer )      
     设置了这个可选参数之后,所有对于扩展图标的操作只有在指定的tab标签页被选中的时候才会被执行。而且当这个标签页
     被关闭的时候,会恢复到之前的状态。


setIcon

sogouExplorer.browserAction.setIcon(object details)

 设置工具栏上的icon。
 对于这个icon,既可以设置它的路径,也可以通过html5的canvas标签来设置。这两种方法必须要使用其中的一种。
 
 参数 
 details( object )  
   imageData( 可选 ImageData )      
     图片的像素参数,必须是ImageData这个object。
      (可以参考canvas这个标签)
   path( 可选 string ) 
     所要显示的图片的相对路径。    
    tabId ( 可选 integer )      
     设置了这个可选参数之后,所有对于扩展图标的操作只有在指定的tab标签页被选中的时候才会被执行。而且当这个标签页
     被关闭的时候,会恢复到之前的状态。


setPopup

sogouExplorer.browserAction.setPopup(object details)

 设置一个html页面,这个页面会在每次点击扩展图标的时候通过popup的方式显示出来。 
 !!!注意,当设置popup页面时,popup的宽和高必须要给出,否则无法设置成功。!!!
  
 参数 
 details( object )  
   popup( string )      
      需要显示的html页面。如果设置为空,那么将不会有任何东西显示出来。如果设置为"!",左键点击扩展时会弹出右键
      菜单。
   width( integer) 
      popup页面的宽
   height 
      popup页面的高 !!!注意,当设置popup页面时,popup的宽和高必须要给出,否则无法设置成功。!!!
   tabId ( 可选 integer )      
     设置了这个可选参数之后,所有对于扩展图标的操作只有在指定的tab标签页被选中的时候才会被执行。而且当这个标签页
     被关闭的时候,会恢复到之前的状态。


showPopup

sogouExplorer.browserAction.showPopup()

 打开扩展的popup,只能在ContextMenu点击时调用。


setTitle

sogouExplorer.browserAction.setTitle(object details)

 设置扩展的名称,在工具栏上,鼠标在扩展图标上悬浮时,名称会显示在tooltip的第一行。  
  
 参数 
 details( object )  
   title( string )      
      需要被显示出来的名称。
    tabId ( 可选 integer )      
     设置了这个可选参数之后,所有对于扩展图标的操作只有在指定的tab标签页被选中的时候才会被执行。而且当这个标签页
     被关闭的时候,会恢复到之前的状态。


setDescription

sogouExplorer.browserAction.setDescription(object details)

 设置扩展的描述文字,在工具栏上,鼠标在扩展图标上悬浮时,描述文字会显示在tooltip的第二行

事件

onClicked

sogouExplorer.browserAction.onClicked.addListener(function (Tab tab){...});

 每当扩展被点击的时候,就会触发给定的方法。如果设置有popup,那么这个事件将不会被触发。
 
 参数 
 tab( Tab ) 
   标签页的信息。