数値コントロールでは入力可能な範囲の指定や、ゼロやNull値の扱いを制御することができます。
入力範囲の指定
setMinValueメソッドとsetMaxValueメソッドを使用してコントロールに入力可能な数値の範囲を指定できます。 範囲外の数値が入力されると、setMaxMinBehaviorメソッドの設定によって値が制御されます。 setMaxMinBehaviorメソッドに設定できる値は以下のとおりで、既定値はMaxMinBehavior.Restoreです。
値
説明
AdjustToMaxMin
値を最小値か最大値の近い方に設定します。
Clear
値を削除してnullにします。
Restore
変更前の値に戻します。
CancelInput
最後の入力をキャンセルしてフォーカスを保持します。
Keep
最後に入力された現在値を保持します。
setAdjustValueOnFocusメソッドがtrueの場合は、ユーザーが入力中に値の調整が行われます。falseの場合は、フォーカスが移動したあとに値が調整されます。
また、範囲外の値が入力されるとonInvalidRangeイベントが発生します。
ゼロとNull値
getValueメソッドの値をnullに初期化するには、clearメソッドを使用します。このとき、setValueメソッドの値を0に初期化するかnullに初期化するかをsetClearActionメソッドで指定できます。
また、setAllowDeleteToNullメソッドをtrueに設定することで、入力された「0」をDeleteキーやBackSpaceキーで削除し、そのgetValueメソッドの値をnullにすることができます。
有効性のチェック
数値コントロールでは、入力時に、数値と小数点だけが許可されるほか、以下のイベントにより多重チェックが行われます。
機能
説明
onInvalidInput
キーボードまたはクリップボードから無効な値を入力しようとしたときに発生します。
onInvalidRange
setMinValueメソッドとsetMaxValueメソッドで定義された有効範囲を超えた値を入力して、コントロールからフォーカスを移動したときに発生します。
リテラル文字列を含まない値の取得と設定
getValueメソッドおよびsetValueメソッドを使えば、リテラル文字列を除いたコントロール内の数値をNumber型で取得または設定できます。たとえば、setTextメソッドに「\ 50,000.-」が設定されているときには、getValueメソッドの値は「50000」となります。
setValueメソッドで値が変更されると、その変更はgetDisplayTextメソッドとgetTextメソッドにも適用されます。
コピーや切り取りなどのユーザー操作によりクリップボードにリテラル文字を含まない値を渡すには、setClipContentメソッドでClipContent.ExcludeLiteralsに設定します。
なお、setClipContentメソッドの設定は、getSelectedTextメソッドから取得できる文字列にも適用されます。
小数点を含む値の制御
setFormatDigitメソッドによる入力書式の設定で小数の入力を許可しない場合、小数点が含まれた数値がクリップボードから貼り付けられたときの入力値をsetAcceptsDecimalメソッドを使用して制御することができます。既定値はDecimalMode.Cutです。
値
説明
Cut
小数点以下が切り捨てられます。「123.45」という数値が「123」として入力されます。
Filter
小数点が削除されます。「123.45」という数値が「12345」として入力されます。
次のサンプルコードは、数値コントロールに整数の入力のみ許可し、小数点を含む数値が貼り付けられたときは、小数点を削除する例です。
改行コードの取り扱い
setAcceptsCrlfメソッドを使用してクリップボードへ改行を含む文字列をコピー、または貼り付けた場合の改行コードの扱いを設定できます。setAcceptsCrlfメソッドは、以下の3つの動作から選択します。既定値はCrLfMode.NoControlです。
値
説明
NoControl
改行コードはそのままでコピー、貼り付けを行います。
Filter
コピー、切り取り、または貼り付け文字列内にあるすべての改行コードを削除します。
Cut
コピー、切り取り、および貼り付け文字列内にある最初の改行コード以降の文字列を切り取ります。
半角数字に自動変換
autoConvertオプションをtrueに設定すると、全角数字を入力してフォーカスアウトする時、全角数字を半角数字に変換します。
import '@mescius/inputman/CSS/gc.inputman-js.css';
import { InputMan } from '@mescius/inputman';
InputMan.appearanceStyle = InputMan.AppearanceStyle.Modern;
const gcNumber = new InputMan.GcNumber(document.getElementById('gcNumber'), {
value: -100,
minValue: -100,
maxValue: 100,
});
document.getElementById('setMaxMinBehavior').addEventListener('change', (e) => {
gcNumber.setMaxMinBehavior(maxMinBehaviors[e.target.selectedIndex]);
});
const maxMinBehaviors = [
InputMan.MaxMinBehavior.AdjustToMaxMin,
InputMan.MaxMinBehavior.Clear,
InputMan.MaxMinBehavior.Restore,
InputMan.MaxMinBehavior.CancelInput,
InputMan.MaxMinBehavior.Keep
];
document.getElementById('setAcceptsCrlf').addEventListener('change', (e) => {
gcNumber.setAcceptsCrlf(crLfModes[e.target.selectedIndex]);
});
const crLfModes = [
InputMan.CrLfMode.NoControl,
InputMan.CrLfMode.Filter,
InputMan.CrLfMode.Cut
];
document.getElementById('autoConvert').addEventListener('change', (e) => {
gcNumber.autoConvert = e.target.checked;
});
gcNumber.onInvalidInput(() => {
alert('不正な文字の入力です。半角数字で入力してください。');
});
gcNumber.onInvalidRange(() => {
alert('-100以上100以下の数字を入力してください。');
});
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>数値コントロール - 入力の制御</title>
<!-- SystemJS -->
<script src="node_modules/systemjs/dist/system.src.js"></script>
<script src="systemjs.config.js"></script>
<script>
window.onload = function() {
System.import('./src/app');
}
</script>
</head>
<body>
<input id="gcNumber">(-100~100)
<table class="sample">
<tr>
<th>範囲外値の制御方法</th>
<td>
<select id="setMaxMinBehavior">
<option>最大値か最小値の近い方に設定</option>
<option>値を削除</option>
<option selected>変更前の値に戻す</option>
<option>最後の入力をキャンセルする</option>
<option>最後に入力された現在値を保持</option>
</select>
</td>
</tr>
<tr>
<th>改行コードの扱い</th>
<td>
<select id="setAcceptsCrlf">
<option>そのまま使用</option>
<option>すべての改行コードを削除</option>
<option>改行コード以降の文字列を切り取り</option>
</select>
</td>
</tr>
<tr>
<th>全角数字を半角に変換</th>
<td>
<label><input type="checkbox" id="autoConvert">自動変換</label>
</td>
</tr>
</table>
</body>
</html>
System.config({
transpiler: 'plugin-babel',
babelOptions: {
es2015: true
},
meta: {
'*.css': { loader: 'css' }
},
paths: {
// paths serve as alias
'npm:': 'node_modules/'
},
// map tells the System loader where to look for things
map: {
'@mescius/inputman': 'npm:@mescius/inputman/index.js',
'@mescius/inputman/CSS': 'npm:@mescius/inputman/CSS',
'css': 'npm:systemjs-plugin-css/css.js',
'plugin-babel': 'npm:systemjs-plugin-babel/plugin-babel.js',
'systemjs-babel-build': 'npm:systemjs-plugin-babel/systemjs-babel-browser.js'
},
// packages tells the System loader how to load when no filename and/or no extension
packages: {
src: {
defaultExtension: 'js'
},
"node_modules": {
defaultExtension: 'js'
},
}
});