リストコントロールでは、リストアイテムの中から複数のアイテムを同時に選択することができます。
概要
リストコントロールの場合、リストアイテムの選択方法には以下の2つの方法があります。
リストアイテムをクリックして選択(選択されたアイテムは反転表示)
チェックボックスによる選択
選択モード
setSelectionModeメソッドを使用してリストアイテムを選択する時の動作を設定できます。setSelectionModeメソッドは、以下の3つの動作から選択します。既定値はListBoxSelectionMode.Singleです。
値
説明
Multiple
複数のアイテムを選択できます。
MultipleExt
CtrlキーとShiftキーを押しながらクリックすることで複数のアイテムを選択できます。
Single
一つのアイテムのみ選択できます。
setSelectedIndexメソッドを使用することで特定のアイテムを選択でき、setSelectedIndicesメソッドを使用することで複数のアイテムをまとめて選択することができます。また、clearSelectedメソッドを使用することでアイテムの選択状態を解除することができます。
選択されているアイテムを取得するメソッドとしては、以下のようなメソッドが用意されています。
メソッド
説明
getSelectedIndex
選択されたアイテムのインデックスを取得します。
getSelectedIndices
選択されたアイテムのインデックスを取得します。取得結果は配列として返され、複数のアイテムを選択している場合、すべてのインデックスを返します。
getSelectedItem
選択されたアイテムを取得します。
getSelectedItems
選択されたアイテムを取得します。取得結果は配列として返され、複数のアイテムを選択している場合、すべてのアイテムを返します。
getSelectedValue
valueMemberPathを使用して選択されたアイテムの値を取得します。
getSelectedValues
valueMemberPathを使用して選択されたアイテムの値を取得します。取得結果は配列として返され、複数のアイテムを選択している場合、すべてのアイテムの値を返します。
チェックボックス
showCheckBoxプロパティをtrueに設定することでリストアイテムの左端にチェックボックスが表示されます。リストアイテムを複数列で校正している場合、一番左端の列にチェックボックスが表示されます。
setCheckedIndexメソッドを使用することで特定のアイテムをチェックすることができ、setCheckedIndicesメソッドを使用することで複数のアイテムをまとめてチェックすることができます。また、clearCheckedメソッドを使用することでアイテムのチェックをすべてクリアすることができます。
チェックされているアイテムを取得するメソッドとしては、以下のようなメソッドが用意されています。
メソッド
説明
getCheckedIndices
チェックしたアイテムのインデックスを取得します。取得結果は配列として返され、複数のアイテムをチェックしている場合、すべてのインデックスを返します。
getCheckedItems
チェックしたアイテムを取得します。取得結果は配列として返され、複数のアイテムをチェックしている場合、すべてのアイテムを返します。
import '@mescius/inputman/CSS/gc.inputman-js.css';
import './styles.css';
import { InputMan } from '@mescius/inputman';
import { products, allIndecies } from './data';
InputMan.appearanceStyle = InputMan.AppearanceStyle.Modern;
let gcListBox;
var listBoxSelectionModes = [
InputMan.ListBoxSelectionMode.Single,
InputMan.ListBoxSelectionMode.Multiple,
InputMan.ListBoxSelectionMode.MultipleExt
];
document.getElementById('setSelectionMode').addEventListener('change', (e) => {
gcListBox.setSelectionMode(listBoxSelectionModes[e.target.selectedIndex]);
document.getElementById('selectAll').disabled = e.target.selectedIndex == 0;
});
const attachClick = (id, handler) => {
document.getElementById(id).addEventListener('click', handler);
}
const render = (showCheckBox) => {
const container = document.getElementById('container');
container.innerHTML = '';
gcListBox = new InputMan.GcListBox(container, {
items: products,
showCheckBox
});
gcListBox.addEventListener('SelectedChanged', (sender) => {
document.getElementById('selectedItems').innerText = sender.getSelectedValues().join('\n');
});
gcListBox.addEventListener('CheckedChanged', (sender) => {
document.getElementById('checkedItems').innerText = sender.getCheckedItems().map(item => item.Text).join('\n');
});
}
render(true);
attachClick('selectAll', () => gcListBox.setSelectedIndices(allIndecies))
attachClick('unselectAll', () => gcListBox.clearSelected());
attachClick('checkAll', () => gcListBox.setCheckedIndices(allIndecies))
attachClick('uncheckAll', () => gcListBox.clearChecked());
document.getElementById('showCheckBox').addEventListener('change', (e) => {
let checked = e.target.checked;
document.getElementById('checkAll').disabled = !checked;
document.getElementById('uncheckAll').disabled = !checked;
gcListBox.clearSelected();
gcListBox.clearChecked();
render(checked);
});
<!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>
<div class="flexbox">
<div>
<div id="container"></div>
</div>
<div>
選択された項目:<div id="selectedItems"></div>
</div>
<div>
チェックされた項目:<div id="checkedItems"></div>
</div>
</div>
<table class="sample">
<tr>
<th>選択モード</th>
<td>
<select id="setSelectionMode">
<option>1つの項目のみ選択</option>
<option>クリックで複数の項目を選択</option>
<option>Ctrl/Shift+クリックで複数の項目を選択</option>
</select><br>
<button id="selectAll" disabled>すべて選択</button>
<button id="unselectAll">すべて選択解除</button>
</td>
</tr>
<tr>
<th>チェックボックス</th>
<td>
<label><input type="checkbox" id="showCheckBox" checked> チェックボックスを表示</label>
<br>
<button id="checkAll">すべてチェック</button>
<button id="uncheckAll">すべてチェック解除</button>
</td>
</tr>
</table>
</body>
</html>
.flexbox > div {
width: 200px;
}
export const products = [
'果汁100%オレンジ',
'果汁100%グレープ',
'果汁100%レモン',
'果汁100%ピーチ',
'コーヒーマイルド',
'コーヒービター'
];
export const allIndecies = products.map((v, i) => i);
[gcim-control-appearance="modern"] .flexbox > div {
width: 200px;
}
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'
},
}
});