| OLD | NEW |
|---|
| 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc.
Note: 1) The <head> information in this page is significant, should be uniform
across api docs and should be edited only with knowledge of the templating mecha
nism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is gener
eated as an rendering step. If viewed in a browser, it will be re-generated from
the template, json schema and authored overview content. 4) The <body>.innerHTM
L is also generated by an offline step so that this page may easily be indexed b
y search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes t
he single version of page template shell and the "instance" pages (bookmarks.htm
l, etc...) can be generated with a build step. --><!-- <html> must retain id="te
mplate --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> da
ta is significant and loads the needed libraries and styles --><head jstcache="0
"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache="
0"> <title jscontent="getPageTitle()" jstcache="1">Toolstrips</title> <link href
="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script t
ype="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.j
s" jstcache="0"> </script> <script type="text/javascript" src="js/api_page_gener
ator.js" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap
.js" jstcache="0"></script> </head><!-- <body> content is completely generated.
Do not edit, as it will be and rewritten. --><body jstcache="0"> <div id="contai
ner" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id=
"pageHeader" jstcache="0"> <div id="searchbox" jstcache="0"> <form action="http:
//www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstcache="0"> <inpu
t type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" jstcache="0"
> <input type="hidden" name="ie" value="UTF-8" jstcache="0"> <input type="text"
name="q" size="31" jstcache="0"> <input type="submit" name="sa" value="Search" j
stcache="0"> </div> </form> <script type="text/javascript" src="http://www.googl
e.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcache="0">
google.load("elements", "1", {packages: "transliteration"});</script> <script ty
pe="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-bo
x&t13n_langs=en" jstcache="0"></script> <script type="text/javascript" src="
http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" jstcache="
0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jscontent="getPageTitl
e()" jstcache="1">Toolstrips</h1> </div> </div> <!-- /pageHeader --> <div id="pa
geContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul js
tcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <l
i jstcache="0"> <a href="getstarted.html" jstcache="0">Getting Started</a></li>
<li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jst
cache="0"> <a href="devguide.html" jstcache="0"><div jstcache="0">Developer's Gu
ide</div></a> <ul jstcache="0"> <li jstcache="0" class="leftNavSelected">Toolstr
ips</li> <li jstcache="0"><a href="pageActions.html" jstcache="0">Page Actions</
a></li> <li jstcache="0"><a href="background_pages.html" jstcache="0">Background
Pages</a></li> <li jstcache="0"><a href="content_scripts.html" jstcache="0">Con
tent Scripts</a></li> <li jstcache="0">Events</li> <li jstcache="0"><a href="tab
s.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a href="windows.html" jstca
che="0">Windows</a></li> <li jstcache="0"><a href="bookmarks.html" jstcache="0">
Bookmarks</a></li> <li jstcache="0">Themes</li> <li jstcache="0"><a href="npapi.
html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.ht
ml" jstcache="0">Packaging</a></li> <li jstcache="0">Autoupdate</li> </ul> </li>
<li jstcache="0"><a href="tutorials.html" jstcache="0"><div jstcache="0">Tutori
als</div></a> <ul jstcache="0"> <li jstcache="0"><a href="tut_debugging.html" js
tcache="0">Debugging</a></li> </ul> </li> <li jstcache="0">Reference <ul jstcach
e="0"> <li jstcache="0"> Formats <ul jstcache="0"> <li jstcache="0"><a href="man
ifest.html" jstcache="0">Manifest Files</a></li> <li jstcache="0">Match Patterns
</li> <li jstcache="0">Packages (.crx)</li> </ul> </li> <li jstcache="0"> <a hre
f="api_index.html" jstcache="0">chrome.* APIs</a> </li> <li jstcache="0"> <a hre
f="api_other.html" jstcache="0">Other APIs</a> </li> </ul> </li> <li jstcache="0
"><a href="http://dev.chromium.org/developers/design-documents/extensions/sample
s" jstcache="0">Samples</a></li> </ul> </div> <div id="mainColumn" jstcache="0">
<!-- TABLE OF CONTENTS --> <div id="toc" jsdisplay="showPageTOC()" jstcache="2"
> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jsselect="getStaticTOC()" j
stcache="9" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#' + href" jstc
ache="14" href="#H2-0">Manifest</a> <ol jstcache="0"> <li jsselect="$this.childr
en" jstcache="22" jsinstance="*0" style="display: none; "> <a jscontent="name" j
svalues=".href:'#' + href" jstcache="14">h3Name</a> </li> </ol> </li><li jsselec
t="getStaticTOC()" jstcache="9" jsinstance="1"> <a jscontent="name" jsvalues=".h
ref:'#' + href" jstcache="14" href="#H2-1">Creating buttons</a> <ol jstcache="0"
> <li jsselect="$this.children" jstcache="22" jsinstance="*0" style="display: no
ne; "> <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14">h3Name</a>
</li> </ol> </li><li jsselect="getStaticTOC()" jstcache="9" jsinstance="2"> <a j
scontent="name" jsvalues=".href:'#' + href" jstcache="14" href="#H2-2">Debugging
tips</a> <ol jstcache="0"> <li jsselect="$this.children" jstcache="22" jsinstan
ce="*0" style="display: none; "> <a jscontent="name" jsvalues=".href:'#' + href"
jstcache="14">h3Name</a> </li> </ol> </li><li jsselect="getStaticTOC()" jstcach
e="9" jsinstance="*3"> <a jscontent="name" jsvalues=".href:'#' + href" jstcache=
"14" href="#H2-3">Design tips</a> <ol jstcache="0"> <li jsselect="$this.children
" jstcache="22" jsinstance="*0" style="display: none; "> <a jscontent="name" jsv
alues=".href:'#' + href" jstcache="14">h3Name</a> </li> </ol> </li> <div jsselec
t="apiDefinition" jstcache="3"> <li jstcache="0"> <a href="#apiReference" jscont
ent="'API reference: ' + getModuleName()" jstcache="4">API reference: chrome.too
lstrip</a> <ol jstcache="0"> <li jsdisplay="$this.properties" jstcache="5" style
="display: none; "> <a href="#properties" jstcache="0">Properties</a> <ol jstcac
he="0"> <li jsselect="getPropertyListFromObject($this)" jstcache="10"> <a jscont
ent="name" jsvalues=".href:'#property-' + name" href="#property-anchor" jstcache
="41">propertyName</a> </li> </ol> </li> <li jsdisplay="functions && fun
ctions.length > 0" jstcache="6"> <a href="#methods" jstcache="0">Methods</a>
<ol jstcache="0"> <li jsselect="functions" jstcache="11" jsinstance="0"> <a jsco
ntent="name" jsvalues=".href:'#method-' + name" href="#method-expand" jstcache="
42">expand</a> </li><li jsselect="functions" jstcache="11" jsinstance="*1"> <a j
scontent="name" jsvalues=".href:'#method-' + name" href="#method-collapse" jstca
che="42">collapse</a> </li> </ol> </li> <li jsdisplay="events && events.
length > 0" jstcache="7" style="display: none; "> <a href="#events" jstcache=
"0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="12"> <a jsconte
nt="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="43">e
ventName</a> </li> </ol> </li> <li jsdisplay="types && types.length >
0" jstcache="8" style="display: none; "> <a href="#types" jstcache="0">Types</a
> <ol jstcache="0"> <li jsselect="types" jstcache="13"> <a jscontent="id" jsvalu
es=".href:'#type-' + id" href="#id-anchor" jstcache="44">id</a> </li> </ol> </li
> </ol> </li> </div> </ol> </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTEN
T PLACEHOLDER --> <div id="static" jstcache="0"><div id="pageData-title" class="
pageData" jstcache="0">Toolstrips</div> <!-- BEGIN AUTHORED CONTENT --> <p jstca
che="0"> Toolstrips allow you to add UI to Google Chrome's toolbar area. Toolstr
ips are nothing more than (very small) HTML pages, so anything you can do with H
TML/CSS/JavaScript, you can do with toolstrips. </p> <a name="H2-0" jstcache="0"
></a><h2 id="manifest" jstcache="0">Manifest</h2> <p jstcache="0">Register your
toolstrips in the extension manifest like this:</p> <pre jstcache="0">{ "name":
"My First Extension", "version": "1.0", "description": "The first extension that
I made.", <b jstcache="0"> "toolstrips": [ "one_toolstrip.html", "two_toolstrip
.html" ]</b> }</pre> <a name="H2-1" jstcache="0"></a><h2 jstcache="0">Creating b
uttons</h2> <p jstcache="0">You can create buttons that look like the bookmark b
ar buttons using this template:</p> <pre jstcache="0"><div class="toolstrip-b
utton"> <!-- Image is optional and should be a 16x16 icon. --> <img
src="<em jstcache="0">path/to/some_icon.png</em>"> <span>My Button</
span> </div></pre> <a name="H2-2" jstcache="0"></a><h2 jstcache="0">Deb
ugging tips</h2> <ul jstcache="0"> <li jstcache="0">You can right click on a too
lstrip to get a web inspector.</li> <li jstcache="0">alert(), prompt(), and conf
irm() don't work yet. Sorry about that.</li> <li jstcache="0">You can run toolst
rips in the main content area by loading their URL, which would be something lik
e chrome-extension://0000000000000000000000000000000000000000/my_toolstrip.html<
/li> </ul> <a name="H2-3" jstcache="0"></a><h2 jstcache="0">Design tips</h2> <ul
jstcache="0"> <li jstcache="0">Try not to use too much space. Toolbar real esta
te is precious and users tend to prefer extensions to use as little of it as pos
sible.</li> <li jstcache="0">The toolbar automatically detects how much space a
toolstrip needs and reflows. So you can resize your toolstrip dynamically if you
need a little more room temporarily.</li> <li jstcache="0">If you need to do mo
re extensive UI, use the tab contents area or a pop up window.</li> <li jstcache
="0">Remember that there can be multiple instances of a given toolstrip page run
ning at one time. Each browser window has its own toolstrip. If you need long-ru
nning application logic, try Background Pages.</li> </ul> <!-- END AUTHORED CONT
ENT --> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" j
stcache="3"> <a name="apiReference" jstcache="0"></a> <h2 jscontent="'API refere
nce: ' + getModuleName()" jstcache="4">API reference: chrome.toolstrip</h2> <!--
PROPERTIES --> <div jsdisplay="$this.properties" class="apiGroup" jstcache="5"
style="display: none; "> <a name="properties" jstcache="0"></a> <h3 id="properti
es" jstcache="0">Properties</h3> <div jsselect="getPropertyListFromObject($this)
" jstcache="10"> <a jsvalues=".name:'property-' + name" jstcache="15"></a> <h4 j
scontent="name" jstcache="16">getLastError</h4> <div class="summary" jstcache="0
"> <!-- Note: intentionally longer 80 columns --> <span jscontent="getModuleName
() + '.'" jstcache="23">chrome.extension</span><span jscontent="$this.name" jstc
ache="24">lastError</span> </div> <div transclude="valueTemplate" jstcache="17">
</div> </div> </div> <!-- /apiGroup --> <!-- METHODS --> <div jsdisplay="functi
ons && functions.length > 0" class="apiGroup" id="methods" jstcache="
6"> <a name="methods" jstcache="0"></a> <h3 jstcache="0">Methods</h3> <!-- itera
tes over all functions --> <div class="apiItem" jsselect="functions" jstcache="1
1" jsinstance="0"> <a jsvalues=".name:'method-' + name" jstcache="18" name="meth
od-expand"></a> <!-- method-anchor --> <h4 jscontent="name" jstcache="16">expand
</h4> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="get
TypeName(returns)" jstcache="25" style="display: none; ">void</span> <!-- Note:
intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionNa
me($this)" jstcache="26">chrome.toolstrip.expand</span>(<span jsselect="paramete
rs" jsvalues="class:optional ? 'optional' : ''" jstcache="27" jsinstance="0" cla
ss="null"><span jsdisplay="$index" jstcache="33" style="display: none; ">, </spa
n><span jscontent="getTypeName($this)" jstcache="34">object</span> <var jstcache
="0"><span jscontent="name" jstcache="16">expandInfo</span></var></span><span js
select="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="27" js
instance="*1" class="optional"><span jsdisplay="$index" jstcache="33">, </span><
span jscontent="getTypeName($this)" jstcache="34">function</span> <var jstcache=
"0"><span jscontent="name" jstcache="16">callback</span></var></span>)</div> <di
v class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jst
cache="28">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:des
cription" jstcache="29" style="display: none; "> A description from the json sch
ema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Par
ameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="35" jsinstan
ce="0"> <!-- VALUE: This is a subtemplate that is used elsewhere via jsTemplate
*transclude* --> <div id="valueTemplate" jstcache="0"> <dt jstcache="0"> <var js
display="$this.name" jscontent="$this.name" jstcache="45">expandInfo</var> <em j
stcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span cla
ss="optional" jsdisplay="optional" jstcache="46" style="display: none; ">optiona
l</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this
)" jstcache="47" style="display: none; "> <a jsvalues=".href: getTypeRefPage($th
is) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="49">
Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="48"> <span jsdi
splay="isArray($this)" jstcache="50" style="display: none; "> array of <span jss
elect="items" jstcache="52"><span transclude="typeTemplate" jstcache="53"></span
></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)
" jstcache="51">object</span> </span> </span> ) </div> </em> </dt> <dd class="to
do" jsdisplay="!$this.description" jstcache="38"> Undocumented. </dd> <dd jsdisp
lay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="39" st
yle="display: none; "> Description of this parameter from the json schema. </dd>
<!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="
40"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache
="10" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this
.name" jscontent="$this.name" jstcache="45">height</var> <em jstcache="0"> <!--
TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdi
splay="optional" jstcache="46" style="display: none; ">optional</span> <span id=
"typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="47" s
tyle="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + g
etTypeRef($this)" jscontent="getTypeRef($this)" jstcache="49"> Type</a> </span>
<span jsdisplay="!getTypeRef($this)" jstcache="48"> <span jsdisplay="isArray($th
is)" jstcache="50" style="display: none; "> array of <span jsselect="items" jstc
ache="52"><span transclude="typeTemplate" jstcache="53"></span></span> </span> <
span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="51">in
teger</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$
this.description" jstcache="38" style="display: none; "> Undocumented. </dd> <dd
jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache=
"39" style="">The vertical pixel height required of the toolstrip area.</dd> <!-
- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="40"
style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObj
ect($this)" jstcache="10" jsinstance="0"> <div transclude="valueTemplate" jstcac
he="17"> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache=
"10" jsinstance="*1"> <div transclude="valueTemplate" jstcache="17"> </div> </di
v> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jst
cache="10" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay=
"$this.name" jscontent="$this.name" jstcache="45">url</var> <em jstcache="0"> <!
-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" j
sdisplay="optional" jstcache="46" style="">optional</span> <span id="typeTemplat
e" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="47" style="displa
y: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($t
his)" jscontent="getTypeRef($this)" jstcache="49"> Type</a> </span> <span jsdisp
lay="!getTypeRef($this)" jstcache="48"> <span jsdisplay="isArray($this)" jstcach
e="50" style="display: none; "> array of <span jsselect="items" jstcache="52"><s
pan transclude="typeTemplate" jstcache="53"></span></span> </span> <span jsdispl
ay="!isArray($this)" jscontent="getTypeName($this)" jstcache="51">string</span>
</span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.descript
ion" jstcache="38" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$
this.description" jsvalues=".innerHTML:$this.description" jstcache="39" style=""
>If present, the toolstrip mole will change it's content to the provided url. Ot
herwise, the current page will just be expanded in size.</dd> <!-- OBJECT PROPER
TIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="40" style="display:
none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jst
cache="10" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="
$this.name" jscontent="$this.name" jstcache="45">height</var> <em jstcache="0">
<!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional"
jsdisplay="optional" jstcache="46" style="display: none; ">optional</span> <spa
n id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="
47" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-
' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="49"> Type</a> </s
pan> <span jsdisplay="!getTypeRef($this)" jstcache="48"> <span jsdisplay="isArra
y($this)" jstcache="50" style="display: none; "> array of <span jsselect="items"
jstcache="52"><span transclude="typeTemplate" jstcache="53"></span></span> </sp
an> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="5
1">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdispla
y="!$this.description" jstcache="38" style="display: none; "> Undocumented. </dd
> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstc
ache="39" style="">The vertical pixel height required of the toolstrip area.</dd
> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache=
"40" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFr
omObject($this)" jstcache="10" jsinstance="0"> <div transclude="valueTemplate" j
stcache="17"> </div> </div><div jsselect="getPropertyListFromObject($this)" jstc
ache="10" jsinstance="*1"> <div transclude="valueTemplate" jstcache="17"> </div>
</div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)
" jstcache="10" jsinstance="*1"> <div transclude="valueTemplate" jstcache="17">
</div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div
><div jsselect="parameters" jstcache="35" jsinstance="*1"> <!-- VALUE: This is a
subtemplate that is used elsewhere via jsTemplate *transclude* --> <div id="val
ueTemplate" jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jsconten
t="$this.name" jstcache="45">callback</var> <em jstcache="0"> <!-- TYPE --> <div
style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="option
al" jstcache="46">optional</span> <span id="typeTemplate" jstcache="0"> <span js
display="getTypeRef($this)" jstcache="47" style="display: none; "> <a jsvalues="
.href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeR
ef($this)" jstcache="49"> Type</a> </span> <span jsdisplay="!getTypeRef($this)"
jstcache="48"> <span jsdisplay="isArray($this)" jstcache="50" style="display: no
ne; "> array of <span jsselect="items" jstcache="52"><span transclude="typeTempl
ate" jstcache="53"></span></span> </span> <span jsdisplay="!isArray($this)" jsco
ntent="getTypeName($this)" jstcache="51">function</span> </span> </span> ) </div
> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="38"> Und
ocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.de
scription" jstcache="39" style="display: none; "> Description of this parameter
from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpa
ndObject($this)" jstcache="40" style="display: none; "> <dl jstcache="0"> <div j
sselect="getPropertyListFromObject($this)" jstcache="10"> <div transclude="value
Template" jstcache="17"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div>
</dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="30" style="display: no
ne; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="36" style
="display: none; "> <div transclude="valueTemplate" jstcache="17"> </div> </div>
</dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcac
he="31"> <div jsselect="getCallbackParameters(parameters)" jstcache="37"> <h4 js
tcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcac
he="0">callback</em> parameter, it should specify a function that looks like thi
s: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">functio
n(<span jscontent="getSignatureString(parameters)" jstcache="32"></span>) <span
class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselec
t="parameters" jstcache="35" jsinstance="*0" style="display: none; "> <div trans
clude="valueTemplate" jstcache="17"> </div> </div> </dl> </div> </div> </div> <!
-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="11
" jsinstance="*1"> <a jsvalues=".name:'method-' + name" jstcache="18" name="meth
od-collapse"></a> <!-- method-anchor --> <h4 jscontent="name" jstcache="16">coll
apse</h4> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent=
"getTypeName(returns)" jstcache="25" style="display: none; ">void</span> <!-- No
te: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFuncti
onName($this)" jstcache="26">chrome.toolstrip.collapse</span>(<span jsselect="pa
rameters" jsvalues="class:optional ? 'optional' : ''" jstcache="27" jsinstance="
0" class="optional"><span jsdisplay="$index" jstcache="33" style="display: none;
">, </span><span jscontent="getTypeName($this)" jstcache="34">object</span> <va
r jstcache="0"><span jscontent="name" jstcache="16">collapseInfo</span></var></s
pan><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstc
ache="27" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="33
">, </span><span jscontent="getTypeName($this)" jstcache="34">function</span> <v
ar jstcache="0"><span jscontent="name" jstcache="16">callback</span></var></span
>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!desc
ription" jstcache="28">Undocumented.</p> <p jsdisplay="description" jsvalues=".i
nnerHTML:description" jstcache="29" style="display: none; "> A description from
the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstc
ache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="
35" jsinstance="0"> <!-- VALUE: This is a subtemplate that is used elsewhere via
jsTemplate *transclude* --> <div id="valueTemplate" jstcache="0"> <dt jstcache=
"0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="45">collapseIn
fo</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0
"> ( <span class="optional" jsdisplay="optional" jstcache="46">optional</span> <
span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcach
e="47" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#ty
pe-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="49"> Type</a>
</span> <span jsdisplay="!getTypeRef($this)" jstcache="48"> <span jsdisplay="isA
rray($this)" jstcache="50" style="display: none; "> array of <span jsselect="ite
ms" jstcache="52"><span transclude="typeTemplate" jstcache="53"></span></span> <
/span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache
="51">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisp
lay="!$this.description" jstcache="38"> Undocumented. </dd> <dd jsdisplay="$this
.description" jsvalues=".innerHTML:$this.description" jstcache="39" style="displ
ay: none; "> Description of this parameter from the json schema. </dd> <!-- OBJE
CT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="40"> <dl j
stcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="10" jsin
stance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" js
content="$this.name" jstcache="45">url</var> <em jstcache="0"> <!-- TYPE --> <di
v style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optio
nal" jstcache="46" style="">optional</span> <span id="typeTemplate" jstcache="0"
> <span jsdisplay="getTypeRef($this)" jstcache="47" style="display: none; "> <a
jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent
="getTypeRef($this)" jstcache="49"> Type</a> </span> <span jsdisplay="!getTypeRe
f($this)" jstcache="48"> <span jsdisplay="isArray($this)" jstcache="50" style="d
isplay: none; "> array of <span jsselect="items" jstcache="52"><span transclude=
"typeTemplate" jstcache="53"></span></span> </span> <span jsdisplay="!isArray($t
his)" jscontent="getTypeName($this)" jstcache="51">string</span> </span> </span>
) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="
38" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.descriptio
n" jsvalues=".innerHTML:$this.description" jstcache="39" style="">If present, th
e toolstrip mole will change it's content to the provided url. Otherwise, the cu
rrent page will just be collapsed in size.</dd> <!-- OBJECT PROPERTIES --> <dd j
sdisplay="shouldExpandObject($this)" jstcache="40" style="display: none; "> <dl
jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="10" jsi
nstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" js
content="$this.name" jstcache="45">height</var> <em jstcache="0"> <!-- TYPE -->
<div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="op
tional" jstcache="46" style="display: none; ">optional</span> <span id="typeTemp
late" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="47" style="dis
play: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef
($this)" jscontent="getTypeRef($this)" jstcache="49"> Type</a> </span> <span jsd
isplay="!getTypeRef($this)" jstcache="48"> <span jsdisplay="isArray($this)" jstc
ache="50" style="display: none; "> array of <span jsselect="items" jstcache="52"
><span transclude="typeTemplate" jstcache="53"></span></span> </span> <span jsdi
splay="!isArray($this)" jscontent="getTypeName($this)" jstcache="51">integer</sp
an> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.desc
ription" jstcache="38" style="display: none; "> Undocumented. </dd> <dd jsdispla
y="$this.description" jsvalues=".innerHTML:$this.description" jstcache="39" styl
e="">The vertical pixel height required of the toolstrip area.</dd> <!-- OBJECT
PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="40" style="di
splay: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this
)" jstcache="10" jsinstance="0"> <div transclude="valueTemplate" jstcache="17">
</div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="10" jsin
stance="*1"> <div transclude="valueTemplate" jstcache="17"> </div> </div> </dl>
</dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="10
" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.na
me" jscontent="$this.name" jstcache="45">url</var> <em jstcache="0"> <!-- TYPE -
-> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay=
"optional" jstcache="46" style="">optional</span> <span id="typeTemplate" jstcac
he="0"> <span jsdisplay="getTypeRef($this)" jstcache="47" style="display: none;
"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jsc
ontent="getTypeRef($this)" jstcache="49"> Type</a> </span> <span jsdisplay="!get
TypeRef($this)" jstcache="48"> <span jsdisplay="isArray($this)" jstcache="50" st
yle="display: none; "> array of <span jsselect="items" jstcache="52"><span trans
clude="typeTemplate" jstcache="53"></span></span> </span> <span jsdisplay="!isAr
ray($this)" jscontent="getTypeName($this)" jstcache="51">string</span> </span> <
/span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstc
ache="38" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.desc
ription" jsvalues=".innerHTML:$this.description" jstcache="39" style="">If prese
nt, the toolstrip mole will change it's content to the provided url. Otherwise,
the current page will just be expanded in size.</dd> <!-- OBJECT PROPERTIES -->
<dd jsdisplay="shouldExpandObject($this)" jstcache="40" style="display: none; ">
<dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="10
" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.nam
e" jscontent="$this.name" jstcache="45">height</var> <em jstcache="0"> <!-- TYPE
--> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdispla
y="optional" jstcache="46" style="display: none; ">optional</span> <span id="typ
eTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="47" style
="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTy
peRef($this)" jscontent="getTypeRef($this)" jstcache="49"> Type</a> </span> <spa
n jsdisplay="!getTypeRef($this)" jstcache="48"> <span jsdisplay="isArray($this)"
jstcache="50" style="display: none; "> array of <span jsselect="items" jstcache
="52"><span transclude="typeTemplate" jstcache="53"></span></span> </span> <span
jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="51">intege
r</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this
.description" jstcache="38" style="display: none; "> Undocumented. </dd> <dd jsd
isplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="39"
style="">The vertical pixel height required of the toolstrip area.</dd> <!-- OB
JECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="40" styl
e="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject(
$this)" jstcache="10" jsinstance="0"> <div transclude="valueTemplate" jstcache="
17"> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="10"
jsinstance="*1"> <div transclude="valueTemplate" jstcache="17"> </div> </div> <
/dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcach
e="10" jsinstance="*1"> <div transclude="valueTemplate" jstcache="17"> </div> </
div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> <!--
/VALUE --> </div><div jsselect="parameters" jstcache="35" jsinstance="*1"> <!--
VALUE: This is a subtemplate that is used elsewhere via jsTemplate *transclude*
--> <div id="valueTemplate" jstcache="0"> <dt jstcache="0"> <var jsdisplay="$th
is.name" jscontent="$this.name" jstcache="45">callback</var> <em jstcache="0"> <
!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional"
jsdisplay="optional" jstcache="46">optional</span> <span id="typeTemplate" jstca
che="0"> <span jsdisplay="getTypeRef($this)" jstcache="47" style="display: none;
"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" js
content="getTypeRef($this)" jstcache="49"> Type</a> </span> <span jsdisplay="!ge
tTypeRef($this)" jstcache="48"> <span jsdisplay="isArray($this)" jstcache="50" s
tyle="display: none; "> array of <span jsselect="items" jstcache="52"><span tran
sclude="typeTemplate" jstcache="53"></span></span> </span> <span jsdisplay="!isA
rray($this)" jscontent="getTypeName($this)" jstcache="51">function</span> </span
> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" j
stcache="38"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".i
nnerHTML:$this.description" jstcache="39" style="display: none; "> Description o
f this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdi
splay="shouldExpandObject($this)" jstcache="40" style="display: none; "> <dl jst
cache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="10"> <div
transclude="valueTemplate" jstcache="17"> </div> </div> </dl> </dd> </div> <!--
/VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="30" s
tyle="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" js
tcache="36" style="display: none; "> <div transclude="valueTemplate" jstcache="1
7"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(par
ameters)" jstcache="31"> <div jsselect="getCallbackParameters(parameters)" jstca
che="37"> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specif
y the <em jstcache="0">callback</em> parameter, it should specify a function tha
t looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstc
ache="0">function(<span jscontent="getSignatureString(parameters)" jstcache="32"
></span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="
0"> <div jsselect="parameters" jstcache="35" jsinstance="*0" style="display: non
e; "> <div transclude="valueTemplate" jstcache="17"> </div> </div> </dl> </div>
</div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGro
up --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" c
lass="apiGroup" jstcache="7" style="display: none; "> <a name="events" jstcache=
"0"></a> <h3 id="events" jstcache="0">Events</h3> <!-- iterates over all events
--> <div jsselect="events" class="apiItem" jstcache="12"> <a jsvalues=".name:'ev
ent-' + name" jstcache="19"></a> <h4 jscontent="name" jstcache="16">event name</
h4> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 column
s --> <span jscontent="getModuleName() + '.'" class="subdued" jstcache="23">chro
me.bookmarks</span><span jscontent="name" jstcache="16">onEvent</span><span clas
s="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignat
ureString(parameters)" jstcache="32">Type param1, Type param2</span>) <span clas
s="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache
="0"> <p class="todo" jsdisplay="!description" jstcache="28">Undocumented.</p> <
p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="29"> A des
cription from the json schema def of the event goes here. </p> <!-- PARAMETERS -
-> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters"
jstcache="35"> <div transclude="valueTemplate" jstcache="17"> </div> </div> </d
l> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --
> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="ap
iGroup" jstcache="8" style="display: none; "> <a name="types" jstcache="0"></a>
<h3 id="types" jstcache="0">Types</h3> <!-- iterates over all types --> <div jss
elect="types" class="apiItem" jstcache="13"> <a jsvalues=".name:'type-' + id" js
tcache="20"></a> <h4 jscontent="id" jstcache="21">type name</h4> <div transclude
="valueTemplate" jstcache="17"> </div> </div> <!-- /apiItem --> </div> <!-- /api
Group --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /page
Content --> <div id="pageFooter" --="" jstcache="0"> <p jstcache="0"> Except as
otherwise <a href="http://code.google.com/policies.html#restrictions" jstcache="
0">noted</a>, the content of this page is licensed under the <a rel="license" hr
ef="http://creativecommons.org/licenses/by/3.0/" jstcache="0">Creative Commons A
ttribution 3.0 License</a>, and code samples are licensed under the <a rel="lice
nse" href="http://code.google.com/google_bsd_license.html" jstcache="0">BSD Lice
nse</a>. </p> <p jstcache="0"> ©2009 Google </p> </div> <!-- /pageFooter --> </d
iv> <!-- /container --> </body></html> | 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc.
Note: |
| 2 1) The <head> information in this page is significant, should be uniform |
| 3 across api docs and should be edited only with knowledge of the |
| 4 templating mechanism. |
| 5 2) The <body> tag *must* retain id="body" |
| 6 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a |
| 7 browser, it will be re-generated from the template, json schema and |
| 8 authored overview content. |
| 9 4) The <body>.innerHTML is also generated by an offline step so that this |
| 10 page may easily be indexed by search engines. |
| 11 |
| 12 TODO(rafaelw): Abstract this into a "pageshell" that becomes the single |
| 13 version of page template shell and the "instance" pages (bookmarks.html, |
| 14 etc...) can be generated with a build step. |
| 15 --><!-- <html> must retain id="template --><html xmlns="http://www.w3.org/1999/x
html" jstcache="0"><!-- <head> data is significant and loads the needed librarie
s and styles --><head jstcache="0"> |
| 16 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache=
"0"> |
| 17 <title jscontent="getPageTitle()" jstcache="1">Toolstrips</title> |
| 18 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache=
"0"> |
| 19 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla
te_compiled.js" jstcache="0"> |
| 20 </script> |
| 21 <script type="text/javascript" src="js/api_page_generator.js" jstcache="0"><
/script> |
| 22 <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script> |
| 23 </head><!-- <body> content is completely generated. Do not edit, as it will be |
| 24 and rewritten. --><body jstcache="0"> <div id="container" jstcache="0"> |
| 25 <a name="top" jstcache="0"> </a> |
| 26 <!-- API HEADER --> |
| 27 <div id="pageHeader" jstcache="0"> |
| 28 <div id="searchbox" jstcache="0"> |
| 29 <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0
"> |
| 30 <div jstcache="0"> |
| 31 <input type="hidden" name="cx" value="002967670403910741006:61_cvzfq
tno" jstcache="0"> |
| 32 <input type="hidden" name="ie" value="UTF-8" jstcache="0"> |
| 33 <input type="text" name="q" size="31" jstcache="0"> |
| 34 <input type="submit" name="sa" value="Search" jstcache="0"> |
| 35 </div> |
| 36 </form> |
| 37 |
| 38 <script type="text/javascript" src="http://www.google.com/jsapi" jstcach
e="0"></script> |
| 39 <script type="text/javascript" jstcache="0">google.load("elements", "1",
{packages: "transliteration"});</script> |
| 40 <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?
form=cse-search-box&t13n_langs=en" jstcache="0"></script> |
| 41 <script type="text/javascript" src="http://www.google.com/coop/cse/brand
?form=cse-search-box&lang=en" jstcache="0"></script> |
| 42 </div> |
| 43 <div id="pageTitle" jstcache="0"> |
| 44 <h1 jscontent="getPageTitle()" jstcache="1">Toolstrips</h1> |
| 45 </div> |
| 46 </div> <!-- /pageHeader --> |
| 47 |
| 48 <div id="pageContent" jstcache="0"> |
| 49 <!-- SIDENAV --> |
| 50 <div id="leftNav" jstcache="0"> |
| 51 <ul jstcache="0"> |
| 52 <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> |
| 53 <li jstcache="0"> <a href="getstarted.html" jstcache="0">Getting Start
ed</a></li> |
| 54 <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></l
i> |
| 55 <li jstcache="0"> <a href="devguide.html" jstcache="0"><div jstcache="
0">Developer's Guide</div></a> |
| 56 <ul jstcache="0"> |
| 57 <li jstcache="0" class="leftNavSelected">Toolstrips</li> |
| 58 <li jstcache="0"><a href="pageActions.html" jstcache="0">Page Acti
ons</a></li> |
| 59 <li jstcache="0"><a href="background_pages.html" jstcache="0">Back
ground Pages</a></li> |
| 60 <li jstcache="0"><a href="content_scripts.html" jstcache="0">Conte
nt Scripts</a></li> |
| 61 <li jstcache="0"><a href="events.html" jstcache="0">Events</a></li
> |
| 62 <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li> |
| 63 <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></
li> |
| 64 <li jstcache="0"><a href="bookmarks.html" jstcache="0">Bookmarks</
a></li> |
| 65 <li jstcache="0"><a href="themes.html" jstcache="0">Themes</a></li
> |
| 66 <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</
a></li> |
| 67 <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</
a></li> |
| 68 <li jstcache="0">Autoupdate</li> |
| 69 </ul> |
| 70 </li> |
| 71 <li jstcache="0"><a href="tutorials.html" jstcache="0"><div jstcache="
0">Tutorials</div></a> |
| 72 <ul jstcache="0"> |
| 73 <li jstcache="0"><a href="tut_debugging.html" jstcache="0">Debuggi
ng</a></li> |
| 74 </ul> |
| 75 </li> |
| 76 <li jstcache="0">Reference |
| 77 <ul jstcache="0"> |
| 78 <li jstcache="0"> Formats |
| 79 <ul jstcache="0"> |
| 80 <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest
Files</a></li> |
| 81 <li jstcache="0"><a href="match_patterns.html" jstcache="0">Ma
tch Patterns</a></li> |
| 82 <li jstcache="0">Packages (.crx)</li> |
| 83 </ul> |
| 84 </li> |
| 85 <li jstcache="0"> <a href="api_index.html" jstcache="0">chrome.* A
PIs</a> </li> |
| 86 <li jstcache="0"> <a href="api_other.html" jstcache="0">Other APIs
</a> </li> |
| 87 </ul> |
| 88 </li> |
| 89 <li jstcache="0"><a href="http://dev.chromium.org/developers/design-doc
uments/extensions/samples" jstcache="0">Samples</a></li> |
| 90 </ul> |
| 91 </div> |
| 92 |
| 93 <div id="mainColumn" jstcache="0"> |
| 94 <!-- TABLE OF CONTENTS --> |
| 95 <div id="toc" jsdisplay="showPageTOC()" jstcache="2"> |
| 96 <p jstcache="0">Contents</p> |
| 97 <ol jstcache="0"> |
| 98 <li jsselect="getStaticTOC()" jstcache="9" jsinstance="0"> |
| 99 <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14" href
="#manifest">Manifest</a> |
| 100 <ol jstcache="0"> |
| 101 <li jsselect="$this.children" jstcache="22" jsinstance="*0" styl
e="display: none; "> |
| 102 <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14">
h3Name</a> |
| 103 </li> |
| 104 </ol> |
| 105 </li><li jsselect="getStaticTOC()" jstcache="9" jsinstance="1"> |
| 106 <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14" href
="#H2-1">Creating buttons</a> |
| 107 <ol jstcache="0"> |
| 108 <li jsselect="$this.children" jstcache="22" jsinstance="*0" styl
e="display: none; "> |
| 109 <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14">
h3Name</a> |
| 110 </li> |
| 111 </ol> |
| 112 </li><li jsselect="getStaticTOC()" jstcache="9" jsinstance="2"> |
| 113 <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14" href
="#H2-2">Debugging tips</a> |
| 114 <ol jstcache="0"> |
| 115 <li jsselect="$this.children" jstcache="22" jsinstance="*0" styl
e="display: none; "> |
| 116 <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14">
h3Name</a> |
| 117 </li> |
| 118 </ol> |
| 119 </li><li jsselect="getStaticTOC()" jstcache="9" jsinstance="*3"> |
| 120 <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14" href
="#H2-3">Design tips</a> |
| 121 <ol jstcache="0"> |
| 122 <li jsselect="$this.children" jstcache="22" jsinstance="*0" styl
e="display: none; "> |
| 123 <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14">
h3Name</a> |
| 124 </li> |
| 125 </ol> |
| 126 </li> |
| 127 <div jsselect="apiDefinition" jstcache="3"> |
| 128 <li jstcache="0"> |
| 129 <a href="#apiReference" jscontent="'API reference: ' + getModule
Name()" jstcache="4">API reference: chrome.toolstrip</a> |
| 130 <ol jstcache="0"> |
| 131 <li jsdisplay="$this.properties" jstcache="5" style="display:
none; "> |
| 132 <a href="#properties" jstcache="0">Properties</a> |
| 133 <ol jstcache="0"> |
| 134 <li jsselect="getPropertyListFromObject($this)" jstcache="
10"> |
| 135 <a jscontent="name" jsvalues=".href:'#property-' + name"
href="#property-anchor" jstcache="42">propertyName</a> |
| 136 </li> |
| 137 </ol> |
| 138 </li> |
| 139 <li jsdisplay="functions && functions.length > 0" j
stcache="6"> |
| 140 <a href="#methods" jstcache="0">Methods</a> |
| 141 <ol jstcache="0"> |
| 142 <li jsselect="functions.sort(sortByName)" jstcache="11" js
instance="0"> |
| 143 <a jscontent="name" jsvalues=".href:'#method-' + name" h
ref="#method-collapse" jstcache="43">collapse</a> |
| 144 </li><li jsselect="functions.sort(sortByName)" jstcache="1
1" jsinstance="*1"> |
| 145 <a jscontent="name" jsvalues=".href:'#method-' + name" h
ref="#method-expand" jstcache="43">expand</a> |
| 146 </li> |
| 147 </ol> |
| 148 </li> |
| 149 <li jsdisplay="events && events.length > 0" jstcach
e="7" style="display: none; "> |
| 150 <a href="#events" jstcache="0">Events</a> |
| 151 <ol jstcache="0"> |
| 152 <li jsselect="events.sort(sortByName)" jstcache="12"> |
| 153 <a jscontent="name" jsvalues=".href:'#event-' + name" hr
ef="#event-anchor" jstcache="44">eventName</a> |
| 154 </li> |
| 155 </ol> |
| 156 </li> |
| 157 <li jsdisplay="types && types.length > 0" jstcache=
"8" style="display: none; "> |
| 158 <a href="#types" jstcache="0">Types</a> |
| 159 <ol jstcache="0"> |
| 160 <li jsselect="types.sort(sortByName)" jstcache="38"> |
| 161 <a jscontent="id" jsvalues=".href:'#type-' + id" href="#
id-anchor" jstcache="45">id</a> |
| 162 </li> |
| 163 </ol> |
| 164 </li> |
| 165 </ol> |
| 166 </li> |
| 167 </div> |
| 168 </ol> |
| 169 </div> |
| 170 <!-- /TABLE OF CONTENTS --> |
| 171 |
| 172 <!-- STATIC CONTENT PLACEHOLDER --> |
| 173 <div id="static" jstcache="0"><div id="pageData-title" class="pageData"
jstcache="0">Toolstrips</div> |
| 174 |
| 175 <!-- BEGIN AUTHORED CONTENT --> |
| 176 |
| 177 <p jstcache="0"> |
| 178 Toolstrips allow you to add UI to Google Chrome's toolbar area. |
| 179 Toolstrips are nothing more than (very small) HTML pages, |
| 180 so anything you can do with HTML/CSS/JavaScript, |
| 181 you can do with toolstrips. |
| 182 </p> |
| 183 |
| 184 <h2 id="manifest" jstcache="0">Manifest</h2> |
| 185 <p jstcache="0">Register your toolstrips in the extension manifest like this:</p
> |
| 186 |
| 187 <pre jstcache="0">{ |
| 188 "name": "My First Extension", |
| 189 "version": "1.0", |
| 190 "description": "The first extension that I made.", |
| 191 <b jstcache="0"> "toolstrips": [ |
| 192 "one_toolstrip.html", |
| 193 "two_toolstrip.html" |
| 194 ]</b> |
| 195 }</pre> |
| 196 |
| 197 <a name="H2-1" jstcache="0"></a><h2 jstcache="0">Creating buttons</h2> |
| 198 <p jstcache="0">You can create buttons that look like the bookmark bar buttons u
sing this template:</p> |
| 199 |
| 200 <pre jstcache="0"><div class="toolstrip-button"> |
| 201 <!-- Image is optional and should be a 16x16 icon. --> |
| 202 <img src="<em jstcache="0">path/to/some_icon.png</em>"> |
| 203 <span>My Button</span> |
| 204 </div></pre> |
| 205 |
| 206 |
| 207 <a name="H2-2" jstcache="0"></a><h2 jstcache="0">Debugging tips</h2> |
| 208 |
| 209 <ul jstcache="0"> |
| 210 <li jstcache="0">You can right click on a toolstrip to get a web inspector.</li> |
| 211 <li jstcache="0">alert(), prompt(), and confirm() don't work yet. Sorry about th
at.</li> |
| 212 <li jstcache="0">You can run toolstrips in the main content area by loading thei
r URL, which would be something like chrome-extension://000000000000000000000000
0000000000000000/my_toolstrip.html</li> |
| 213 </ul> |
| 214 |
| 215 <a name="H2-3" jstcache="0"></a><h2 jstcache="0">Design tips</h2> |
| 216 |
| 217 <ul jstcache="0"> |
| 218 <li jstcache="0">Try not to use too much space. Toolbar real estate is precious
and users tend to prefer extensions to use as little of it as possible.</li> |
| 219 <li jstcache="0">The toolbar automatically detects how much space a toolstrip ne
eds and reflows. So you can resize your toolstrip dynamically if you need a litt
le more room temporarily.</li> |
| 220 <li jstcache="0">If you need to do more extensive UI, use the tab contents area
or a pop up window.</li> |
| 221 <li jstcache="0">Remember that there can be multiple instances of a given toolst
rip page running at one time. Each browser window has its own toolstrip. If you
need long-running application logic, try Background Pages.</li> |
| 222 </ul> |
| 223 <!-- END AUTHORED CONTENT --> |
| 224 </div> |
| 225 |
| 226 <!-- API PAGE --> |
| 227 <div class="apiPage" jsselect="apiDefinition" jstcache="3"> |
| 228 <a name="apiReference" jstcache="0"></a> |
| 229 <h2 jscontent="'API reference: ' + getModuleName()" jstcache="4">API ref
erence: chrome.toolstrip</h2> |
| 230 |
| 231 <!-- PROPERTIES --> |
| 232 <div jsdisplay="$this.properties" class="apiGroup" jstcache="5" style=
"display: none; "> |
| 233 <a name="properties" jstcache="0"></a> |
| 234 <h3 id="properties" jstcache="0">Properties</h3> |
| 235 |
| 236 <div jsselect="getPropertyListFromObject($this)" jstcache="10"> |
| 237 <a jsvalues=".name:'property-' + name" jstcache="15"></a> |
| 238 <h4 jscontent="name" jstcache="16">getLastError</h4> |
| 239 <div class="summary" jstcache="0"> |
| 240 <!-- Note: intentionally longer 80 columns --> |
| 241 <span jscontent="getModuleName() + '.'" jstcache="23">chrome.ext
ension</span><span jscontent="$this.name" jstcache="24">lastError</span> |
| 242 </div> |
| 243 <div transclude="valueTemplate" jstcache="17"> |
| 244 </div> |
| 245 </div> |
| 246 |
| 247 </div> <!-- /apiGroup --> |
| 248 |
| 249 <!-- METHODS --> |
| 250 <div jsdisplay="functions && functions.length > 0" class="a
piGroup" id="methods" jstcache="6"> |
| 251 <a name="methods" jstcache="0"></a> |
| 252 <h3 jstcache="0">Methods</h3> |
| 253 |
| 254 <!-- iterates over all functions --> |
| 255 <div class="apiItem" jsselect="functions.sort(sortByName)" jstcache=
"11" jsinstance="0"> |
| 256 <a jsvalues=".name:'method-' + name" jstcache="18" name="method-co
llapse"></a> <!-- method-anchor --> |
| 257 <h4 jscontent="name" jstcache="16">collapse</h4> |
| 258 |
| 259 <div class="summary" jstcache="0"><span jsdisplay="returns" jscont
ent="getTypeName(returns)" jstcache="25" style="display: none; ">void</span> |
| 260 <!-- Note: intentionally longer 80 columns --> |
| 261 <span jscontent="getFullyQualifiedFunctionName($this)" jstcach
e="26">chrome.toolstrip.collapse</span>(<span jsselect="parameters" jsvalues="cl
ass:optional ? 'optional' : ''" jstcache="27" jsinstance="0" class="optional"><s
pan jsdisplay="$index" jstcache="33" style="display: none; ">, </span><span jsco
ntent="getTypeName($this)" jstcache="34">object</span> |
| 262 <var jstcache="0"><span jscontent="name" jstcache="16">col
lapseInfo</span></var></span><span jsselect="parameters" jsvalues="class:optiona
l ? 'optional' : ''" jstcache="27" jsinstance="*1" class="optional"><span jsdisp
lay="$index" jstcache="33">, </span><span jscontent="getTypeName($this)" jstcach
e="34">function</span> |
| 263 <var jstcache="0"><span jscontent="name" jstcache="16">cal
lback</span></var></span>)</div> |
| 264 |
| 265 <div class="description" jstcache="0"> |
| 266 <p class="todo" jsdisplay="!description" jstcache="28">Undocumen
ted.</p> |
| 267 <p jsdisplay="description" jsvalues=".innerHTML:description" jst
cache="29" style="display: none; "> |
| 268 A description from the json schema def of the function goes he
re. |
| 269 </p> |
| 270 |
| 271 <!-- PARAMETERS --> |
| 272 <h4 jstcache="0">Parameters</h4> |
| 273 <dl jstcache="0"> |
| 274 <div jsselect="parameters" jstcache="35" jsinstance="0"> |
| 275 |
| 276 <!-- VALUE: This is a subtemplate that is used elsewhere |
| 277 via jsTemplate *transclude* --> |
| 278 <div id="valueTemplate" jstcache="0"> |
| 279 <dt jstcache="0"> |
| 280 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">collapseInfo</var> |
| 281 <em jstcache="0"> |
| 282 |
| 283 <!-- TYPE --> |
| 284 <div style="display:inline" jstcache="0"> |
| 285 ( |
| 286 <span class="optional" jsdisplay="optional" jstc
ache="47">optional</span> |
| 287 <span id="typeTemplate" jstcache="0"> |
| 288 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 289 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 290 </span> |
| 291 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 292 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 293 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 294 </span> |
| 295 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">object</span> |
| 296 </span> |
| 297 </span> |
| 298 ) |
| 299 </div> |
| 300 |
| 301 </em> |
| 302 </dt> |
| 303 <dd class="todo" jsdisplay="!$this.description" jstcache="
39"> |
| 304 Undocumented. |
| 305 </dd> |
| 306 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="display: none; "> |
| 307 Description of this parameter from the json schema. |
| 308 </dd> |
| 309 |
| 310 <!-- OBJECT PROPERTIES --> |
| 311 <dd jsdisplay="shouldExpandObject($this)" jstcache="41"> |
| 312 <dl jstcache="0"> |
| 313 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 314 <div jstcache="0"> |
| 315 <dt jstcache="0"> |
| 316 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">url</var> |
| 317 <em jstcache="0"> |
| 318 |
| 319 <!-- TYPE --> |
| 320 <div style="display:inline" jstcache="0"> |
| 321 ( |
| 322 <span class="optional" jsdisplay="optional" jstc
ache="47">optional</span> |
| 323 <span id="typeTemplate" jstcache="0"> |
| 324 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 325 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 326 </span> |
| 327 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 328 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 329 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 330 </span> |
| 331 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">string</span> |
| 332 </span> |
| 333 </span> |
| 334 ) |
| 335 </div> |
| 336 |
| 337 </em> |
| 338 </dt> |
| 339 <dd class="todo" jsdisplay="!$this.description" jstcache="
39" style="display: none; "> |
| 340 Undocumented. |
| 341 </dd> |
| 342 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="">If present, the toolstrip mole will chang
e it's content to the provided url. Otherwise, the current page will just be col
lapsed in size.</dd> |
| 343 |
| 344 <!-- OBJECT PROPERTIES --> |
| 345 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 346 <dl jstcache="0"> |
| 347 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 348 <div transclude="valueTemplate" jstcache="17"> |
| 349 </div> |
| 350 </div> |
| 351 </dl> |
| 352 </dd> |
| 353 </div> |
| 354 </div> |
| 355 </dl> |
| 356 </dd> |
| 357 </div> <!-- /VALUE --> |
| 358 |
| 359 </div><div jsselect="parameters" jstcache="35" jsinstance="*1"
> |
| 360 |
| 361 <!-- VALUE: This is a subtemplate that is used elsewhere |
| 362 via jsTemplate *transclude* --> |
| 363 <div id="valueTemplate" jstcache="0"> |
| 364 <dt jstcache="0"> |
| 365 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">callback</var> |
| 366 <em jstcache="0"> |
| 367 |
| 368 <!-- TYPE --> |
| 369 <div style="display:inline" jstcache="0"> |
| 370 ( |
| 371 <span class="optional" jsdisplay="optional" jstc
ache="47">optional</span> |
| 372 <span id="typeTemplate" jstcache="0"> |
| 373 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 374 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 375 </span> |
| 376 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 377 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 378 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 379 </span> |
| 380 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">function</span> |
| 381 </span> |
| 382 </span> |
| 383 ) |
| 384 </div> |
| 385 |
| 386 </em> |
| 387 </dt> |
| 388 <dd class="todo" jsdisplay="!$this.description" jstcache="
39"> |
| 389 Undocumented. |
| 390 </dd> |
| 391 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="display: none; "> |
| 392 Description of this parameter from the json schema. |
| 393 </dd> |
| 394 |
| 395 <!-- OBJECT PROPERTIES --> |
| 396 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 397 <dl jstcache="0"> |
| 398 <div jsselect="getPropertyListFromObject($this)" jstca
che="10"> |
| 399 <div transclude="valueTemplate" jstcache="17"> |
| 400 </div> |
| 401 </div> |
| 402 </dl> |
| 403 </dd> |
| 404 </div> <!-- /VALUE --> |
| 405 |
| 406 </div> |
| 407 </dl> |
| 408 |
| 409 <!-- RETURNS --> |
| 410 <h4 jsdisplay="returns" jstcache="30" style="display: none; ">Re
turns</h4> |
| 411 <dl jstcache="0"> |
| 412 <div jsselect="returns" jstcache="36" style="display: none; "> |
| 413 <div transclude="valueTemplate" jstcache="17"> |
| 414 </div> |
| 415 </div> |
| 416 </dl> |
| 417 |
| 418 <!-- CALLBACK --> |
| 419 <div jsdisplay="hasCallback(parameters)" jstcache="31"> |
| 420 <div jsselect="getCallbackParameters(parameters)" jstcache="37
"> |
| 421 <h4 jstcache="0">Callback function</h4> |
| 422 <p jstcache="0"> |
| 423 If you specify the <em jstcache="0">callback</em> parameter, |
| 424 it should specify a function that looks like this: |
| 425 </p> |
| 426 |
| 427 <!-- Note: intentionally longer 80 columns --> |
| 428 <pre jstcache="0">function(<span jscontent="getSignatureString
(parameters)" jstcache="32"></span>) <span class="subdued" jstcache="0">{...}</s
pan>);</pre> |
| 429 <dl jstcache="0"> |
| 430 <div jsselect="parameters" jstcache="35" jsinstance="*0" sty
le="display: none; "> |
| 431 <div transclude="valueTemplate" jstcache="17"> |
| 432 </div> |
| 433 </div> |
| 434 </dl> |
| 435 </div> |
| 436 </div> |
| 437 |
| 438 </div> <!-- /description --> |
| 439 |
| 440 </div><div class="apiItem" jsselect="functions.sort(sortByName)" jst
cache="11" jsinstance="*1"> |
| 441 <a jsvalues=".name:'method-' + name" jstcache="18" name="method-ex
pand"></a> <!-- method-anchor --> |
| 442 <h4 jscontent="name" jstcache="16">expand</h4> |
| 443 |
| 444 <div class="summary" jstcache="0"><span jsdisplay="returns" jscont
ent="getTypeName(returns)" jstcache="25" style="display: none; ">void</span> |
| 445 <!-- Note: intentionally longer 80 columns --> |
| 446 <span jscontent="getFullyQualifiedFunctionName($this)" jstcach
e="26">chrome.toolstrip.expand</span>(<span jsselect="parameters" jsvalues="clas
s:optional ? 'optional' : ''" jstcache="27" jsinstance="0" class="null"><span js
display="$index" jstcache="33" style="display: none; ">, </span><span jscontent=
"getTypeName($this)" jstcache="34">object</span> |
| 447 <var jstcache="0"><span jscontent="name" jstcache="16">exp
andInfo</span></var></span><span jsselect="parameters" jsvalues="class:optional
? 'optional' : ''" jstcache="27" jsinstance="*1" class="optional"><span jsdispla
y="$index" jstcache="33">, </span><span jscontent="getTypeName($this)" jstcache=
"34">function</span> |
| 448 <var jstcache="0"><span jscontent="name" jstcache="16">cal
lback</span></var></span>)</div> |
| 449 |
| 450 <div class="description" jstcache="0"> |
| 451 <p class="todo" jsdisplay="!description" jstcache="28">Undocumen
ted.</p> |
| 452 <p jsdisplay="description" jsvalues=".innerHTML:description" jst
cache="29" style="display: none; "> |
| 453 A description from the json schema def of the function goes he
re. |
| 454 </p> |
| 455 |
| 456 <!-- PARAMETERS --> |
| 457 <h4 jstcache="0">Parameters</h4> |
| 458 <dl jstcache="0"> |
| 459 <div jsselect="parameters" jstcache="35" jsinstance="0"> |
| 460 |
| 461 <!-- VALUE: This is a subtemplate that is used elsewhere |
| 462 via jsTemplate *transclude* --> |
| 463 <div id="valueTemplate" jstcache="0"> |
| 464 <dt jstcache="0"> |
| 465 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">expandInfo</var> |
| 466 <em jstcache="0"> |
| 467 |
| 468 <!-- TYPE --> |
| 469 <div style="display:inline" jstcache="0"> |
| 470 ( |
| 471 <span class="optional" jsdisplay="optional" jstc
ache="47" style="display: none; ">optional</span> |
| 472 <span id="typeTemplate" jstcache="0"> |
| 473 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 474 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 475 </span> |
| 476 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 477 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 478 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 479 </span> |
| 480 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">object</span> |
| 481 </span> |
| 482 </span> |
| 483 ) |
| 484 </div> |
| 485 |
| 486 </em> |
| 487 </dt> |
| 488 <dd class="todo" jsdisplay="!$this.description" jstcache="
39"> |
| 489 Undocumented. |
| 490 </dd> |
| 491 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="display: none; "> |
| 492 Description of this parameter from the json schema. |
| 493 </dd> |
| 494 |
| 495 <!-- OBJECT PROPERTIES --> |
| 496 <dd jsdisplay="shouldExpandObject($this)" jstcache="41"> |
| 497 <dl jstcache="0"> |
| 498 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="0"> |
| 499 <div jstcache="0"> |
| 500 <dt jstcache="0"> |
| 501 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">height</var> |
| 502 <em jstcache="0"> |
| 503 |
| 504 <!-- TYPE --> |
| 505 <div style="display:inline" jstcache="0"> |
| 506 ( |
| 507 <span class="optional" jsdisplay="optional" jstc
ache="47" style="display: none; ">optional</span> |
| 508 <span id="typeTemplate" jstcache="0"> |
| 509 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 510 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 511 </span> |
| 512 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 513 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 514 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 515 </span> |
| 516 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">integer</span> |
| 517 </span> |
| 518 </span> |
| 519 ) |
| 520 </div> |
| 521 |
| 522 </em> |
| 523 </dt> |
| 524 <dd class="todo" jsdisplay="!$this.description" jstcache="
39" style="display: none; "> |
| 525 Undocumented. |
| 526 </dd> |
| 527 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="">The vertical pixel height required of the
toolstrip area.</dd> |
| 528 |
| 529 <!-- OBJECT PROPERTIES --> |
| 530 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 531 <dl jstcache="0"> |
| 532 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 533 <div jstcache="0"> |
| 534 <dt jstcache="0"> |
| 535 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">url</var> |
| 536 <em jstcache="0"> |
| 537 |
| 538 <!-- TYPE --> |
| 539 <div style="display:inline" jstcache="0"> |
| 540 ( |
| 541 <span class="optional" jsdisplay="optional" jstc
ache="47">optional</span> |
| 542 <span id="typeTemplate" jstcache="0"> |
| 543 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 544 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 545 </span> |
| 546 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 547 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 548 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 549 </span> |
| 550 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">string</span> |
| 551 </span> |
| 552 </span> |
| 553 ) |
| 554 </div> |
| 555 |
| 556 </em> |
| 557 </dt> |
| 558 <dd class="todo" jsdisplay="!$this.description" jstcache="
39" style="display: none; "> |
| 559 Undocumented. |
| 560 </dd> |
| 561 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="">If present, the toolstrip mole will chang
e it's content to the provided url. Otherwise, the current page will just be col
lapsed in size.</dd> |
| 562 |
| 563 <!-- OBJECT PROPERTIES --> |
| 564 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 565 <dl jstcache="0"> |
| 566 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 567 <div transclude="valueTemplate" jstcache="17"> |
| 568 </div> |
| 569 </div> |
| 570 </dl> |
| 571 </dd> |
| 572 </div> |
| 573 </div> |
| 574 </dl> |
| 575 </dd> |
| 576 </div> |
| 577 </div><div jsselect="getPropertyListFromObject($this)"
jstcache="10" jsinstance="*1"> |
| 578 <div jstcache="0"> |
| 579 <dt jstcache="0"> |
| 580 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">url</var> |
| 581 <em jstcache="0"> |
| 582 |
| 583 <!-- TYPE --> |
| 584 <div style="display:inline" jstcache="0"> |
| 585 ( |
| 586 <span class="optional" jsdisplay="optional" jstc
ache="47">optional</span> |
| 587 <span id="typeTemplate" jstcache="0"> |
| 588 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 589 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 590 </span> |
| 591 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 592 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 593 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 594 </span> |
| 595 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">string</span> |
| 596 </span> |
| 597 </span> |
| 598 ) |
| 599 </div> |
| 600 |
| 601 </em> |
| 602 </dt> |
| 603 <dd class="todo" jsdisplay="!$this.description" jstcache="
39" style="display: none; "> |
| 604 Undocumented. |
| 605 </dd> |
| 606 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="">If present, the toolstrip mole will chang
e it's content to the provided url. Otherwise, the current page will just be exp
anded in size.</dd> |
| 607 |
| 608 <!-- OBJECT PROPERTIES --> |
| 609 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 610 <dl jstcache="0"> |
| 611 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 612 <div jstcache="0"> |
| 613 <dt jstcache="0"> |
| 614 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">url</var> |
| 615 <em jstcache="0"> |
| 616 |
| 617 <!-- TYPE --> |
| 618 <div style="display:inline" jstcache="0"> |
| 619 ( |
| 620 <span class="optional" jsdisplay="optional" jstc
ache="47">optional</span> |
| 621 <span id="typeTemplate" jstcache="0"> |
| 622 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 623 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 624 </span> |
| 625 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 626 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 627 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 628 </span> |
| 629 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">string</span> |
| 630 </span> |
| 631 </span> |
| 632 ) |
| 633 </div> |
| 634 |
| 635 </em> |
| 636 </dt> |
| 637 <dd class="todo" jsdisplay="!$this.description" jstcache="
39" style="display: none; "> |
| 638 Undocumented. |
| 639 </dd> |
| 640 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="">If present, the toolstrip mole will chang
e it's content to the provided url. Otherwise, the current page will just be col
lapsed in size.</dd> |
| 641 |
| 642 <!-- OBJECT PROPERTIES --> |
| 643 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 644 <dl jstcache="0"> |
| 645 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 646 <div transclude="valueTemplate" jstcache="17"> |
| 647 </div> |
| 648 </div> |
| 649 </dl> |
| 650 </dd> |
| 651 </div> |
| 652 </div> |
| 653 </dl> |
| 654 </dd> |
| 655 </div> |
| 656 </div> |
| 657 </dl> |
| 658 </dd> |
| 659 </div> <!-- /VALUE --> |
| 660 |
| 661 </div><div jsselect="parameters" jstcache="35" jsinstance="*1"
> |
| 662 |
| 663 <!-- VALUE: This is a subtemplate that is used elsewhere |
| 664 via jsTemplate *transclude* --> |
| 665 <div id="valueTemplate" jstcache="0"> |
| 666 <dt jstcache="0"> |
| 667 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">callback</var> |
| 668 <em jstcache="0"> |
| 669 |
| 670 <!-- TYPE --> |
| 671 <div style="display:inline" jstcache="0"> |
| 672 ( |
| 673 <span class="optional" jsdisplay="optional" jstc
ache="47">optional</span> |
| 674 <span id="typeTemplate" jstcache="0"> |
| 675 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 676 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 677 </span> |
| 678 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 679 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 680 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 681 </span> |
| 682 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">function</span> |
| 683 </span> |
| 684 </span> |
| 685 ) |
| 686 </div> |
| 687 |
| 688 </em> |
| 689 </dt> |
| 690 <dd class="todo" jsdisplay="!$this.description" jstcache="
39"> |
| 691 Undocumented. |
| 692 </dd> |
| 693 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="display: none; "> |
| 694 Description of this parameter from the json schema. |
| 695 </dd> |
| 696 |
| 697 <!-- OBJECT PROPERTIES --> |
| 698 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 699 <dl jstcache="0"> |
| 700 <div jsselect="getPropertyListFromObject($this)" jstca
che="10"> |
| 701 <div transclude="valueTemplate" jstcache="17"> |
| 702 </div> |
| 703 </div> |
| 704 </dl> |
| 705 </dd> |
| 706 </div> <!-- /VALUE --> |
| 707 |
| 708 </div> |
| 709 </dl> |
| 710 |
| 711 <!-- RETURNS --> |
| 712 <h4 jsdisplay="returns" jstcache="30" style="display: none; ">Re
turns</h4> |
| 713 <dl jstcache="0"> |
| 714 <div jsselect="returns" jstcache="36" style="display: none; "> |
| 715 <div transclude="valueTemplate" jstcache="17"> |
| 716 </div> |
| 717 </div> |
| 718 </dl> |
| 719 |
| 720 <!-- CALLBACK --> |
| 721 <div jsdisplay="hasCallback(parameters)" jstcache="31"> |
| 722 <div jsselect="getCallbackParameters(parameters)" jstcache="37
"> |
| 723 <h4 jstcache="0">Callback function</h4> |
| 724 <p jstcache="0"> |
| 725 If you specify the <em jstcache="0">callback</em> parameter, |
| 726 it should specify a function that looks like this: |
| 727 </p> |
| 728 |
| 729 <!-- Note: intentionally longer 80 columns --> |
| 730 <pre jstcache="0">function(<span jscontent="getSignatureString
(parameters)" jstcache="32"></span>) <span class="subdued" jstcache="0">{...}</s
pan>);</pre> |
| 731 <dl jstcache="0"> |
| 732 <div jsselect="parameters" jstcache="35" jsinstance="*0" sty
le="display: none; "> |
| 733 <div transclude="valueTemplate" jstcache="17"> |
| 734 </div> |
| 735 </div> |
| 736 </dl> |
| 737 </div> |
| 738 </div> |
| 739 |
| 740 </div> <!-- /description --> |
| 741 |
| 742 </div> <!-- /apiItem --> |
| 743 |
| 744 </div> <!-- /apiGroup --> |
| 745 |
| 746 <!-- EVENTS --> |
| 747 <div jsdisplay="events && events.length > 0" class="apiGrou
p" jstcache="7" style="display: none; "> |
| 748 <a name="events" jstcache="0"></a> |
| 749 <h3 id="events" jstcache="0">Events</h3> |
| 750 |
| 751 <!-- iterates over all events --> |
| 752 <div jsselect="events.sort(sortByName)" class="apiItem" jstcache="12
"> |
| 753 <a jsvalues=".name:'event-' + name" jstcache="19"></a> |
| 754 <h4 jscontent="name" jstcache="16">event name</h4> |
| 755 |
| 756 <div class="summary" jstcache="0"> |
| 757 <!-- Note: intentionally longer 80 columns --> |
| 758 <span jscontent="getModuleName() + '.'" class="subdued" jstcache
="23">chrome.bookmarks</span><span jscontent="name" jstcache="16">onEvent</span>
<span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent=
"getSignatureString(parameters)" jstcache="32">Type param1, Type param2</span>)
<span class="subdued" jstcache="0">{...}</span>); |
| 759 </div> |
| 760 |
| 761 <div class="description" jstcache="0"> |
| 762 <p class="todo" jsdisplay="!description" jstcache="28">Undocumen
ted.</p> |
| 763 <p jsdisplay="description" jsvalues=".innerHTML:description" jst
cache="29"> |
| 764 A description from the json schema def of the event goes here. |
| 765 </p> |
| 766 |
| 767 <!-- PARAMETERS --> |
| 768 <h4 jstcache="0">Parameters</h4> |
| 769 <dl jstcache="0"> |
| 770 <div jsselect="parameters" jstcache="35"> |
| 771 <div transclude="valueTemplate" jstcache="17"> |
| 772 </div> |
| 773 </div> |
| 774 </dl> |
| 775 |
| 776 </div> <!-- /decription --> |
| 777 |
| 778 </div> <!-- /apiItem --> |
| 779 |
| 780 </div> <!-- /apiGroup --> |
| 781 |
| 782 <!-- TYPES --> |
| 783 <div jsdisplay="types && types.length > 0" class="apiGroup"
jstcache="8" style="display: none; "> |
| 784 <a name="types.sort(sortByName)" jstcache="0"></a> |
| 785 <h3 id="types" jstcache="0">Types</h3> |
| 786 |
| 787 <!-- iterates over all types --> |
| 788 <div jsselect="types" class="apiItem" jstcache="13"> |
| 789 <a jsvalues=".name:'type-' + id" jstcache="20"></a> |
| 790 <h4 jscontent="id" jstcache="21">type name</h4> |
| 791 |
| 792 <div transclude="valueTemplate" jstcache="17"> |
| 793 </div> |
| 794 |
| 795 </div> <!-- /apiItem --> |
| 796 |
| 797 </div> <!-- /apiGroup --> |
| 798 |
| 799 </div> <!-- /apiPage --> |
| 800 </div> <!-- /mainColumn --> |
| 801 </div> <!-- /pageContent --> |
| 802 <div id="pageFooter" --="" jstcache="0"> |
| 803 <p jstcache="0"> |
| 804 Except as otherwise <a href="http://code.google.com/policies.html#restrictions
" jstcache="0">noted</a>, |
| 805 the content of this page is licensed under the <a rel="license" href="http://c
reativecommons.org/licenses/by/3.0/" jstcache="0">Creative Commons |
| 806 Attribution 3.0 License</a>, and code samples are licensed under the |
| 807 <a rel="license" href="http://code.google.com/google_bsd_license.html" jstcach
e="0">BSD License</a>. |
| 808 </p> |
| 809 <p jstcache="0"> |
| 810 ©2009 Google |
| 811 </p> |
| 812 </div> <!-- /pageFooter --> |
| 813 </div> <!-- /container --> |
| 814 </body></html> |
| 815 #EOF |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 179068:
Extension Doc Changes (no building or testable changes): minor changes for tab & windows doc (Closed)
