この要素は、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
例
<textbox type="autocomplete" autocompletesearch="history"/>
属性
-
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
に設定するか省略すると、値をリストから選択しなければなりません。
-
disableAutocomplete
- 型: 論理型
-
true
の場合、自動補完が無効になります。この属性を変更するにはスクリプトを使用します。デフォルト値のfalse
の場合、自動補完は有効になります。
-
disabled
- 型: 論理型
-
要素が無効化されているかどうかを示します。ある要素が
true
に設定されていたら、その要素は無効化されています。無効化された要素は通常グレイ表示のテキストで描画されます。要素が無効化されていると、ユーザのアクションには応答せず、フォーカスもあてられず、command
イベントも発生しません。
-
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
属性内のコードは、要素の値が変更された時、呼び出されます。
-
onsearchcomplete
- 型: スクリプトコード
- このイベントハンドラは、自動補完 (autocomplete)検索が完了して結果が利用可能になった時、呼び出されます。
-
ontextentered
- 型: スクリプトコード
- このイベントハンドラは、textbox のための候補が選択された時、呼び出されます。
-
ontextreverted
- 型: スクリプトコード
- このイベントハンドラは、ユーザが Esc を押して textbox を元の補完されていない値に戻した時、呼び出されます。
readonly
- 型: 論理型
true
に設定した場合、ユーザは要素の値を変更できません。しかし、スクリプトからは依然として値を変更できます。
Gecko 2 note
Gecko 2.0 まで、(Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)
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 を返す。
-
disableAutocomplete
- 型: 論理型
-
disableAutocomplete
属性の値の取得と設定。
- {{ 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
を返します。"} }}
-
forceComplete
- 型: 論理型
-
forcecomplete
属性の値の取得と設定。
highlightNonMatches
- 型: 論理型
highlightnonmatches
属性の値の取得と設定。
ignoreBlurWhileSearching
- 型: 論理型
ignoreblurwhilesearching
属性の値の取得と設定。
-
inputField
- 型: textbox 要素
- Mozilla では、XUL textbox は HTML の input 要素のラッパとして実装されています。この読み取り専用のプロパティは、この内部 input 要素への参照を保持します。
-
maxLength
- 型: 整数型
- textbox に入力することができる文字数の最大値。
-
minResultsForPopup
- 型: 整数型
-
minresultsforpopup
属性の値の取得と設定。
-
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.
-
tabScrolling
- 型: 論理型
-
tabscrolling
属性の値の取得と設定。
-
textLength
- 型: 整数型
- textbox に入力されたテキストの長さを保持。このプロパティは読み取り専用です。
-
type
- 型: '
- 自動補完 textbox は
autocomplete
に設定されます。
メソッド
getSearchAt( index )
- 戻り値の型: 文字列型
- 与えられた index の検索コンポーネントを返す。コンポーネントは
autocompletesearch
属性で設定されます。
onSearchComplete()
- 戻り値の型: 戻り値無し
onsearchcomplete
イベントハンドラを呼び出す。このメソッドを呼び出してはいけません。
onTextEntered()
- 戻り値の型: event result
ontextentered
イベントハンドラを呼び出す。このメソッドを呼び出してはいけません。
onTextReverted()
- 戻り値の型: event result
ontextreverted
イベントハンドラを呼び出す。このメソッドを呼び出してはいけません。
select()
- 戻り値の型: 戻り値無し
- textbox 内のすべてのテキストを選択します。
setSelectionRange( start, end )
- 戻り値の型: 戻り値無し
- textbox の選択部分を設定します。start 引数は選択範囲の最初の文字の index です。end 引数は選択範囲の直後の文字の index です。テキストを選択せずに指定の位置へカーソルを移動するには、両方の引数を同じ値に設定してください。