XUL:textbox
出典: MDC
« XUL リファレンス HOME [ 例 | 属性 | プロパティ | メソッド | 関連項目 ]
ユーザがテキストを入力することができる input フィールド。これは HTML の input 要素に似ています。デフォルトでは一行のテキストフィールドのみが表示されます。multiline 属性で複数行のフィールドを表示するように指定することもできます。
詳しい情報は XUL チュートリアルにあります。
- 属性
- cols, decimalplaces, disabled, empty, emptytext, hidespinbuttons, increment, label, max, maxlength, min, multiline, newlines, onchange, oninput, preference, readonly, rows, size, spellcheck, tabindex, timeout, type, value, wrap, wraparound
- プロパティ
- accessibleType, clickSelectsAll, decimalPlaces, decimalSymbol, defaultValue, disabled, editor, emptyText, increment, inputField, label, max, maxLength, min, readOnly, selectionEnd, selectionStart, size, spinButtons, tabIndex, textLength, timeout, type, value, valueNumber, wrapAround
- メソッド
- decrease, increase, reset, select, setSelectionRange
- スタイルクラス
- plain
[編集] 例
<vbox> <label control="your-name" value="Enter your name:"/> <textbox id="your-name" value="John"/> </vbox>
[編集] 属性
|
XUL 要素からの継承 |
- cols
- 型: integer
- 複数行の textbox で表示するための桁数。
- decimalplaces Firefox 3 の新機能
- 型: integer
- 表示する小数点以下の桁数。デフォルト値の 0 は小数点以下の桁を表示しません。小数点以下の桁数を無制限にしたいときは、値を
Infinityにします。小数は float として格納されるので注意してください。
- disabled
- 型: 真偽値
- 要素が無効化されているかどうかを示します。ある要素が
trueに設定されていたら、その要素は無効化されています。無効化された要素は通常グレイ表示のテキストで描画されます。要素が無効化されていると、ユーザのアクションには応答せず、フォーカスもあてられず、commandイベントも発生しません。
- hidespinbuttons
- 型: boolean
-
trueの場合、数値ボックスは値を調節するための矢印ボタンを持ちません。値はキーボードで調節することができます。デフォルトの値はfalseです。
- maxlength
- 型: integer
- textbox に入力することができる最大文字数。
- multiline
- 型: boolean
-
trueの場合、textbox は複数行を表示します。ユーザが Enter を押下すると改行されます。falseの場合、textbox は一行のみ入力を許可します。
- 可能な値:
pasteintact: 変更なしで改行を貼り付ける。pastetofirst: 最初の改行の前のテキストのみを貼り付ける。残りのテキストは破棄されます。replacewithcommas: 改行をカンマに置き換えたテキストを貼り付ける。replacewithspaces: 改行をスペースに置き換えたテキストを貼り付ける。strip: 改行を取り除いたテキストを貼り付ける。stripsurroundingwhitespace: 空白を取り除いた改行付きのテキストを貼り付ける。
- onchange
- 型 : script code
- このイベントは、textbox の値が変更された時、送られます。イベントはフォーカスが他の要素に移動するまで送られません。
- oninput
- 型: script code
- このイベントは、ユーザが textbox にテキストを入力した時、送られます。このイベントはテキストの表示が変更されたとき呼び出されるため、ユーザが表示不可能なキーを押下したときは呼び出されません。
- preference
- 型: 要素の id
- 要素を対応する preference につなぎます。この属性は prefwindow 内で使用された場合のみ効果があります。preference の値は、要素の value プロパティと一致するように更新されます。
- readonly
- 型: boolean
-
trueに設定した場合、ユーザは要素の値を変更できません。しかし、スクリプトからは依然として値を変更できます。
- rows
- 型: integer
- 要素内に表示する行数。要素がこの数値よりも多くの行を含むときはスクロールバーが現れます。要素内の実際の rows の値を取得するには getRowCount メソッドを使用してください。
- size
- 型: integer
- textbox に表示することのできる文字数。
- spellcheck Firefox 2.0.0.2 の新機能
- 型: boolean
-
trueの場合、textbox のためのスペルチェックがデフォルトで有効になります。falseの場合、スペルチェックがデフォルトで無効になります。 - 指定されない場合、これはデフォルトで
falseです。
- tabindex
- 型: 整数
- 要素のタブの順番。タブの順番は tab キーが押下されたときにフォーカスが移動する順番です。より大きな
tabindexの値をもつ要素は、タブの遷移が後になります。
- timeout
- 型: integer
- 時間制限付きの textbox のための、command イベント発生までのミリ秒数。タイマーはユーザが文字を入力すると開始します。ユーザが他の文字を入力するとタイマーがリセットされます。
- type
- 型: 下記の値のいずれか一つ
- 特別な形式の textbox を使用するには、下記の値のいずれか一つを type 属性に設定します。
-
autocomplete: 自動補完をサポートする textbox。自動補完 textbox についての詳しい情報は、自動補完 (autocomplete) のドキュメントをご覧ください。(Mozilla) (Firefox) -
number: 数字のみを入力することができる textbox。さらに、値を増減するための矢印ボタンが textbox の次に現れます。number textbox を設定するための属性は次のものがあります min および max, increment, wraparound, hidespinbuttons。 Firefox 3 の新機能 -
password: 入力した内容を隠す textbox。パスワードの入力に使用されます。 -
timed: この textbox は、ユーザが文字を入力して時間が経つと command イベントを発生させます。遅延時間は timeout 属性で設定します。この形式は例えば、ユーザが入力した window の情報を更新するために使用します。ユーザが時間内にさらにキーを入力すれば、タイマーを発動させないために継続的に更新する必要はありません。ユーザが Enter キーを押下した場合にも command イベントが発生します。
- value
- 型: string
- デフォルト値が textbox に入力されます。この属性はデフォルト値のみが保持され、ユーザがテキストを入力しても変更されることはありません。更新された値を取得するには value プロパティを使用してください。数値ボックスのデフォルト値は、0 または
minプロパティが返す最小値のどちらか大きいほうです。
- wrap
- 型: string
- textbox 内のワードラップを無効にするには、この属性の値を
offに設定します。この属性が指定されていないときは、ワードラップが有効です。
- wraparound Firefox 3 の新機能
- 型: boolean
-
trueの場合、数値ボックスの値は、最大値または最小値を超えると丸められます。最小値および最大値は両方とも無限であってはなりません。
[編集] プロパティ
|
XUL 要素からの継承 DOM 要素からの継承 |
- accessibleType
- 型: integer
- 要素の accessibility オブジェクトの種類を示す値。
- clickSelectsAll
- 型: boolean
-
trueに設定した場合、フォーカスされた時、textbox の内容が選択されます。カーソルは変更無しで取り去られます。
- decimalPlaces
- 型: integer
- decimalplaces 属性の値の取得と設定。
- decimalSymbol
- 型: string
- 小数点に使用する文字。デフォルト値はピリオド (.) です。
- defaultValue Firefox 3 の新機能
- 型: string
- textbox のデフォルト値の取得と設定。
- inputField
- 型: textbox element
- Mozilla では、XUL textbox は HTML の input 要素のラッパとして実装されています。この読み取り専用のプロパティは、この内部 input 要素への参照を保持します。
- label Firefox 3 の新機能
- 型: string
- label 属性を設定します。label 属性が設定されており空でなければ、これを取得します。そうでなければ、関連付けられた label 要素の適用可能な value を返します。それ以外は emptyText プロパティを返します。属性値の取得はスクリーンリーダにとって最も役立ちます。
- maxLength
- 型: integer
- textbox に入力することができる文字数の最大値。
- readOnly
- 型: 真偽値
-
trueに設定すると、ユーザは要素の値を変更できなくなります。
- selectionEnd
- 型: integer
- フィールドのテキストの選択部分の末尾の取得または設定。selectionStart プロパティと共に使用します。この値は選択後の文字の index を指定します。この値が selectionStart プロパティの値と等しいときは text が選択されませんが、値は textbox 内のキャレット(カーソル) の位置を示します。
- selectionStart
- 型: integer
- フィールドのテキストの選択部分の先頭の取得または設定。selectionEnd プロパティと共に使用します。値は選択された最初の文字の index を指定します。
- spinButtons
- 型: element
- この読み取り専用のプロパティは、数値ボックスで使用される spinbuttons 要素への参照を返します。
- textLength
- 型: integer
- textbox に入力されたテキストの長さを保持。このプロパティは読み取り専用です。
- value
- 型: string
- textbox の現在の値を文字列として保持します。現在の値はこのプロパティを設定すると変更されます。
- valueNumber
- 型: number
- value プロパティが文字列を保持するのと対照的に、valueNumber プロパティは数値ボックスの現在の値を含む数値です。
- wrapAround
- 型: boolean
- wraparound 属性の値の取得と設定。
[編集] メソッド
- decrease()
- 戻り値の型: 戻り値なし
- 数値ボックスの値を increment 分減らす。
- increase()
- 戻り値の型: 戻り値なし
- 数値ボックスの値を increment 分増やす。
- reset()
- 戻り値の型: 戻り値なし
- preference の値をデフォルトにリセットします。
- textbox については、アンドゥ処理リストを消去します (Gecko 1.9)。
- select()
- 戻り値の型: 戻り値なし
- textbox 内のすべてのテキストを選択します。
- setSelectionRange( start, end )
- 戻り値の型: 戻り値なし
- textbox の選択部分を設定します。start 引数は選択範囲の最初の文字の index です。end 引数は選択範囲の直後の文字の index です。テキストを選択せずに指定の位置へカーソルを移動するには、両方の引数を同じ値に設定してください。
[編集] スタイルクラス
次のクラスは要素のスタイル付けに使用されます。これらのクラスは、ユーザの選択したテーマに自然に合うようにするため、要素のスタイルを直接変更する代わりに使用されます。
- plain
- このクラスによって、要素は border や margin なしで表示されます。