textbox (XPFE autocomplete)

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

自動補完 (autocomplete)機能は、一つ以上のセッションオブジェクトを通して扱われます。各セッションオブジェクトは textbox の現在の値に与えられた候補の一覧を返します。セッションは searchSessions 属性を使用するか、addSession メソッドを呼び出して設定することができます。

属性
alwaysopenpopup, autocompletesearch, autoFill, autoFillAfterMatch, autofill, completedefaultindex, crop, disableAutocomplete, disableautocomplete, disabled, disablehistory, focused, forceComplete, forcecomplete, ignoreBlurWhileSearching, ignoreblurwhilesearching, inputtooltiptext, label, maxlength, maxrows, minResultsForPopup, minresultsforpopup, nomatch, onerrorcommand, ontextcommand, ontextentered, ontextrevert, ontextreverted, open, searchSessions, showCommentColumn, showcommentcolumn, showpopup, size, tabScrolling, tabscrolling, tabindex, timeout, type, userAction, value
プロパティ
accessible, alwaysOpenPopup, autoFill, autoFillAfterMatch, completeDefaultIndex, crop, disableAutocomplete, disabled, editable, focused, forceComplete, ignoreBlurWhileSearching, inputField, isSearching, isWaiting, label, maxLength, maxRows, minResultsForPopup, noMatch, open, resultsPopup, searchSessions, selectionEnd, selectionStart, sessionCount, showCommentColumn, showPopup, size, tabIndex, tabScrolling, textLength, timeout, type, userAction, value
メソッド
addSession, clearResults, getDefaultSession, getResultAt, getResultCount, getResultValueAt, getSession, getSessionByName, getSessionResultAt, getSessionStatusAt, getSessionValueAt, removeSession, select, setSelectionRange, syncSessions

(例が必要)

属性

accesskey
型: 文字型
ショートカットキーとして使用される文字を設定します。この文字はその要素の label 属性のテキストに現れる文字の一つでなければいけません。
alwaysopenpopup 廃止 Gecko 1.9.1
型: 論理型
註: 適用対象: Thunderbird 及び SeaMonkey
true の場合、マッチするものがない時でも自動補完 popup が表示されます。デフォルト値の false の場合、popup は隠れます。この属性は Gecko1.9.1 で廃止されています。ポップアップの表示の制御には、代わりに minresultsforpopup 属性を使用します。
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
型: 文字列型
検索コンポーネントに渡される文字列。
autoFill Obsolete since Gecko 1.9.1
Type: boolean
Note: Applies to: Thunderbird and SeaMonkey
If set to true, the best match will be filled into the textbox as the user types. If false, the default, the value will not be filled in until the user selects an item. As of Gecko 1.9.1, this attribute is now always specified in lower case.
autoFillAfterMatch 廃止 Gecko 1.9.1
型: 論理型
true に設定した場合、最もマッチするテキスト全体が入力したものの後に表示されます。false の場合、まだ入力していない部分のテキストのみが入力されます。この機能を使用するには textbox.autoFill 属性が true に設定されていなければなりません。Gecko1.9.1 より、この属性は completedefaultindex 属性に置き換わっています。
autofill New in Thunderbird 3 要 SeaMonkey 2.0
型: 論理型
true に設定した場合、ユーザが入力したものに最もマッチする値が textbox に入力されます。デフォルト値の false の場合、ユーザが項目を選択するまで値は入力されません。
completedefaultindex
型: 論理型
true の場合、ユーザが入力した値に最もマッチする値が textbox に入力されます。false に設定するか省略すると、値をリストから選択しなければなりません。
crop
型: 論理型
この属性は使用されません。menulist 要素との互換性のためにのみ提供されています。
disableAutocomplete Obsolete since Gecko 1.9.1
Type: boolean
If true, the autocomplete behavior will be disabled. You might use a script to change this attribute. If false, the default, autocomplete is enabled. As of Gecko 1.9.1, this attribute is now always specified in lower case.
disableAutocomplete
型: 論理型
true の場合、自動補完が無効になります。この属性を変更するにはスクリプトを使用します。デフォルト値の false の場合、自動補完は有効になります。
disabled
型: 論理型
要素が無効化されているかどうかを示します。ある要素が true に設定されていたら、その要素は無効化されています。無効化された要素は通常グレイ表示のテキストで描画されます。要素が無効化されていると、ユーザのアクションには応答せず、フォーカスもあてられず、command イベントも発生しません。

 

disablehistory
型: 論理型
false の場合、すべての利用可能な候補のドロップダウンメニューを開く矢印ボタンが textbox の末尾に表示されます。デフォルト値は、ドロップダウンボタンが隠れている true です。
enablehistory
型: 論理型
true の場合、矢印ボタンが textbox の末尾に現れます。この矢印が押されると、すべての使用可能な候補のドロップダウンメニューが開きます。
focused
型: 論理型
要素がフォーカスされているとき、この属性値は true です。
forceComplete Obsolete since Gecko 1.9.1
Type: boolean
If true, the textbox will be filled in with the best match when it loses the focus. If false, it will only be filled in when the user selects an item. As of Gecko 1.9.1, this attribute is now always specified in lower case.
forceComplete
型: 論理型
true の場合、textbox がフォーカスを失った時、最もマッチするものが入力されます。false の場合、ユーザが項目を選択した時のみ入力されます。
ignoreBlurWhileSearching Obsolete since Gecko 1.9.1
Type: boolean
If true, blur events are ignored while searching, which means that the autocomplete popup will not disappear. As of Gecko 1.9.1, this attribute is now always specified in lower case.
ignoreblurwhilesearching
型: 論理型
true の場合、検索中は blur イベントが無視され、自動補完 popup は表示されません。
inputtooltiptext
型: 文字列型
textbox の tooltip テキスト。
label
型: 文字列型
要素上に表示するlabel。 省略された場合、テキストは表示されない。
maxlength
型: 整数型
textbox に入力することができる最大文字数。
maxrows
型: 整数型
候補リストに一度に表示する行数。scrollbar が現れるので、ユーザは残りの項目を見渡すことができます。
minResultsForPopup Obsolete since Gecko 1.9.1
Type: integer
The minimum number of results that must be returned for the popup to be displayed. The default value is 1. A zero value will always open the popup unless the textbox is empty. This can be used to display additional items that are not autocomplete results. As of Gecko 1.9.1, this attribute is now always specified in lower case.
minresultsforpopup
型: 整数型
表示される popup に返す候補の数の最小値。
nomatch
型: 論理型
この属性は、最後まで検索した結果一致しなかった時、true に設定されます。
onerrorcommand
型: スクリプトコード
このイベントハンドラは、popup から候補を選択してエラーが発生した時、呼び出されます。
ontextcommand
型: スクリプトコード
このイベントハンドラは、textbox のための候補が選択された時、呼び出されます。
ontextentered
型: スクリプトコード
このイベントハンドラは、textbox のための候補が選択された時、呼び出されます。
ontextrevert
型: スクリプトコード
このイベントハンドラは、ユーザが Escape キーを押して textbox の値を元の補完されていない値に戻した時、呼び出されます。
ontextreverted
型: スクリプトコード
このイベントハンドラは、ユーザが Esc を押して textbox を元の補完されていない値に戻した時、呼び出されます。
open
型: 論理型
menutype ボタンについて、メニューが開かれたとき、open 属性が true に設定されます。メニューが閉じられると open 属性は提供されません。
searchSessions
型: スペースで区切られたセッション名のリスト
キーボードで指示する、自動補完のために探すデータ形式を設定します。複数の形式を設定するには、これらの名前をスペースで区切ります。次の値が利用可能ですが、他の値を追加するカスタムコンポーネントがインストールされているかもしれません。
  • history: ユーザの URL 訪問履歴が検索されます。
  • addrbook: ユーザのアドレス帳が検索されます。
  • ldap: ユーザの LDAP ディレクトリが検索されます。
showCommentColumn Obsolete since Gecko 1.9.1
Type: boolean
If true, a comment column appears in the popup. For the URL history, the comment column will contain the page titles associated with each URL. If this attribute is not specified, the comment column doesn't appear. As of Gecko 1.9.1, this attribute is now always specified in lower case.
showCommentColumn
型: 論理型
true の場合、コメント列が popup 内に表示されます。URL 訪問履歴では、コメント列に各 URL に関連付けられたページタイトルが含まれます。この属性が指定されていない場合、コメント列は表示されません。
showpopup
型: 論理型
true の場合 popup が表示されます。false の場合 popup は表示されませんが、自動補完の候補が利用可能です。この属性を false に設定して autoFill 属性を true に設定すると、Communicator 4.x スタイルの自動補完 textbox をエミュレートすることができます。デフォルト値は true です。
size
型: 整数型
textbox に表示することのできる文字数。
tabScrolling Obsolete since Gecko 1.9.1
Type: boolean
If true, the user may cycle through the results list by pressing the Tab key. If false, the default, the Tab key moves the focus to the next element.As of Gecko 1.9.1, this attribute is now always specified in lower case.
tabScrolling
型: 論理型
true の場合、ユーザが Tab キーを押すことによって候補リストを上から繰り返すことができます。デフォルト値の false の場合、Tab キーはフォーカスを次の要素に移動します。
tabindex
型: 整数型
要素のタブの順番。タブの順番は tab キーが押下されたときにフォーカスが移動する順番です。より大きな tabindex の値をもつ要素は、タブの遷移が後になります。
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 イベントが発生します。
userAction
型: 以下の値のいずれか一つ
この属性にはユーザが現在行っている操作が設定されます。利用可能な値は:
  • none: ユーザは textbox に対して何もしていません。
  • typing: ユーザは textbox に入力しています。
  • scrolling: ユーザは textbox 内をスクロールしています。
value
型: 文字列型
文字列の属性はデータ値を要素に関連付けます。特定の目的のために使われるわけではありませんが、スクリプトからあなた自身の用途のためにアクセスできます。

プロパティ

accessible
型: nsIAccessible
要素の accessibility object を返す。
alwaysOpenPopup
型: 論理型
alwaysopenpopup 属性の値の取得と設定。
autoFill
型: 論理型
autoFill 属性の値の取得と設定。
autoFillAfterMatch 廃止 Gecko 1.9.1
型: 論理型
autoFillAfterMatch 属性の値の取得と設定。
completeDefaultIndex
型: 論理型
completedefaultindex 属性の値の取得と設定。
crop
型: 文字列型
crop 属性の値の取得と設定。
disableAutocomplete
型: 論理型
disableAutocomplete 属性の値の取得と設定。
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 属性の値の取得と設定。
ignoreBlurWhileSearching
型: 論理型
ignoreblurwhilesearching 属性の値の取得と設定。
inputField
型: textbox 要素
Mozilla では、XUL textbox は HTML の input 要素のラッパとして実装されています。この読み取り専用のプロパティは、この内部 input 要素への参照を保持します。
isSearching
型: 論理型
このプロパティは検索が行われている間、true に設定されます。
isWaiting
型: 論理型
このプロパティは、ユーザがキーを押して検索が実行されてから timeout まで待機している間 true に設定されます。
label
型: 文字列型
label 属性を設定します。label 属性が設定されており空でなければ、これを取得します。そうでなければ、関連付けられた label 要素の適用可能な value を返します。それ以外は emptyText プロパティを返します。属性値の取得はスクリーンリーダにとって最も役立ちます。
maxLength
型: 整数型
textbox に入力することができる文字数の最大値。
maxRows
型: 整数型
maxrows 属性の値の取得と設定。
minResultsForPopup
型: 整数型
minresultsforpopup 属性の値の取得と設定。
noMatch
型: 論理型
このプロパティは、最後の検索結果がマッチしない場合、true に設定されます。
open
型: 論理型
open 属性の値の取得と設定。
resultsPopup
型: popup 要素
このプロパティには候補を表示する popup 要素が設定されます。
searchSessions
型: スペースで区切られたセッション名のリスト
キーボードで指示する、自動補完のために探すデータ形式を設定します。複数の形式を設定するには、これらの名前をスペースで区切ります。次の値が利用可能ですが、他の値を追加するカスタムコンポーネントがインストールされているかもしれません。
  • history: ユーザの URL 訪問履歴が検索されます。
  • addrbook: ユーザのアドレス帳が検索されます。
  • ldap: ユーザの LDAP ディレクトリが検索されます。
selectionEnd
型: 整数型
フィールドのテキストの選択部分の末尾の取得または設定。selectionStart プロパティと共に使用します。この値は選択後の文字の index を指定します。この値が selectionStart プロパティの値と等しいときは text が選択されませんが、値は textbox 内のキャレット(カーソル) の位置を示します。
selectionStart
型: 整数型
フィールドのテキストの選択部分の先頭の取得または設定。selectionEnd プロパティと共に使用します。値は選択された最初の文字の index を指定します。
sessionCount
型: 整数型
セッション数を保持します。
showCommentColumn
型: 論理型
showcommentcolumn 属性の値の取得と設定。
showPopup
型: 論理型
showpopup 属性の値の取得と設定。
size
型: 整数型
size 属性の値の取得と設定。
tabIndex
型: 整数型
tabindex 属性の値の取得と設定。
tabScrolling
型: 論理型
tabscrolling 属性の値の取得と設定。
textLength
型: 整数型
textbox に入力されたテキストの長さを保持。このプロパティは読み取り専用です。
timeout
型: 整数型
timeout 属性の値の取得と設定。
type
型: 文字列型
type 属性の値の取得と設定。
userAction
型: 文字列型
userAction 属性の値の取得と設定。
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

addSession( session )
戻り値の型: nsIAutoCompleteSession
新しいセッションオブジェクトを autocomplete ウィジェットに追加します。これは、カスタマイズされた自動補完の候補リストの作成に使用することができます。引数は nsIAutoCompleteSession インタフェースを実装するオブジェクトでなければなりません。このメソッドは渡されたオブジェクトを返します。
clearResults()
戻り値の型: ???
候補リストを消去します。
getDefaultSession
戻り値の型: セッション名
利用可能な候補を持つ最初のセッションの名前を返します。
getResultAt( index )
戻り値の型: nsIAutoCompleteItem
指定した index の位置の候補項目を返します。項目は nsIAutoCompleteItem 形式の値になります。
getResultCount( session )
戻り値の型: ???
候補数を返します。(現在、session 引数は無視されます。)
getResultValueAt( index )
戻り値の型: 候補の値
指定した index の位置の候補の値を返します。項目は popup 内に表示されたテキストに相当します。
getSession( index )
戻り値の型: nsIAutoCompleteSession
与えられた index のセッションオブジェクトを返します。これは nsIAutoCompleteSession 形式のオブジェクトを返します。
getSessionByName( name )
戻り値の型: nsIAutoCompleteSession
与えられた name のセッションオブジェクトを返します。これは nsIAutoCompleteSession 形式のオブジェクトを返します。
getSessionResultAt( session, index )
戻り値の型: 候補項目
指定した session について、指定した index の位置の候補項目を返します。
getSessionStatusAt( index )
戻り値の型: ???
与えられた index のセッションオブジェクトの status を返します。
getSessionValueAt( session, index )
戻り値の型: 候補の値
指定した session について、指定した index の位置の候補の値を返します。
removeSession( session )
戻り値の型: ???
autocomplete ウィジェットからセッションオブジェクトを削除します。引数は nsIAutoCompleteSession インタフェースを実装するオブジェクトでなければなりません。
select()
戻り値の型: 戻り値無し
textbox 内のすべてのテキストを選択します。
setSelectionRange( start, end )
戻り値の型: 戻り値無し
textbox の選択部分を設定します。start 引数は選択範囲の最初の文字の index です。end 引数は選択範囲の直後の文字の index です。テキストを選択せずに指定の位置へカーソルを移動するには、両方の引数を同じ値に設定してください。
syncSessions( autoCompleteElement )
戻り値の型: ???
他の 自動補完要素 (autocomplete element) からセッションをコピーします。

関連項目

インタフェース
nsIAccessibleProvider, nsIDOMXULMenuListElement

Document Tags and Contributors

Contributors to this page: Marsf
最終更新者: Marsf,