textbox (Toolkit autocomplete)

この要素は、textbox の type 属性を autocomplete に設定することによって作成されます。これは、ユーザが入力しはじめると可能な補完リストが含まれるポップアップを表示する textbox を作成します。

Firefox などの Toolkit アプリケーションは Mozilla suite とは異なる自動補完 (autocomplete)機構を使用します。下の例は、ユーザの履歴を検索する自動補完 textbox を作成します。

属性
accesskey, autocompletepopup, autocompletesearch, autocompletesearchparam, completedefaultindex, crop, disableautocomplete, disabled, disablekeynavigation, enablehistory, focused, forcecomplete, highlightnonmatches, ignoreblurwhilesearching, inputtooltiptext, label, maxlength, maxrows, minresultsforpopup, nomatch, onchange, oninput, onsearchcomplete, ontextentered, ontextreverted, open, readonly, showcommentcolumn, size, tabindex, tabscrolling, timeout, type, value
プロパティ
accessibleType, completeDefaultIndex, controller, crop, disableAutoComplete, disableKeyNavigation, disabled, editable, focused, forceComplete, highlightNonMatches, ignoreBlurWhileSearching, inputField, label, maxLength, maxRows, minResultsForPopup, open, popup, popupOpen, searchCount, searchParam, selectionEnd, selectionStart, showCommentColumn, showImageColumn,size, tabIndex, tabScrolling, textLength, textValue, timeout, type, value
メソッド
getSearchAt, onSearchComplete, onTextEntered, onTextReverted, select, setSelectionRange

<textbox type="autocomplete" autocompletesearch="history"/>

属性

accesskey
型: 文字型
ショートカットキーとして使用される文字を設定します。この文字はその要素の label 属性のテキストに現れる文字の一つでなければいけません。
autocompletepopup
型: popup 要素の id
popup 要素の id は、要素のための自動補完の候補を保持します。
autocompletesearch New in Thunderbird 2要 SeaMonkey 1.1
Type: space-separated list of values
A space-separated list of search component names, each of which implements the nsIAutoCompleteSearch interface. The components are created using the name @mozilla.org/autocomplete/search;1?name= where name is listed in this attribute.
search-autocomplete 要 SeaMonkey 2.1
The user's default search engine's suggestions are searched.
places-tag-autocomplete 要 SeaMonkey 2.1
The user's Places tags are searched.
mydomain New in Thunderbird 3 要 SeaMonkey 2.0
The user's email domain is suggested.
history 要 SeaMonkey 2.0
The user's URL history is searched.
form-history 要 SeaMonkey 2.0
Search the values that the user has entered into form fields.
file (Linux only)
The local file system is searched.
gloda New in Thunderbird 3
 
addrbook New in Thunderbird 3 要 SeaMonkey 2.0
The user's address book is searched.
autocompletesearchparam New in Thunderbird 2 要 SeaMonkey 1.1
型: 文字列型
検索コンポーネントに渡される文字列。
completedefaultindex
型: 論理型
true の場合、ユーザが入力した値に最もマッチする値が textbox に入力されます。false に設定するか省略すると、値をリストから選択しなければなりません。
crop
型: 論理型
この属性は使用されません。menulist 要素との互換性のためにのみ提供されています。
disableAutocomplete
型: 論理型
true の場合、自動補完が無効になります。この属性を変更するにはスクリプトを使用します。デフォルト値の false の場合、自動補完は有効になります。
disabled
型: 論理型
要素が無効化されているかどうかを示します。ある要素が true に設定されていたら、その要素は無効化されています。無効化された要素は通常グレイ表示のテキストで描画されます。要素が無効化されていると、ユーザのアクションには応答せず、フォーカスもあてられず、command イベントも発生しません。

 

disableKeyNavigation
型: 論理型
この属性が使用されていない場合、ユーザは、項目のラベル内の文字にマッチするキーを押すことによって、要素内の特定の項目に移動することができます。これはインクリメンタルに行われるため、さらに文字を入力して、項目をさらに特定することができます。この機能は、この属性を true に設定することによって無効化されます。
enablehistory
型: 論理型
true の場合、矢印ボタンが textbox の末尾に現れます。この矢印が押されると、すべての使用可能な候補のドロップダウンメニューが開きます。
focused
型: 論理型
要素がフォーカスされているとき、この属性値は true です。
forceComplete
型: 論理型
true の場合、textbox がフォーカスを失った時、最もマッチするものが入力されます。false の場合、ユーザが項目を選択した時のみ入力されます。
highlightnonmatches
型: 論理型
true の場合、マッチするものが見つからない時に autocomplete フィールドが強調されます。
ignoreblurwhilesearching
型: 論理型
true の場合、検索中は blur イベントが無視され、自動補完 popup は表示されません。
inputtooltiptext
型: 文字列型
textbox の tooltip テキスト。
label
型: 文字列型
要素上に表示するlabel。 省略された場合、テキストは表示されない。
maxlength
型: 整数型
textbox に入力することができる最大文字数。
maxrows
型: 整数型
候補リストに一度に表示する行数。scrollbar が現れるので、ユーザは残りの項目を見渡すことができます。
minresultsforpopup
型: 整数型
表示される popup に返す候補の数の最小値。
nomatch
型: 論理型
この属性は、最後まで検索した結果一致しなかった時、true に設定されます。
onchange
型: スクリプトコード
onchange 属性内のコードは、要素の値が変更された時、呼び出されます。
oninput
型: スクリプトコード
このイベントは、ユーザが textbox にテキストを入力した時、送られます。このイベントはテキストの表示が変更されたとき呼び出されるため、ユーザが表示不可能なキーを押した場合は呼び出されません。
onsearchcomplete
型: スクリプトコード
このイベントハンドラは、自動補完 (autocomplete)検索が完了して結果が利用可能になった時、呼び出されます。
ontextentered
型: スクリプトコード
このイベントハンドラは、textbox のための候補が選択された時、呼び出されます。
ontextreverted
型: スクリプトコード
このイベントハンドラは、ユーザが Esc を押して textbox を元の補完されていない値に戻した時、呼び出されます。
open
型: 論理型
menutype ボタンについて、メニューが開かれたとき、open 属性が true に設定されます。メニューが閉じられると open 属性は提供されません。
readonly
型: 論理型
true に設定した場合、ユーザは要素の値を変更できません。しかし、スクリプトからは依然として値を変更できます。
Gecko 2 note
(Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)
Gecko 2.0 まで、readonly 属性は XBL フィールド上で正しく動作しませんでした。
showCommentColumn
型: 論理型
true の場合、コメント列が popup 内に表示されます。URL 訪問履歴では、コメント列に各 URL に関連付けられたページタイトルが含まれます。この属性が指定されていない場合、コメント列は表示されません。
size
型: 整数型
textbox に表示することのできる文字数。
tabindex
型: 整数型
要素のタブの順番。タブの順番は tab キーが押下されたときにフォーカスが移動する順番です。より大きな tabindex の値をもつ要素は、タブの遷移が後になります。
tabScrolling
型: 論理型
true の場合、ユーザが Tab キーを押すことによって候補リストを上から繰り返すことができます。デフォルト値の false の場合、Tab キーはフォーカスを次の要素に移動します。
timeout
型: 整数型
時間制限付きの textbox のための、command イベント発生までのミリ秒数。タイマーはユーザが文字を入力すると開始します。ユーザが他の文字を入力するとタイマーがリセットされます。
type
型: 下記の値のいずれか一つ
特別な形式の textbox を使用するには、下記の値のいずれか一つを type 属性に設定します。
  • autocomplete: 自動補完をサポートする textbox。自動補完 textbox についての詳しい情報は、自動補完 (autocomplete)のドキュメントをご覧ください。(Mozilla) (Firefox)
  • number: 数字のみを入力することができる textbox。さらに、値を増減するための矢印ボタンが textbox の次に現れます。number textbox を設定するための属性は次のものがあります min および max, increment, wraparound, hidespinbuttons
  • password: 入力した内容を隠す textbox。パスワードの入力に使用されます。
  • timed: この textbox は、ユーザが文字を入力して時間が経つと command イベントを発生させます。遅延時間は timeout 属性で設定します。この形式は例えば、ユーザが入力した window の情報を更新するために使用します。ユーザが時間内にさらにキーを入力すれば、タイマーを発動させないために継続的に更新する必要はありません。ユーザが Enter キーを押下した場合にも command イベントが発生します。
value
型: 文字列型
文字列の属性はデータ値を要素に関連付けます。特定の目的のために使われるわけではありませんが、スクリプトからあなた自身の用途のためにアクセスできます。

プロパティ

accessibleType
型: 整数型
要素の accessibility オブジェクトの種類を示す値。
completeDefaultIndex
型: 論理型
completedefaultindex 属性の値の取得と設定。
controller
型: nsIAutoCompleteController
自動補完要素のための controller を返す。
crop
型: 文字列型
crop 属性の値の取得と設定。
disableAutocomplete
型: 論理型
disableAutocomplete 属性の値の取得と設定。
disableKeyNavigation
型: 論理型
disableKeyNavigation 属性の値の取得と設定。
disabled
型: 論理型
disabled 属性の値の取得と設定。
{{ XULProp("editable") }} {{ if (Page.path == (Page.language .. '/XUL/menulist')) {template.Fx_minversion_inline(3)} }}
型: 論理型
{{ if (Page.path == (Page.language .. '/XUL/menulist')) {"menulist が editable な場合、このプロパティは true を返します。"} else {"自動補完フィールドは editable なため、このプロパティは常に true を返します。"} }}
focused
型: 論理型
focused 属性の値の取得と設定。
forceComplete
型: 論理型
forcecomplete 属性の値の取得と設定。
highlightNonMatches
型: 論理型
highlightnonmatches 属性の値の取得と設定。
ignoreBlurWhileSearching
型: 論理型
ignoreblurwhilesearching 属性の値の取得と設定。
inputField
型: textbox 要素
Mozilla では、XUL textbox は HTML の input 要素のラッパとして実装されています。この読み取り専用のプロパティは、この内部 input 要素への参照を保持します。
label
型: 文字列型
label 属性の値の取得と設定。
maxLength
型: 整数型
textbox に入力することができる文字数の最大値。
maxRows
型: 整数型
maxrows 属性の値の取得と設定。
minResultsForPopup
型: 整数型
minresultsforpopup 属性の値の取得と設定。
open
型: 論理型
open 属性の値の取得と設定。
popupOpen
型: 論理型
popup が開かれているかどうかを示す。popup を開閉するにはこのプロパティを設定します。
searchCount
型: 整数型
使用された検索コンポーネントの数を返す。このプロパティは読み取り専用です。
searchParam
型: 文字列型
autocompletesearchparam 属性の値の取得と設定。
selectionEnd
型: 整数型
フィールドのテキストの選択部分の末尾の取得または設定。selectionStart プロパティと共に使用します。この値は選択後の文字の index を指定します。この値が selectionStart プロパティの値と等しいときは text が選択されませんが、値は textbox 内のキャレット(カーソル) の位置を示します。
selectionStart
型: 整数型
フィールドのテキストの選択部分の先頭の取得または設定。selectionEnd プロパティと共に使用します。値は選択された最初の文字の index を指定します。
showCommentColumn
型: 論理型
showcommentcolumn 属性の値の取得と設定。
showImageColumn
Type: boolean
Gets and sets the value of the showimagecolumn attribute.
size
型: 整数型
size 属性の値の取得と設定。
tabIndex
型: 整数型
tabindex 属性の値の取得と設定。
tabScrolling
型: 論理型
tabscrolling 属性の値の取得と設定。
textLength
型: 整数型
textbox に入力されたテキストの長さを保持。このプロパティは読み取り専用です。
textValue
型: 文字列型
textbox の内容を返す。value プロパティと同等です。
timeout
型: 整数型
timeout 属性の値の取得と設定。
type
型: '
自動補完 textbox は autocomplete に設定されます。
value
型: 文字列型
value 属性の値の取得と設定。

メソッド

XUL 要素からの継承
blur, click, doCommand, focus, getElementsByAttribute getElementsByAttributeNS

DOM 要素からの継承
addEventListener(), appendChild(), compareDocumentPosition, dispatchEvent(), getAttribute(), getAttributeNode(), getAttributeNodeNS(), getAttributeNS(), getElementsByTagName(), getElementsByTagNameNS(), getFeature, getUserData, hasAttribute(), hasAttributeNS(), hasAttributes(), hasChildNodes(), insertBefore(), isEqualNode, isSameNode, isSupported(), lookupNamespaceURI, lookupPrefix, normalize(), removeAttribute(), removeAttributeNode(), removeAttributeNS(), removeChild(), removeEventListener(), replaceChild(), setAttribute(), setAttributeNode(), setAttributeNodeNS(), setAttributeNS(), setUserData

getSearchAt( index )
戻り値の型: 文字列型
与えられた index の検索コンポーネントを返す。コンポーネントは autocompletesearch 属性で設定されます。
onSearchComplete()
戻り値の型: 戻り値無し
onsearchcomplete イベントハンドラを呼び出す。このメソッドを呼び出してはいけません。
onTextEntered()
戻り値の型: event result
ontextentered イベントハンドラを呼び出す。このメソッドを呼び出してはいけません。
onTextReverted()
戻り値の型: event result
ontextreverted イベントハンドラを呼び出す。このメソッドを呼び出してはいけません。
select()
戻り値の型: 戻り値無し
textbox 内のすべてのテキストを選択します。
setSelectionRange( start, end )
戻り値の型: 戻り値無し
textbox の選択部分を設定します。start 引数は選択範囲の最初の文字の index です。end 引数は選択範囲の直後の文字の index です。テキストを選択せずに指定の位置へカーソルを移動するには、両方の引数を同じ値に設定してください。

関連項目

インタフェース
nsIAccessibleProvider, nsIAutoCompleteInput, nsIDOMXULMenuListElement
記事
How to implement custom autocomplete search component

ドキュメントのタグと貢献者

最終更新者: Marsf,