---
title: Findbar API
slug: Findbar_API
---
<p>Mozilla 1.9 から検索バー機能が拡張や XULRunner アプリケーション向けに toolkit xul ウィジットとして利用可能になります。</p>

<h3 id="API" name="API">API</h3>

<p>findbar 要素は次のいずれかの方法で特定の browser 要素に追加されます。</p>

<ul>
 <li>findbar 要素が紐づけられる前に <code>browserid</code> 属性を browser 要素の id に設定する。</li>
 <li><code>browser</code> プロパティを browser 要素そのものに設定する</li>
</ul>

<h4 id=".E5.85.AC.E9.96.8B.E3.83.A1.E3.82.BD.E3.83.83.E3.83.89" name=".E5.85.AC.E9.96.8B.E3.83.A1.E3.82.BD.E3.83.83.E3.83.89">公開メソッド</h4>

<dl>
 <dt>open</dt>
 <dd>検索バーを開く。
 <ul>
  <li>aMode - 使う検索モード。<code>FIND_NORMAL</code> か <code>FIND_TYPEAHEAD</code>、<code>FIND_LINKS</code> のどれか。指定されなければ最後の検索モードか、それもなければ <code>FIND_NORMAL</code> が使われます。</li>
 </ul>
 </dd>
</dl>

<dl>
 <dt>close</dt>
 <dd>検索バーを閉じる。</dd>
 <dt>startFind</dt>
 <dd>検索バーを開き、検索フィールドにフォーカスをあて中身を選択します。このメソッドを呼ぶと最初に検索バーが使われるときに内容を空にします。
 <ul>
  <li>aMode - 使う検索モード。<code>FIND_NORMAL</code> か <code>FIND_TYPEAHEAD</code>、<code>FIND_LINKS</code> のどれか。指定されなければ最後の検索モードか それもなければ <code>FIND_NORMAL</code> が使われます。</li>
 </ul>
 </dd>
 <dd>通常、ウィンドウの検索コマンドはこのメソッドにマップされるべきです。例えば</dd>
</dl>

<pre class="eval">&lt;command name="cmd_find" oncommand="gFindBar.startFind(gFindBar.FIND_NORMAL);"/&gt;
</pre>

<dl>
 <dt>onFindAgainCommand</dt>
 <dd>ウィンドウの次を検索か前を検索にはこのメソッドを使ってください。
 <ul>
  <li>aFindPrevious - 前を検索なら true, それ以外なら false。</li>
 </ul>
 </dd>
</dl>

<dl>
 <dt>toggleHighlight</dt>
 <dd>ハイライトの有効/無効を切替える。
 <ul>
  <li>aHighlight (boolean) - ハイライトを有効にするかどうか。</li>
 </ul>
 </dd>
</dl>

<h4 id=".E3.83.97.E3.83.AD.E3.83.91.E3.83.86.E3.82.A3" name=".E3.83.97.E3.83.AD.E3.83.91.E3.83.86.E3.82.A3">プロパティ</h4>

<dl>
 <dt>findMode (読み込みのみ)</dt>
 <dd>アクティブな検索モード</dd>
 <dt>browser</dt>
 <dd>findbar がアタッチされる browser 要素</dd>
</dl>

<h4 id=".E5.B1.9E.E6.80.A7" name=".E5.B1.9E.E6.80.A7">属性</h4>

<dl>
 <dt>browserid</dt>
 <dd>検索バーがアタッチする browser 要素の id。この属性は検索バーが組み立てるときにのみ使われます。スクリプトから設定したり読み出すには <code>browser</code> プロパティを使うことになるでしょう。</dd>
</dl>

<h5 id=".E3.82.A2.E3.82.AF.E3.82.BB.E3.82.B9.E3.82.AD.E3.83.BC.E5.B1.9E.E6.80.A7" name=".E3.82.A2.E3.82.AF.E3.82.BB.E3.82.B9.E3.82.AD.E3.83.BC.E5.B1.9E.E6.80.A7">アクセスキー属性</h5>

<p>検索バーの UI 要素への標準アクセスキーは findebar.dtd で与えられれます。しかし以下の属性を使うことで上書き可能です。</p>

<dl>
 <dt>findnextaccesskey</dt>
 <dd>「次を検索」ツールバーボタン(toolbarbutton)のアクセスキー</dd>
 <dt>findpreviousaccesskey</dt>
 <dd>「前を検索」ツールバーボタン(toolbarbutton)のアクセスキー</dd>
 <dt>highlightaccesskey</dt>
 <dd>「ハイライト」ツールバーボタン(toolbarbutton)のアクセスキー</dd>
 <dt>matchcaseaccesskey</dt>
 <dd>「大文字/小文字を区別」ツールバーボタン(toolbarbutton)のアクセスキー</dd>
</dl>

<h4 id="Find-as-you-type-beahavior" name="Find-as-you-type-beahavior">Find-as-you-type-beahavior</h4>

<h4 id=".E3.83.86.E3.83.BC.E3.83.9E" name=".E3.83.86.E3.83.BC.E3.83.9E">テーマ</h4>