001/* 002 * Copyright (c) 2009 The openGion Project. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, 013 * either express or implied. See the License for the specific language 014 * governing permissions and limitations under the License. 015 */ 016package org.opengion.hayabusa.html; 017 018import java.util.List; 019import java.util.Map; 020import java.util.concurrent.ConcurrentMap; // 6.4.3.3 (2016/03/04) 021import java.io.Writer; 022import java.io.IOException; 023 024import org.opengion.hayabusa.db.DBTableModel; 025import org.opengion.hayabusa.resource.ResourceManager; 026 027/** 028 * DBTableModelの表示を行うインターフェースです。 029 * 各種の表示形式をサポートするには、ViewForm インターフェースを implements した 030 * クラスを作成して、DBTableModel をセットするだけです。 031 * ViewForm 自体は,Controller クラスよりアクセスされます。 032 * 033 * ViewForm の実装クラス( implements されたクラス)に対する 各種設定(たとえば、HTMLタグなど) 034 * は、個々の実装クラス毎に設定します。 035 * 036 * @og.group 画面表示 037 * 038 * @version 4.0 039 * @author Kazuhiko Hasegawa 040 * @since JDK5.0, 041 */ 042public interface ViewForm { 043 044 /** 045 * カラムの書込み許可属性(clmWritable)の初期値を指定します。 046 * これが true の場合は,デフォルトですべてのカラムが書込み許可されます。 047 * false の場合は,すべてが書込み不許可になります。 048 * 049 * このデフォルト値は、false に設定されています。 050 * 051 */ 052 boolean DEFAULT_CLM_WRITABLE = false; 053 054 /** 055 * 書き込み可能な行(rowWritable == true)のみを表示対象とするかどうかを 056 * 指定します。 057 * 058 */ 059 boolean DEFAULT_SKIP = false; 060 061 /** 062 * 初期化します。 063 * ここでは、内部で使用されているキャッシュをクリアし、 064 * 新しいモデル(DBTableModel)と言語(lang) を元に内部データを再構築します。 065 * 066 * @og.rev 3.5.6.1 (2004/06/25) lang 言語コード 属性を削除します。 067 * 068 * @param table DBTableModelオブジェクト 069 */ 070 void init( DBTableModel table ) ; 071 072 /** 073 * DBTableModel から View文字列を作成して返します。 074 * 075 * @return DBTableModelから作成された View文字列 076 */ 077 String create() ; 078 079 /** 080 * DBTableModel から View文字列を作成して返します。 081 * startNo(表示開始位置)から、pageSize(表示件数)までのView文字列を作成します。 082 * 表示残りデータが pageSize 以下の場合は,残りのデータをすべて出力します。 083 * 084 * @param startNo 表示開始位置 085 * @param pageSize 表示件数 086 * 087 * @return DBTableModelから作成された View文字列 088 */ 089 String create( int startNo, int pageSize ) ; 090 091 /** 092 * DBTableModel から View文字列を作成して、Writer にセットします。 093 * 処理内容は、create( int , int ) と同じですが、中間の文字列(StringBuilder) 094 * を作成せずに、直接、Writer に書き出します。 095 * よって、データ作成途中でエラーが発生しても、すでにいくつかのデータは 096 * クライアントに返されています。 097 * 098 * @og.rev 5.0.0.1 (2009/08/15) 直接出力用の Writer 引数追加 099 * 100 * @param startNo 表示開始位置 101 * @param pageSize 表示件数 102 * @param wrt 直接登録用の Writer 103 * @throws IOException 入出力エラーが発生したとき 104 */ 105 void create( int startNo, int pageSize, Writer wrt ) throws IOException ; 106 107 /** 108 * 表示開始位置をセットします。 109 * 110 * @param startNo 表示開始位置 111 */ 112 void setStartNo( int startNo ) ; 113 114 /** 115 * 表示開始位置を返します。 116 * 117 * @return 表示開始位置 118 */ 119 int getStartNo() ; 120 121 /** 122 * 表示件数をセットします。 123 * 124 * @param pageSize 表示件数 125 */ 126 void setPageSize( int pageSize ) ; 127 128 /** 129 * 表示件数を返します。 130 * 131 * @return pageSize 表示件数 132 */ 133 int getPageSize() ; 134 135 /** 136 * 内部の DBTableModel を返します。 137 * 138 * @return DBTableModelオブジェクト 139 */ 140 DBTableModel getDBTableModel() ; 141 142 /** 143 * ViewForm の識別IDをセットします。 144 * これは、ViewFormFactory でプールする場合の識別キーになります。 145 * プールに戻すときに自分自身に この識別IDを使用します。 146 * 147 * @og.rev 3.5.6.2 (2004/07/05) メソッド名がまぎらわしい為、変更します。 148 * 149 * @param id 識別ID 150 */ 151 void setId( String id ) ; 152 153 /** 154 * ViewForm の識別IDを返します。 155 * これは、ViewFormFactory でプールする場合の識別キーになります。 156 * プールに戻すときに自分自身に この識別IDを使用します。 157 * 158 * @og.rev 3.5.6.2 (2004/07/05) メソッド名がまぎらわしい為、変更します。 159 * 160 * @return 識別ID 161 */ 162 String getId() ; 163 164 /** 165 * 内容をクリア(初期化)します。 166 * 167 */ 168 void clear() ; 169 170 /** 171 * カラムが書き込み可能かどうかをセットします。 172 * 173 * @param column カラム番号 174 * @param rw 書込み可能(true)/不可能(false) 175 */ 176 void setColumnWritable( int column,boolean rw ) ; 177 178 /** 179 * 書き込み可能カラム名を、CSV形式で与えます。 180 * これは、書き込み不可カラム名の指定(noWritable)と同時にセットする 181 * ことは出来ません。 例:"OYA,KO,HJO,SU,DYSET,DYUPD" 182 * 183 * setColumnWritable( int column,boolean rw ) の簡易版です。 184 * null を与えた場合は,なにもしません。 185 * また、全カラムについて、有効にする場合は、columnName="*" を設定します。 186 * 187 * @param columnName カラム名 188 */ 189 void setColumnWritable( String columnName ) ; 190 191 /** 192 * 書き込み不可カラム名を、CSV形式で与えます。 193 * これは、書き込み可能カラム名の指定(columnWritable)と同時にセットする 194 * ことは出来ません。 例:"OYA,KO,HJO,SU,DYSET,DYUPD" 195 * 196 * null を与えた場合は,なにもしません。 197 * また、全カラムについて、有効にする場合は、columnName="*" を設定します。 198 * 199 * @param columnName カラム名 200 */ 201 void setNoWritable( String columnName ) ; 202 203 /** 204 * その行が、処理対象かどうかをチェックします。 205 * 処理対象かどうかは、書き込み可能な行(rowWritable == true) 206 * で且つ チェックされた行(rowChecked == true) とします。 207 * 例えば,NEXT/PREVでスキップ等の処理を行う場合は、 処理対象以外を 208 * スキップすることで実現できます。 209 * 210 * @param row 行番号 211 * 212 * @return 処理対象(true)/処理対象でない(false) 213 */ 214 boolean isMarked( int row ) ; 215 216 /** 217 * カラムが表示可能かどうかをセットします。 218 * これは、表示不可カラム名の指定(noDisplay)と同時にセットする 219 * ことは出来ません。 例:"OYA,KO,HJO,SU,DYSET,DYUPD" 220 * 221 * @param column カラム番号 222 * @param rw 表示可能(true)/不可能(false) 223 */ 224 void setColumnDisplay( int column,boolean rw ) ; 225 226 /** 227 * 表示可能カラム名を、CSV形式で与えます。 228 * これは、表示不可カラム名の指定(noDisplay)と同時にセットする 229 * ことは出来ません。 例:"OYA,KO,HJO,SU,DYSET,DYUPD" 230 * 231 * setColumnDisplay( int column,boolean rw ) の簡易版です。 232 * null を与えた場合は,なにもしません。 233 * また、全カラムについて、有効にする場合は、columnName="*" を設定します。 234 * 235 * @param columnName カラム名 236 */ 237 void setColumnDisplay( String columnName ) ; 238 239 /** 240 * 表示不可カラム名を、CSV形式で与えます。 241 * これは、表示可能カラム名の指定(columnDisplay)と同時にセットする 242 * ことは出来ません。 例:"OYA,KO,HJO,SU,DYSET,DYUPD" 243 * 244 * null を与えた場合は,なにもしません。 245 * また、全カラムについて、有効にする場合は、columnName="*" を設定します。 246 * 247 * @param columnName カラム名 248 */ 249 void setNoDisplay( String columnName ) ; 250 251 /** 252 * 同一表示データをまとめる(表示しない)カラム名を、CSV形式で与えます。 253 * 254 * これは、カラムのグループ化指定を行います。 255 * 同じカラム番号で一つ上の行番号と同じ内容の場合に、特殊な表示方法で表示します。 256 * 対応は、表示(Renderer)時のみとします。 257 * 特殊な表示方法の指定は、groupClass 属性で指定します。 258 * (例:groupClass にアルファベット以外の文字・・そのまま表示、アルファベットはクラス属性を付与します。) 259 * カラム単位なので、新しいゼブラによる色分けは行いません。(任意のカラムに適用できる為) 260 * また、ファイル出力などのデータ自身は変更されていませんので、そのままデータが落ちます。 261 * 262 * これは、同一表示データをまとめないカラム名の指定(noGroup)と同時にセットする 263 * ことは出来ません。 264 * また、全カラムについて、有効にする場合は、group="*" を設定します。 265 * 266 * @og.rev 3.8.5.0 (2006/03/20) 新規追加 267 * 268 * @param group まとめるカラム名(CSV形式) 269 */ 270 void setColumnGroup( String group ) ; 271 272 /** 273 * 同一表示データをまとめないカラム名を、CSV形式で与えます。 274 * 275 * これは、カラムのグループ化指定で、同一でもまとめないカラムを指定するほうが簡単な場合に 276 * 使用します。例えば、キー情報以外は、グループ化指定したい場合などに便利です。 277 * 動作は、columnGroup の動きと同じです。(まとめないカラムを指定するだけです。) 278 * 279 * これは、同一表示データをまとめるカラム名の指定(columnGroup)と同時にセットする 280 * ことは出来ません。 281 * また、全カラムについて、有効にする場合は、group="*" を設定します。 282 * 283 * @og.rev 5.1.8.0 (2010/07/01) 新規追加 284 * 285 * @param group 例:"OYA,KO,HJO,SU,DYSET,DYUPD" 286 */ 287 void setNoGroup( final String group ); 288 289 /** 290 * 同一表示データをまとめる場合の、表示方法を指定します。 291 * 292 * これは、カラムのグループ化指定(columnGroup)を行う場合の、まとめ表示の方法を指定します。 293 * なにも指定しない場合は、まとめカラムは、表示しない(ゼロ文字列)になります。 294 * その場合、先の行と同じ場合も、変更されたカラムが、NULL(ゼロ文字列)であった場合も、 295 * 同じ用に表示されるため、区別が付きません。 296 * そこで、前の行と同じデータの場合に、特殊な処理を行うことで、区別できるようにします。 297 * 指定方法が特殊なので、注意が必要です。 298 * 記号の場合: 299 * 記号(-- , → , ↓ , * など)が指定された場合は、そのままの文字に置き換えられます。 300 * アルファベットの場合: 301 * アルファベット(a-z,A-Z)の場合は、<span class="アルファベット">元の文字</span> 302 * 例えば、バックカラーに色を付ける、文字を薄い灰色にする、などできます。 303 * ただし、データ量が圧倒的に増えるため、大量のデータ等で使用するのは避けたほうが良いと思います。 304 * 305 * @og.rev 3.8.5.0 (2006/03/20) 新規追加 306 * 307 * @param grpCls まとめ表示の方法 308 */ 309 void setGroupClass( final String grpCls ); 310 311 /** 312 * 同一表示データをまとめる場合に、行(row)か列(column)を指定します(初期値:false:ROW) 313 * 314 * これは、カラムのグループ化指定(columnGroup)を行う場合の、まとめ表示の方向を指定します。 315 * ROW(初期値:false)を指定すると、指定のカラムで、行単位に同一データかどうかを判定します。 316 * COLUMN(true)を指定すると、columnGroup で指定した順番に、列方向に同一データかどうかを判定します。 317 * DBTableModelの登録順で、ひとつ前のカラムと比較します。 318 * 319 * @og.rev 6.7.3.0 (2017/01/27) 新規追加 320 * 321 * @param dir まとめ表示の方向(false:ROW/true:COLUMN) 322 * @see #setColumnGroup( String ) 323 */ 324 void setGroupDir( final boolean dir ); 325 326 /** 327 * カラム名リンクソートを表示するカラム名を、CSV形式で与えます。 328 * 329 * ヘッダーにソート用リンクを作成する useTableSorter 属性 に対して、 330 * カラム個別に作成する場合のカラム名をCSV形式で指定します。 331 * この tableSorterKeys 属性は、useTableSorter 属性 と無関係に、指定した 332 * カラムのみ、リンクを表示します。 333 * また、全カラムについて、有効にする場合は、columnName="*" を設定します。 334 * 例:"OYA,KO,HJO,SU,DYSET,DYUPD" 335 * 336 * @og.rev 3.6.0.0 (2004/09/17) 新規作成 337 * 338 * @param columnName カラム名 339 */ 340 void setTableSorterKeys( String columnName ) ; 341 342 /** 343 * 表示時の選択用オブジェクトのタイプを指定します。 344 * ・複数選択可能時は "checkbox" を指定します。 345 * ・一つだけ選ばせる場合は, "radio" を指定します。 346 * ・隠しフィールドで全件を選ぶ場合は、"hidden" を指定します。 347 * 初期値は、"checkbox" です。 348 * 349 * @param type 選択用オブジェクトのタイプ( "checkbox"/"radio"/"hidden"/"null" ) 350 */ 351 void setSelectedType( String type ) ; 352 353 /** 354 * 表示時の行番号の表示方法を指定します。 355 * ・sequenceは、1から始まる連番です。 356 * ・none を指定すると、番号は表示されません。 357 * ・delete を指定すると、行番号表示そのもののタグを取り除きます。(3.5.5.0 追加) 358 * ・skip=カラム名を指定すると、そのカラムの値が NULL の場合は、番号をスキップします。 359 * ・view=カラム名を指定すると、そのカラムの値が、使用されます。(ラベルは付きません) 360 * skip=XX と、view=XX は、=の前後にスペースを入れないで下さい。 361 * 初期値は、"sequence" です。 362 * 363 * @og.rev 3.5.1.0 (2003/10/03) 新規作成 364 * 365 * @param type 行番号の表示方法のタイプ( /sequence/none/delete/skip=カラム名/view=カラム名/ ) 366 */ 367 void setNumberType( String type ) ; 368 369 /** 370 * テーブル等のチェックボックスに属性を付加します 371 * JavaScript などの HTML基本タグ以外の属性を、そのまま 372 * チェックボックス/ラジオボタン等に使用します。 373 * 374 * @param option オプション属性 375 */ 376 void setOptionTypeAttributes( String option ) ; 377 378 /** 379 * リソースマネージャを設定します。 380 * クロス集計時に、useColumnHeader="true"とした場合のみ設定されます。 381 * 382 * @og.rev 4.0.0.0 新規作成 383 * 384 * @param res リソースマネージャー 385 */ 386 void setResourceManager( ResourceManager res ) ; 387 388 ////////////////////////////////////////////////////////////////////////// 389 // 390 // フォーマット関連クラスのメソッド 391 // 392 ////////////////////////////////////////////////////////////////////////// 393 394 /** 395 * フォーマットを設定します。 396 * 397 * @og.rev 3.5.4.0 (2003/11/25) 新規作成 398 * 399 * @param list TableFormatterのリスト 400 */ 401 void setFormatterList( List<TableFormatter> list ) ; // 4.3.3.6 (2008/11/15) Generics警告対応 402 403 /** 404 * フォーマットメソッドを使用できるかどうかを問い合わせます。 405 * 406 * @return フォーマットメソッドを使用できるか 407 */ 408 boolean canUseFormat() ; 409 410 /** 411 * ビューフォームのタイプを返します。 412 * これは、ViewFormFactory で、org.opengion.hayabusa.html. + 『type』 + ViewForm 413 * で作成されるサブクラスの 『type』 部分を返します。 414 * 415 * @return ビューフォームのタイプ 416 */ 417 String getViewFormType() ; 418 419 /** 420 * ビューリンクオブジェクトを設定します。 421 * これは、ViewLink タグで作成された キー(カラム名)とリンク文字列を 422 * 持っている Attributes オブジェクトを受け取り、内部でリンク表示に 423 * 使用します。 424 * 425 * @param link ビューリンクオブジェクト 426 */ 427 void setViewLink( ViewMarker link ); 428 429 /** 430 * ビューマーカーオブジェクトを設定します。 431 * これは、ViewMarker タグで作成された キー(カラム名)とマーカー文字列を 432 * 持っている Attributes オブジェクトを受け取り、内部でマーカー表示に 433 * 使用します。 434 * 435 * @param link ビューマーカーオブジェクト 436 */ 437 void setViewMarker( ViewMarker link ); 438 439 /** 440 * 編集マーカーオブジェクトを設定します。 441 * これは、ViewMarker タグで、isRendere="false" で作成された 編集キー(カラム名)と 442 * マーカー文字列を持っている Attributes オブジェクトを受け取り、内部でマーカー表示に 443 * 使用します。 444 * 445 * @og.rev 3.8.6.1 (2006/10/20) 新規追加 446 * 447 * @param marker ビューマーカーオブジェクト 448 */ 449 void setEditMarker( ViewMarker marker ) ; 450 451 /** 452 * 検索結果メッセージを表示する/しないを設定します 453 * 初期値は、表示する(false)です。 454 * 455 * @param noMessage [true:表示しない/false:表示する] 456 */ 457 void setNoMessage( boolean noMessage ) ; 458 459 /** 460 * 先頭へ戻るリンク間隔を返します。 461 * 462 * @return backLinkCount リンク間隔 463 */ 464 int getBackLinkCount() ; 465 466 /** 467 * 先頭へ戻るリンク間隔をセットします。 468 * 469 * @param no リンク間隔 470 */ 471 void setBackLinkCount( int no ) ; 472 473 /** 474 * ヘッダーを出力する間隔を取得します。 475 * 476 * @og.rev 3.5.2.0 (2003/10/20) 新規作成 477 * 478 * @return ヘッダーの表示間隔 ( 0:通常ヘッダ、n:n回ごとに現れる ) 479 */ 480 int getHeaderSkipCount() ; 481 482 /** 483 * ヘッダーを出力する間隔をセットします。 484 * 485 * 0を指定すると、繰り返しません(つまり、ヘッダーを最初に表示するだけです。) 486 * 数字を指定すると、その回数毎に、ヘッダーをデータの行に挿入します。 487 * 488 * @og.rev 3.5.2.0 (2003/10/20) 新規作成 489 * 490 * @param hsc ヘッダーの表示間隔 ( 0:通常ヘッダ、n:n回ごとに現れる ) 491 */ 492 void setHeaderSkipCount( int hsc ) ; 493 494 /** 495 * チェックの入った行のみを表示させるかどうか指定します。 496 * 497 * "true" で、チェックの入った行のみを表示させます。 498 * 従来は、TextField系のViewに対して、NEXT,PREVでチェックの 499 * 入った行のみを表示させる機能でしたが、Table系のViewに対しても、 500 * 同様に機能するように、しました。 501 * 初期値は、ViewForm.DEFAULT_SKIP です。 502 * 503 * @og.rev 3.5.3.1 (2003/10/31) 新規追加 504 * 505 * @param flag チェックの入った行のみを表示させるかどうか(true:のみ表示/false:前件表示) 506 */ 507 void setSkip( boolean flag ) ; 508 509 /** 510 * チェックボックスの全チェックを選択するJavaScript の機能を使用するかどうかを指定します。 511 * 512 * 1 で、コントロール用のチェックボックスが現れて、この機能を使用することができるようになります。 513 * 0 は、従来どおりです。 514 * 使用するにあたり、jsp/commpn/default.js にJavaScriptを設定しておきます。(設定済み) 515// * 初期値は、システムパラメータ の VIEW_USE_CHECK_CONTROL です。(0:使用しない) 516 * 517 * @og.rev 3.5.4.3 (2004/01/05) 新規追加 518 * @og.rev 3.7.0.1 (2005/01/31) 全件チェックコントロール変更( boolean ⇒ String ) 519 * 520 * @param flag チェックボックスの全チェックを選択する機能を使用するかどうか 521 * (1:使用する/0:使用しない/2:初期値チェック済み) 522 */ 523 void setUseCheckControl( int flag ) ; 524 525 /** 526 * ヘッダーにソート用リンクを作成するかどうかを指定します。 527 * 528 * "true" で、ヘッダーにソート用リンクを作成します。 529 * false は、作成しません。 530 * 531 * @og.rev 3.5.4.7 (2004/02/06) 新規追加 532 * 533 * @param flag ヘッダーにソート用リンクを作成するかどうか(true:作成する/false:作成しない) 534 */ 535 void setUseTableSorter( boolean flag ) ; 536 537 /** 538 * ヘッダーにソート用リンクを作成する時の、リクエスト引数のMapを設定します。 539 * 540 * ソート用URLに、リクエスト時の引数を設定する必要があります。 541 * そのため、リクエスト時のキーと値のセットをMapで指定します。 542 * このMap は、リクエストキャッシュより取り出します。 543 * 実装では、このMapを元に、URLのQuery部文字列を作成します。処理過程において、 544 * このMap を書き換えることは行いません。 545 * 546 * @og.rev 3.6.0.0 (2004/09/17) 新規作成 547 * 548 * @param map ヘッダーソート時のリンクに追加するリクエスト変数のキャッシュMap 549 */ 550 void makeTableSorterQuery( Map<?,?> map ) ; // 4.3.3.6 (2008/11/15) Generics警告対応 551 552 /** 553 * ViewForm のサブクラスに渡すパラメータマップ。 554 * 555 * @og.rev 3.5.4.8 (2004/02/23) ViewParamTag のパラメータを追加します。 556 * @og.rev 6.4.3.3 (2016/03/04) ConcurrentHashMap を受け取ることを明確にするため、I/FをConcurrentMapに変更します。 557 * 558 * @param map パラメータマップ 559 */ 560 void setParam( ConcurrentMap<String,String> map ) ; // 6.4.3.3 (2016/03/04) 561 562 /** 563 * ViewForm のサブクラスに渡すパラメータ(文字列配列のList)を設定します。 564 * 565 * @og.rev 5.5.8.3 (2011/11/17) Object受け渡しのために追加 566 * 567 * @param list 文字列配列のList 568 */ 569 void setViewArrayList( List<String[]> list) ; 570 571 /** 572 * マーカーオブジェクト(リンク、マーカー)を設定します。 573 * ここでは、旧 ViewForm 属性を 新ViewForm に直接セットします。 574 * 575 * @og.rev 3.5.6.1 (2004/06/25) 新規追加 576 * 577 * @param view ViewFormオブジェクト 578 */ 579 void markerSet( ViewForm view ) ; 580 581 /** 582 * テーブルのバックグラウンドカラーの入れ替えのサイクルをセットします。 583 * 0(ゼブラなし)、-1(ワーニング)、-2以下(エラー)、1(ゼブラ)、2以上(行数まとめ) 584 * 初期値は、1(ゼブラ)です。 585 * 586 * @og.rev 3.5.6.2 (2004/07/05) 新規追加 587 * 588 * @param sycle 0(ゼブラなし)、-1(ワーニング)、-2以下(エラー)、1(ゼブラ)、2以上(行数まとめ) 589 */ 590 void setBgColorCycle( int sycle ) ; 591 592 /** 593 * テーブルのバックグラウンドカラーのクラスに指定するカラム名を指定します。 594 * 595 * 通常のゼブラ模様は、tr 属性のクラス指定として、row_0、row_1 が指定されます。 596 * その代わりに、ここで指定されたカラムの値がクラス属性として設定されます。 597 * (指定するのはカラム名です。行単位にクラス属性の値を変えることが可能です。) 598 * 選択行(row_sel)は、優先して使用されます。 599 * 出力されるクラス名は、"row_" + 属性値 になります。 600 * 601 * @og.rev 5.1.8.0 (2010/07/01) 新規追加 602 * 603 * @param clsClm ゼブラ模様の替わりに指定するクラスを格納したカラム名 604 */ 605 void setBgColorClsClm( final String clsClm ) ; 606 607 /** 608 * スクロールバー用のDIV要素を出力するかどうか(初期値は、false) 609 * 610 * スクロールバー対応する為、テーブルの先頭に、DIV要素を出力します。 611 * 初期値は、システムパラメータ の VIEW_USE_SCROLLBAR です。 612 * ※ 互換性の関係より、false になっています。 613 * ※ 互換性の関係より、新しいタイプのヘッダー固定を、"TYPE2" とします。 614 * 615 * @og.rev 3.5.6.4 (2004/07/16) 新規追加 616 * @og.rev 3.8.0.3 (2005/07/15) barType 変数の追加 617 * @og.rev 4.0.0.0 (2007/04/10) ヘッダー固定のスクロールタイプは、TYPE2 のみにする。 618 * 619 * @param useBar スクロールバー用のDIV要素を出力 [true:出力する/false:出力しない] 620 */ 621 void setUseScrollBar( boolean useBar ); 622 623 /** 624 * 指定の行番号まで画面をスクロールさせる場合の行番号を設定します。 625 * 626 * 画面をスクロール後、リンク等で他画面を表示後、戻ってきた場合に、 627 * 先のスクロール位置まで戻します。 628 * ただし、厳密に戻すことはできないため、大体のあたりに戻します。 629 * useSelRowColor は、選択行に色づけするかどうかを指定します。 630 * 631 * @og.rev 3.7.0.3 (2005/03/01) 新規追加 632 * @og.rev 3.7.1.1 (2005/05/31) 選択行マーカーの使用有無 633 * 634 * @param rowNo 指定の行番号まで画面をスクロールさせる場合の行番号 635 * @param useSelRowColor 指定の行番号(選択行)の色を変更するかどうか 636 */ 637 void setScrollRowNo( int rowNo, boolean useSelRowColor ) ; 638 639 /** 640 * 設定値に "_" が含まれている場合にレンデラーを使用するカラムをCSV形式で指定します。 641 * 642 * これは、従来の カラム定義の WRITABLE エディターと同等の働きを行うように 643 * カラム属性を指定します。 644 * WRITABLE エディターは、設定値にアンダーバー "_" が含まれている場合に、 645 * その値を書込み禁止にする機能です。これは、エディター自身が値を判断して 646 * 書き込み許可か禁止かを判断しています。 647 * この動きを汎用的にするため、指定のカラムをCSV形式(CSV)で指定 648 * することにより、レンデラーとエディターを設定値によって動的に切り替える 649 * 機能を実現します。 650 * その場合、表示/編集ともに、先頭のアンダーバーは削除されます。 651 * また、全カラムについて、有効にする場合は、writableControl="*" を設定します。 652 * 653 * @og.rev 3.8.0.9 (2005/10/17) 新規追加 654 * 655 * @param wrtCtrl 書き込み制御を行いたいカラムをCSV形式で指定 656 */ 657 void setWritableControl( String wrtCtrl ) ; 658 659 /** 660 * ogPopup で検索結果の値を返すキーを、CSV形式で指定します。 661 * 662 * popup の検索結果を返す画面で、結果のラジオボタンにイベントセットします。 663 * この場合、オープンもとのwindow に値を返しますが、そのキーをCSV形式で 664 * 指定します。 665 * なお、このメソッドは、一覧表示(HTMLTable)関係のビューのみでサポートして 666 * いますが、チェックメソッドの関係で、それ以外のビューに適用しても素通り 667 * するようにします。(エラーにしません) 668 * 669 * @og.rev 3.8.6.1 (2006/10/20) 新規追加 670 * 671 * @param rtnKeys ogPopupで値を返すカラム文字列(CSV形式) 672 */ 673 void setPopupReturnKeys( String rtnKeys ) ; 674 675 /** 676 * ビューの高さを指定します。 677 * 678 * @og.rev 4.2.0.0 (2008/03/18) 新規追加 679 * 680 * @param height 単位付き高さ 681 */ 682 void setHeight( String height ) ; 683 684 /** 685 * ビューの幅を指定します。 686 * 687 * @og.rev 4.2.0.0 (2008/03/18) 新規追加 688 * 689 * @param width 単位付き高さ 690 */ 691 void setWidth( String width ) ; 692 693 /** 694 * table要素に対して class 属性を設定します。 695 * 696 * 従来の システムリソースでのテーブルレイアウトの設定を廃止し、 697 * CSSファイルで、指定するように変更しています。 698 * これに伴い、CSSファイルのキーとして、クラス属性を出力します。 699 * view(または、出力されるtableタグ)のレイアウトは、このクラス属性で 700 * 指定することが可能になります。 701 * 初期値は、viewTable です。 702 * 703 * @og.rev 4.0.0.0 (2007/04/16) 新規追加 704 * 705 * @param cls class属性を表す文字列 706 */ 707 void setTableClass( String cls ) ; 708 709 /** 710 * 改廃Cのついていない行をスキップするかどうか指定します。 711 * 712 * "true" で、改廃Cのついた行をスキップします。 713 * 初期値はfalseです。 714 * 715 * @og.rev 4.3.1.0 (2008/09/08) 新規追加 716 * 717 * @param flag 改廃Cのついていない行をスキップするかどうか(true:スキップする/false:スキップしない) 718 */ 719 void setSkipNoEdit( boolean flag ) ; 720 721 /** 722 * 画面遷移なしモードに対応した形で処理を行うかを指定します。 723 * 724 * "true" で、画面遷移なしモードに対応します。 725 * 初期値はfalseです。 726 * 727 * @og.rev 4.3.3.0 (2008/10/01) 新規追加 728 * 729 * @param flag 画面遷移なしモードに対応するかどうか(true:対応する/false:対応しない) 730 */ 731 void setNoTransition( boolean flag ) ; 732 733 /** 734 * ビューで表示したカラムの一覧をCSV形式で返します。 735 * 736 * @og.rev 5.1.6.0 (2010/05/01) 新規追加 737 * 738 * @return ビューで表示したカラムの一覧 739 */ 740 String getViewClms() ; 741 742 /** 743 * 表示項目の編集(並び替え)が可能かどうかを返します。 744 * 745 * @og.rev 5.1.6.0 (2010/05/01) 新規追加 746 * 747 * @return 表示項目の編集(並び替え)が可能かどうか 748 */ 749 boolean isEditable() ; 750 751 /** 752 * このViewFormが作成された画面IDをセットします。 753 * 754 * @og.rev 5.1.7.0 (2010/06/01) 新規追加 755 * 756 * @param gamenId 画面ID 757 */ 758 void setGamenId( final String gamenId ); 759 760 /** 761 * このViewFormが作成された画面IDを返します。 762 * 763 * @og.rev 5.1.7.0 (2010/06/01) 新規追加 764 * 765 * @return 画面ID 766 */ 767 String getGamenId(); 768 769 /** 770 * 一括入力カラムのアシスト機能を利用するカラム名を、CSV形式で与えます。 771 * 772 * これは、カラムの書き込み時に、一括入力可能なカラムをヘッダーに表示し、 773 * 一括登録できる機能を提供します。 774 * この機能は、jsp/common/bulkUpdate.js JavaScript とともに提供されます。 775 * IE については、クリップボードも利用できます。Ctrl-C と Ctrl-V でそれぞれ 776 * 一連のカラムの値の取り出しと書き込みが可能になります。 777 * "*" を指定すると、すべてのカラムを(columnBulkSet)指定したことになります。 778 * 779 * @og.rev 5.2.1.0 (2010/10/01) 新規作成 780 * 781 * @param columnName 例:"OYA,KO,HJO,SU,DYSET,DYUPD" 782 */ 783 void setColumnBulkSet( final String columnName ); 784 785 /** 786 * このViewFormを作成するにあたり、区別するためのクラス属性をセットします。 787 * 788 * 通常は、viewForm より tableId を設定します。 789 * SplitViewTag を使用する場合は、左右分割のため、同じtableId になるため、 790 * 左右で異なるclassを設定してください。 791 * 792 * @og.rev 6.4.6.1 (2016/06/03) 新規追加 793 * 794 * @param clazz Viewのクラス属性 795 */ 796 void setViewClass( final String clazz ); 797}