imuiListTable
コンポーネント情報 | |
---|---|
モジュール | im_ui |
導入されたバージョン | 8.0.1 |
バージョン | 8.0.20 |
機能説明
- データ配列からテーブルHTMLを生成します。
- ヘッダーには以下の機能があります。
- ヘッダーにテーブルを開閉
- テーブルには以下の機能があります。
- 各カラムに対してのソートコントロール
- 複数列選択用のチェックボックス列の生成
- ヘッダ・フッタ固定でのスクロール
- ページャーを配置した場合には以下の機能を扱うことができます。
- 次のページ、前のページ、最後のページ、最初のページへのページングコントロール
- テキストボックス入力による、任意のページへのページングコントロール
- セレクトボックスの切り替えによる、ページ内表示行数の変更
- データの再読み込み
- テーブル情報の詳細表示
全体イメージ
ヘッダー部
テーブル部
ページャー部
- 指定した属性は生成されたtableタグに適用されます。
- ただし、下記の属性を指定した場合にのみ、生成されたHTMLのトップ要素のdivタグに移動して適用されます。
- hidden属性
- style属性の display: none
- style属性の visibility: hidden
- 本コンポーネントにはいくつか制限事項があります。
- imuiDialog内で利用した場合に初期表示のレイアウトが崩れます。詳細は以下の サンプル を参照してください。
- data属性を使用し、かつpager表示時にcsjsでの変更が無視されます。詳細は以下の サンプル を参照してください。
- テーブルの td, th 中に置いた場合、横幅の計算が正常に動作しない場合があります。
- imuiListTableにセルの幅全体に広がらない可能性があります。セルの幅が固定値の場合は、imuiListTableのwidth属性に固定値を指定してください。
- ブラウザをリサイズしても、正常に横幅が計算されない場合があります。autoWidth属性にfalseを指定してください。
- 処理先のスクリプト開発プログラム内で例外が発生しても、エラー画面に遷移せず、エラーメッセージが表示されます。
- colタグ の内部タグ(showLink、showIcon、openWindow、callFunction)はそれぞれ共存することができません。同時に指定しないでください。
- ブラウザや他のコンポーネントとの組み合わせで、imuiListTable の右端が表示領域に収まらない場合があります。画面のリサイズ、またはリストテーブル自体をリサイズすることで、横幅を再計算を行います。詳細は以下の サンプル を参照してください。
属性一覧
注釈 | 属性名 | 型 | 説明 | 省略時の動作 |
---|---|---|---|---|
Boolean属性 | autoEncode |
boolean | 登録するデータ、取得するデータをエスケープするかどうかを指定します 本属性の動作はjqGridのautoEncode設定時の動作と同じになることしか保証をしません |
false |
autoHeight |
string | parentSelector 属性で指定した要素の高さを基準とし、相対的な高さ指定します ウィンドウに対して常に80%の高さで表示したい場合、本属性に 80 または 80% と指定します 単位は「%」と「vh」が利用できます 単位を省略した場合、%を指定した場合と同様の動きになります vh を指定した場合、parentSelector 属性の指定は無視されます height 属性を同時に指定した場合、height 属性の値は無視されます 本属性は Ver.8.0.20 以降のバージョンで使用可能です |
- | |
Boolean属性 | autoResize |
boolean | ブラウザのリサイズ時に自動的にグリッドの横幅を調整するかどうかを指定します 本属性はautoWidth属性がtrueの時にのみ使用できます |
true |
Boolean属性 | autoWidth |
boolean | 初期表示時にグリッドの横幅を親要素に合わせるかどうかを指定します width属性が指定されている場合、指定したwidth属性が優先され、本属性は無視されます 本属性の動作はjqGridのautoWidth設定時の動作と同じになることしか保証をしません |
true |
国際化 無害化 | caption |
string | ヘッダー部の文字列を指定します | - |
cellSubmit |
string | セル編集時の保存先を指定します clientArray,remoteのどちらかを指定します clientArray:データをローカルで保持している場合 remote:データをajaxで取得している場合 本属性は内部要素のcolタグのeditable属性にtrueになる値を指定されている場合に有効になります 詳細は下記の セル編集 を参照してください 本属性は Ver.8.0.12 以降のバージョンで使用可能です |
- | |
cellUrl |
string | cellSubmit属性にremoteを指定した場合に、処理を行うページのurlを指定します 本属性は内部要素のcolタグのeditable属性にtrueになる値を指定されている場合に有効になります 詳細は下記の セル編集 を参照してください 本属性は Ver.8.0.12 以降のバージョンで使用可能です |
- | |
Boolean属性 | checkBoxOnly |
boolean | チェックボックスをクリックしたときにのみ反応するかどうかを指定します multiSelect属性がtrueの時に使用できます 本属性はonBeforeSelectRow属性との共存はできません |
false |
data |
Array | 表示するデータを指定します 本属性が指定された場合process属性とtarget属性は無視されます |
- | |
height |
string | リストテーブルの縦幅を指定します 単位は%のみ指定が可能で、ピクセルを指定したい場合は数値のみの文字列を指定します autoの指定も可能です |
150 | |
HTML5
Boolean属性
|
hidden |
boolean | リストテーブルを非表示にします | false |
id |
string | 生成されるtable要素のidです | 代替idを付与 | |
maxHeight |
string | リストテーブルの max-height を指定します 数値のみの文字列を指定してください。pxとして扱われます 本属性は Ver.8.0.20 以降のバージョンで使用可能です |
- | |
minHeight |
string | リストテーブルの min-height を指定します 数値のみの文字列を指定してください。pxとして扱われます 未指定の場合、height 属性の値が利用されます 本属性は Ver.8.0.20 以降のバージョンで使用可能です |
height 属性の値 | |
Boolean属性 | multiSelect |
boolean | グリッドの左端にチェックボックスを表示するかどうかを指定します 表示した場合は複数選択が可能になります |
false |
name |
string | 生成されるtable要素のnameです | 代替nameを付与 | |
onAfterEditCell |
string | onAfterEditCellイベント時に実行する関数名を指定します jqGridのafterEditCell設定時の動作と同じになることしか保証をしません 本属性は Ver.8.0.12 以降のバージョンで使用可能です |
- | |
onAfterInsertRow |
string | onAfterInsertRowイベント時に実行する関数名を指定します jqGridのafterInsertRow設定時の動作と同じになることしか保証をしません |
- | |
onAfterSaveCell |
string | onAfterSaveCellイベント時に実行する関数名を指定します jqGridのafterSaveCell設定時の動作と同じになることしか保証をしません 本属性は Ver.8.0.12 以降のバージョンで使用可能です |
- | |
onAfterSubmitCell |
string | onAfterSubmitCellイベント時に実行する関数名を指定します jqGridのafterSubmitCell設定時の動作と同じになることしか保証をしません 本属性は Ver.8.0.12 以降のバージョンで使用可能です |
- | |
onAjaxBeforeSend |
string | ajax通信が発生する直前に呼び出される関数名を指定します 明示的にfalseを返したときのみ、通信をキャンセルします |
- | |
onAjaxComplete |
string | ajax通信終了後に呼ばれる関数名を指定します 通信結果が成功であったかエラーであったかに関係なく必ず実行されます |
- | |
onAjaxError |
string | ajax通信失敗後に呼ばれる関数名を指定します | imuiTransitionToErrorPage | |
onAjaxParameterExtend |
string | ajax通信を実行する直前に呼び出される関数名を指定します ajax関連のメソッド内で一番最初に呼び出されます |
- | |
onAjaxSuccess |
string | ajax通信成功後に呼ばれる関数名を指定します | - | |
onBeforeEditCell |
string | onBeforeEditCellイベント時に実行する関数名を指定します jqGridのbeforeEditCell設定時の動作と同じになることしか保証をしません 本属性は Ver.8.0.12 以降のバージョンで使用可能です |
- | |
onBeforeSaveCell |
string | onBeforeSaveCellイベント時に実行する関数名を指定します jqGridのbeforeSaveCell設定時の動作と同じになることしか保証をしません 本属性は Ver.8.0.12 以降のバージョンで使用可能です |
- | |
onBeforeSelectRow |
string | onBeforeSelectRowイベント時に実行する関数名を指定します booleanを返却することができ、falseを返却すると行選択をキャンセルできます 本属性はcheckBoxOnly属性との共存はできません jqGridのbeforeSelectRow設定時の動作と同じになることしか保証をしません |
- | |
onBeforeSubmitCell |
string | onBeforeSubmitCellイベント時に実行する関数名を指定します jqGridのbeforeSubmitCell設定時の動作と同じになることしか保証をしません 本属性は Ver.8.0.12 以降のバージョンで使用可能です |
- | |
onCellSelect |
string | onCellSelectイベント時に実行する関数名を指定します jqGridのonCellSelect設定時の動作と同じになることしか保証をしません |
- | |
onDblClickRow |
string | onDblClickRowイベント時に実行する関数名を指定します jqGridのonDblClickRow設定時の動作と同じになることしか保証をしません |
- | |
onErrorCell |
string | onErrorCellイベント時に実行する関数名を指定します jqGridのerrorCell設定時の動作と同じになることしか保証をしません 本属性は Ver.8.0.12 以降のバージョンで使用可能です |
function(xhr) { imuiShowErrorMessage($(xhr.responseText).find('dt').text()); } | |
onFormatCell |
string | onFormatCellイベント時に実行する関数名を指定します jqGridのformatCell設定時の動作と同じになることしか保証をしません 本属性は Ver.8.0.12 以降のバージョンで使用可能です |
- | |
onGridComplete |
string | onGridCompleteイベント時に実行する関数名を指定します jqGridのgridComplete設定時の動作と同じになることしか保証をしません |
- | |
onHeaderClick |
string | onHeaderClickイベント時に実行する関数名を指定します jqGridのonHeaderClick設定時の動作と同じになることしか保証をしません |
- | |
onLoadComplete |
string | onLoadCompleteイベント時に実行する関数名を指定します jqGridのloadComplete設定時の動作と同じになることしか保証をしません |
- | |
onPaging |
string | onPagingイベント時に実行する関数名を指定します 内部要素pagerを使用しない場合は無視されます jqGridのonPaging設定時の動作と同じになることしか保証をしません |
- | |
onRightClickRow |
string | onRightClickRowイベント時に実行する関数名を指定します jqGridのonRightClickRow設定時の動作と同じになることしか保証をしません |
- | |
onSelectAll |
string | onSelectAllイベント時に実行する関数名を指定します jqGridのonSelectAll設定時の動作と同じになることしか保証をしません |
- | |
onSelectCell |
string | onSelectCellイベント時に実行する関数名を指定します jqGridのonSelectCell設定時の動作と同じになることしか保証をしません 本属性は Ver.8.0.12 以降のバージョンで使用可能です |
- | |
onSelectRow |
string | onSelectRowイベント時に実行する関数名を指定します jqGridのonSelectRow設定時の動作と同じになることしか保証をしません セル編集を利用する場合(editable属性をtrue)、onSelectRowイベントは無視されます |
- | |
page |
number | 初期表示するページ番号を指定します 内部要素pagerを使用しない場合は無視されます |
1 | |
pagerId |
string | 生成されるdiv要素のidです 内部要素pagerを使用しない場合は無視されます |
id属性_pager | |
parentSelector |
string | autoHeight 属性で高さを計算する算出元の要素をjQueryセレクタで指定します idなら“#id”、classなら“.class”と指定してください 未指定の場合は、window からフッタとヘッダを取り除いた領域の高さを利用します 本属性は autoHeight 属性が未指定の場合は無視されます 本属性は Ver.8.0.20 以降のバージョンで使用可能です |
window の高さからヘッダとフッタを引いた領域 | |
plainParameter |
string | リストテーブルの初期化時に追加で渡したいオプションを指定します 本属性に渡したオプションは無害化されずそのまま出力されます |
- | |
process |
string | データ取得時に呼ばれるプロセスタイプを指定します csjs、config、jssp、javaのいすれかの値を指定してください 本属性を指定する場合はtarget属性も指定をしてください 本属性はdata属性が指定されている場合は無視されます |
- | |
Boolean属性 | redirectErrorPage |
boolean | ajax通信に失敗した際にエラー画面へ遷移するかどうかを指定します 本属性は Ver.8.0.5 以降のバージョンで使用可能です |
false |
rowNumWidth |
string | rowNumbers属性がtrueの時に表示される行番号のカラムの横幅を指定します(単位:px) 数値のみの文字列を指定してください 本属性はrowNumbers属性がtrueの時に使用できます |
25 | |
Boolean属性 | rowNumbers |
boolean | グリッドの左端に行番号を表示するかどうかを指定します | false |
Boolean属性 | shrinkToFit |
boolean | グリッドの横幅変更時に、各カラムのサイズを再計算するかどうかを指定します | true |
sortName |
string | 初期表示時のソートをさせるidを指定します 内部要素colのname属性に指定した値のいずれかを指定します |
- | |
sortOrder |
string | 初期表示時のソート順を指定します 本属性はsortName属性を指定しないとソートされません 昇順でソートしたい場合はascを指定し、降順でソートしたい場合はdescを指定します |
asc | |
target |
string | データ取得時に呼ばれる処理の実装先を指定します 本属性を指定する場合はprocess属性も指定をしてください data属性が指定されている場合は無視されます |
- | |
Boolean属性 | viewRecords |
boolean | フッター部にレコード数を表示するかどうかを指定します 内部要素pageを使用しない場合は無視されます |
false |
width |
string | リストテーブルの横幅を指定します 本属性には単位となる「px、%」をせず、数値のみの文字列を指定してください 100%を指定したい場合は、本属性になにも指定せず autoWidth属性にtrueになる値を指定してください |
- | |
無害化 | その他 |
string | ユーザ定義属性です | - |