Jaxcel/doc/org/hanei/jaxcel/parser/ForeachParser.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
   2 <!-- NewPage -->\r
   3 <html lang="ja">\r
   4 <head>\r
   5 <!-- Generated by javadoc (version 1.7.0_25) on Thu Dec 18 02:26:11 JST 2014 -->\r
   6 <meta http-equiv="Content-Type" content="text/html" charset="utf-8">\r
   7 <title>ForeachParser</title>\r
   8 <meta name="date" content="2014-12-18">\r
   9 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">\r
  10 </head>\r
  11 <body>\r
  12 <script type="text/javascript"><!--\r
  13     if (location.href.indexOf('is-external=true') == -1) {\r
  14         parent.document.title="ForeachParser";\r
  15     }\r
  16 //-->\r
  17 </script>\r
  18 <noscript>\r
  19 <div>ブラウザのJavaScriptが無効になっています。</div>\r
  20 </noscript>\r
  21 <!-- ========= START OF TOP NAVBAR ======= -->\r
  22 <div class="topNav"><a name="navbar_top">\r
  23 <!--   -->\r
  24 </a><a href="#skip-navbar_top" title="ナビゲーション・リンクをスキップ"></a><a name="navbar_top_firstrow">\r
  25 <!--   -->\r
  26 </a>\r
  27 <ul class="navList" title="ナビゲーション">\r
  28 <li><a href="../../../../overview-summary.html">概要</a></li>\r
  29 <li><a href="package-summary.html">パッケージ</a></li>\r
  30 <li class="navBarCell1Rev">クラス</li>\r
  31 <li><a href="class-use/ForeachParser.html">使用</a></li>\r
  32 <li><a href="package-tree.html">階層ツリー</a></li>\r
  33 <li><a href="../../../../deprecated-list.html">非推奨</a></li>\r
  34 <li><a href="../../../../index-files/index-1.html">索引</a></li>\r
  35 <li><a href="../../../../help-doc.html">ヘルプ</a></li>\r
  36 </ul>\r
  37 </div>\r
  38 <div class="subNav">\r
  39 <ul class="navList">\r
  40 <li><a href="../../../../org/hanei/jaxcel/parser/ELParser.html" title="org.hanei.jaxcel.parser内のクラス"><span class="strong">前のクラス</span></a></li>\r
  41 <li><a href="../../../../org/hanei/jaxcel/parser/IfParser.html" title="org.hanei.jaxcel.parser内のクラス"><span class="strong">次のクラス</span></a></li>\r
  42 </ul>\r
  43 <ul class="navList">\r
  44 <li><a href="../../../../index.html?org/hanei/jaxcel/parser/ForeachParser.html" target="_top">フレーム</a></li>\r
  45 <li><a href="ForeachParser.html" target="_top">フレームなし</a></li>\r
  46 </ul>\r
  47 <ul class="navList" id="allclasses_navbar_top">\r
  48 <li><a href="../../../../allclasses-noframe.html">すべてのクラス</a></li>\r
  49 </ul>\r
  50 <div>\r
  51 <script type="text/javascript"><!--\r
  52   allClassesLink = document.getElementById("allclasses_navbar_top");\r
  53   if(window==top) {\r
  54     allClassesLink.style.display = "block";\r
  55   }\r
  56   else {\r
  57     allClassesLink.style.display = "none";\r
  58   }\r
  59   //-->\r
  60 </script>\r
  61 </div>\r
  62 <div>\r
  63 <ul class="subNavList">\r
  64 <li>概要:&nbsp;</li>\r
  65 <li>ネスト&nbsp;|&nbsp;</li>\r
  66 <li><a href="#fields_inherited_from_class_org.hanei.jaxcel.parser.AbstractTLParser">フィールド</a>&nbsp;|&nbsp;</li>\r
  67 <li><a href="#constructor_summary">コンストラクタ</a>&nbsp;|&nbsp;</li>\r
  68 <li><a href="#method_summary">メソッド</a></li>\r
  69 </ul>\r
  70 <ul class="subNavList">\r
  71 <li>詳細:&nbsp;</li>\r
  72 <li>フィールド&nbsp;|&nbsp;</li>\r
  73 <li><a href="#constructor_detail">コンストラクタ</a>&nbsp;|&nbsp;</li>\r
  74 <li><a href="#method_detail">メソッド</a></li>\r
  75 </ul>\r
  76 </div>\r
  77 <a name="skip-navbar_top">\r
  78 <!--   -->\r
  79 </a></div>\r
  80 <!-- ========= END OF TOP NAVBAR ========= -->\r
  81 <!-- ======== START OF CLASS DATA ======== -->\r
  82 <div class="header">\r
  83 <div class="subTitle">org.hanei.jaxcel.parser</div>\r
  84 <h2 title="クラス ForeachParser" class="title">クラス ForeachParser</h2>\r
  85 </div>\r
  86 <div class="contentContainer">\r
  87 <ul class="inheritance">\r
  88 <li>java.lang.Object</li>\r
  89 <li>\r
  90 <ul class="inheritance">\r
  91 <li><a href="../../../../org/hanei/jaxcel/parser/AbstractTLParser.html" title="org.hanei.jaxcel.parser内のクラス">org.hanei.jaxcel.parser.AbstractTLParser</a></li>\r
  92 <li>\r
  93 <ul class="inheritance">\r
  94 <li>org.hanei.jaxcel.parser.ForeachParser</li>\r
  95 </ul>\r
  96 </li>\r
  97 </ul>\r
  98 </li>\r
  99 </ul>\r
 100 <div class="description">\r
 101 <ul class="blockList">\r
 102 <li class="blockList">\r
 103 <dl>\r
 104 <dt>すべての実装されたインタフェース:</dt>\r
 105 <dd><a href="../../../../org/hanei/jaxcel/parser/TLParser.html" title="org.hanei.jaxcel.parser内のインタフェース">TLParser</a></dd>\r
 106 </dl>\r
 107 <hr>\r
 108 <br>\r
 109 <pre>public class <span class="strong">ForeachParser</span>\r
 110 extends <a href="../../../../org/hanei/jaxcel/parser/AbstractTLParser.html" title="org.hanei.jaxcel.parser内のクラス">AbstractTLParser</a></pre>\r
 111 <div class="block">foreach句のパーサー実装<br>
 112
 113  <h4>テンプレートの書式</h4>
 114  <h5>#foreach(${object in aryObject}[ rows:"number"][ cols:"number"][ direction:"row|col"][ style:"copy|^copy"][ shift:"true|false"][ block:"true|false"][ start:"number"][ end:"number"])</h5>
 115  <p>foreach句。配列やListオブジェクト、Mapオブジェクトの繰返し出力を行う。<br>
 116  プロパティにより、繰返し出力方向の指定や、繰返し回数、出力範囲以降のセルのシフト方法等を指定可能。</p>
 117  <table border="1" cellspacing="1">
 118  <tr><th>属性</th><th>説明</th></tr>
 119  <tr>
 120                 <td>${object in aryObject}</td>
 121                 <td>"${" 要素オブジェクト in 配列オブジェクト "}" のフォーマットで指定する。配列オブジェクトには配列、List、Mapが使用可能。<br>
 122                 rows・colsオプションで指定した範囲内で、要素オブジェクトで指定した名称で各インデックスの要素が出力可能。</td>
 123  </tr>
 124  <tr>
 125                 <td>rows</td>
 126                 <td>繰返し元の行数を正の整数で指定する。"1"指定で#foreach指示子が記述された行のみとなる。省略すると規定値である "1"となる。</td>
 127  </tr>
 128  <tr>
 129                 <td>cols</td>
 130                 <td>繰返し元の列数を正の整数で指定する。"1"指定で#foreach指示子が記述された列のみとなる。省略すると規定値である "1"となる。</td>
 131  </tr>
 132  <tr>
 133                 <td>direction</td>
 134                 <td>繰返し処理の方向を指定する。省略すると規定値である"row"となる。<br>
 135                 <table>
 136                 <tr><td>row</td><td>行方向に繰返す。</td></tr>
 137                 <tr><td>col</td><td>列方向に繰返す。</td></tr>
 138                 </table></td>
 139  </tr>
 140  <tr>
 141                 <td>style</td>
 142                 <td>繰返し元範囲(rows・colsオプションで指定する範囲)のセルスタイルのコピーについて指定する。省略すると規定値である"copy"となる。<br>
 143                 <table>
 144                 <tr><td>copy</td><td>セルスタイルをコピーする。</td></tr>
 145                 <tr><td>copy以外</td><td>セルスタイルをコピーしない。</td></tr>
 146                 </table></td>
 147  </tr>
 148  <tr>
 149                 <td>shift</td>
 150                 <td>繰返し範囲より後方の範囲のシフト方法について指定する。省略すると規定値である"true"となる。<br>
 151                 <table>
 152                 <tr><td>true</td><td>繰返し範囲より後方の範囲をdirectionオプションで指定した方向にシフトする。</td></tr>
 153                 <tr><td>false</td><td>シフトしない。</td></tr>
 154                 </table></td>
 155  </tr>
 156  <tr>
 157                 <td>block</td>
 158                 <td>矩形範囲での繰返し処理を行うかについて指定する。省略すると規定値である"true"となる。<br>
 159                 <table>
 160                 <tr><td>true</td><td>繰返し範囲を矩形範囲(rows・colsオプションで指定する範囲)とする。</td></tr>
 161                 <tr><td>false</td><td>繰返し範囲を繰返し元範囲に含まれる行・列全体とする。<br>
 162                 directionオプションが"row"の場合、繰返し元範囲に含まれる行全体が繰返し範囲となる。<br>
 163                 directionオプションが"col"の場合、繰返し元範囲に含まれる列全体が繰返し範囲となる。</td></tr>
 164                 </table></td>
 165  </tr>
 166  <tr>
 167                 <td>start</td>
 168                 <td>配列オブジェクトの出力開始インデックス(1起点)を正の整数、もしくは、正の整数を返却する関数で指定する。省略すると規定値である"1"となる。</td>
 169  </tr>
 170  <tr>
 171                 <td>end</td>
 172                 <td>配列オブジェクトの出力終了インデックス(1起点)を正の整数、もしくは、正の整数を返却する関数で指定する。省略すると配列オブジェクトの要素数となる。</td>
 173  </tr>
 174  <tr>
 175                 <td colspan="2">startオプションよりendオプションの指定値が小さい場合、配列オブジェクトを降順で出力する。<br>
 176                 配列オブジェクトの要素数は"size(配列オブジェクト)"関数で取得可能。</td>
 177  </tr>
 178  </table></div>\r
 179 <dl><dt><span class="strong">導入されたバージョン:</span></dt>\r
 180   <dd>1.01.00</dd>\r
 181 <dt><span class="strong">作成者:</span></dt>\r
 182   <dd>Noboru Saito</dd></dl>\r
 183 </li>\r
 184 </ul>\r
 185 </div>\r
 186 <div class="summary">\r
 187 <ul class="blockList">\r
 188 <li class="blockList">\r
 189 <!-- =========== FIELD SUMMARY =========== -->\r
 190 <ul class="blockList">\r
 191 <li class="blockList"><a name="field_summary">\r
 192 <!--   -->\r
 193 </a>\r
 194 <h3>フィールドの概要</h3>\r
 195 <ul class="blockList">\r
 196 <li class="blockList"><a name="fields_inherited_from_class_org.hanei.jaxcel.parser.AbstractTLParser">\r
 197 <!--   -->\r
 198 </a>\r
 199 <h3>クラスから継承されたフィールド&nbsp;org.hanei.jaxcel.parser.<a href="../../../../org/hanei/jaxcel/parser/AbstractTLParser.html" title="org.hanei.jaxcel.parser内のクラス">AbstractTLParser</a></h3>\r
 200 <code><a href="../../../../org/hanei/jaxcel/parser/AbstractTLParser.html#log">log</a></code></li>\r
 201 </ul>\r
 202 </li>\r
 203 </ul>\r
 204 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
 205 <ul class="blockList">\r
 206 <li class="blockList"><a name="constructor_summary">\r
 207 <!--   -->\r
 208 </a>\r
 209 <h3>コンストラクタの概要</h3>\r
 210 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="コンストラクタの概要表、コンストラクタのリストおよび説明">\r
 211 <caption><span>コンストラクタ</span><span class="tabEnd">&nbsp;</span></caption>\r
 212 <tr>\r
 213 <th class="colOne" scope="col">コンストラクタと説明</th>\r
 214 </tr>\r
 215 <tr class="altColor">\r
 216 <td class="colOne"><code><strong><a href="../../../../org/hanei/jaxcel/parser/ForeachParser.html#ForeachParser()">ForeachParser</a></strong>()</code>&nbsp;</td>\r
 217 </tr>\r
 218 </table>\r
 219 </li>\r
 220 </ul>\r
 221 <!-- ========== METHOD SUMMARY =========== -->\r
 222 <ul class="blockList">\r
 223 <li class="blockList"><a name="method_summary">\r
 224 <!--   -->\r
 225 </a>\r
 226 <h3>メソッドの概要</h3>\r
 227 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="メソッドの概要表、メソッドのリストおよび説明">\r
 228 <caption><span>メソッド</span><span class="tabEnd">&nbsp;</span></caption>\r
 229 <tr>\r
 230 <th class="colFirst" scope="col">修飾子とタイプ</th>\r
 231 <th class="colLast" scope="col">メソッドと説明</th>\r
 232 </tr>\r
 233 <tr class="altColor">\r
 234 <td class="colFirst"><code>void</code></td>\r
 235 <td class="colLast"><code><strong><a href="../../../../org/hanei/jaxcel/parser/ForeachParser.html#parse(org.hanei.jaxcel.report.JaxcelContext)">parse</a></strong>(<a href="../../../../org/hanei/jaxcel/report/JaxcelContext.html" title="org.hanei.jaxcel.report内のクラス">JaxcelContext</a>&nbsp;context)</code>\r
 236 <div class="block">対象セルのテンプレート指示子をパースする</div>\r
 237 </td>\r
 238 </tr>\r
 239 </table>\r
 240 <ul class="blockList">\r
 241 <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">\r
 242 <!--   -->\r
 243 </a>\r
 244 <h3>クラスから継承されたメソッド&nbsp;java.lang.Object</h3>\r
 245 <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>\r
 246 </ul>\r
 247 </li>\r
 248 </ul>\r
 249 </li>\r
 250 </ul>\r
 251 </div>\r
 252 <div class="details">\r
 253 <ul class="blockList">\r
 254 <li class="blockList">\r
 255 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
 256 <ul class="blockList">\r
 257 <li class="blockList"><a name="constructor_detail">\r
 258 <!--   -->\r
 259 </a>\r
 260 <h3>コンストラクタの詳細</h3>\r
 261 <a name="ForeachParser()">\r
 262 <!--   -->\r
 263 </a>\r
 264 <ul class="blockListLast">\r
 265 <li class="blockList">\r
 266 <h4>ForeachParser</h4>\r
 267 <pre>public&nbsp;ForeachParser()</pre>\r
 268 </li>\r
 269 </ul>\r
 270 </li>\r
 271 </ul>\r
 272 <!-- ============ METHOD DETAIL ========== -->\r
 273 <ul class="blockList">\r
 274 <li class="blockList"><a name="method_detail">\r
 275 <!--   -->\r
 276 </a>\r
 277 <h3>メソッドの詳細</h3>\r
 278 <a name="parse(org.hanei.jaxcel.report.JaxcelContext)">\r
 279 <!--   -->\r
 280 </a>\r
 281 <ul class="blockListLast">\r
 282 <li class="blockList">\r
 283 <h4>parse</h4>\r
 284 <pre>public&nbsp;void&nbsp;parse(<a href="../../../../org/hanei/jaxcel/report/JaxcelContext.html" title="org.hanei.jaxcel.report内のクラス">JaxcelContext</a>&nbsp;context)</pre>\r
 285 <div class="block"><strong>インタフェースからコピーされた説明:&nbsp;<code><a href="../../../../org/hanei/jaxcel/parser/TLParser.html#parse(org.hanei.jaxcel.report.JaxcelContext)">TLParser</a></code></strong></div>\r
 286 <div class="block">対象セルのテンプレート指示子をパースする</div>\r
 287 <dl>\r
 288 <dt><strong>定義:</strong></dt>\r
 289 <dd><code><a href="../../../../org/hanei/jaxcel/parser/TLParser.html#parse(org.hanei.jaxcel.report.JaxcelContext)">parse</a></code>&nbsp;インタフェース内&nbsp;<code><a href="../../../../org/hanei/jaxcel/parser/TLParser.html" title="org.hanei.jaxcel.parser内のインタフェース">TLParser</a></code></dd>\r
 290 <dt><strong>定義:</strong></dt>\r
 291 <dd><code><a href="../../../../org/hanei/jaxcel/parser/AbstractTLParser.html#parse(org.hanei.jaxcel.report.JaxcelContext)">parse</a></code>&nbsp;クラス内&nbsp;<code><a href="../../../../org/hanei/jaxcel/parser/AbstractTLParser.html" title="org.hanei.jaxcel.parser内のクラス">AbstractTLParser</a></code></dd>\r
 292 </dl>\r
 293 </li>\r
 294 </ul>\r
 295 </li>\r
 296 </ul>\r
 297 </li>\r
 298 </ul>\r
 299 </div>\r
 300 </div>\r
 301 <!-- ========= END OF CLASS DATA ========= -->\r
 302 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 303 <div class="bottomNav"><a name="navbar_bottom">\r
 304 <!--   -->\r
 305 </a><a href="#skip-navbar_bottom" title="ナビゲーション・リンクをスキップ"></a><a name="navbar_bottom_firstrow">\r
 306 <!--   -->\r
 307 </a>\r
 308 <ul class="navList" title="ナビゲーション">\r
 309 <li><a href="../../../../overview-summary.html">概要</a></li>\r
 310 <li><a href="package-summary.html">パッケージ</a></li>\r
 311 <li class="navBarCell1Rev">クラス</li>\r
 312 <li><a href="class-use/ForeachParser.html">使用</a></li>\r
 313 <li><a href="package-tree.html">階層ツリー</a></li>\r
 314 <li><a href="../../../../deprecated-list.html">非推奨</a></li>\r
 315 <li><a href="../../../../index-files/index-1.html">索引</a></li>\r
 316 <li><a href="../../../../help-doc.html">ヘルプ</a></li>\r
 317 </ul>\r
 318 </div>\r
 319 <div class="subNav">\r
 320 <ul class="navList">\r
 321 <li><a href="../../../../org/hanei/jaxcel/parser/ELParser.html" title="org.hanei.jaxcel.parser内のクラス"><span class="strong">前のクラス</span></a></li>\r
 322 <li><a href="../../../../org/hanei/jaxcel/parser/IfParser.html" title="org.hanei.jaxcel.parser内のクラス"><span class="strong">次のクラス</span></a></li>\r
 323 </ul>\r
 324 <ul class="navList">\r
 325 <li><a href="../../../../index.html?org/hanei/jaxcel/parser/ForeachParser.html" target="_top">フレーム</a></li>\r
 326 <li><a href="ForeachParser.html" target="_top">フレームなし</a></li>\r
 327 </ul>\r
 328 <ul class="navList" id="allclasses_navbar_bottom">\r
 329 <li><a href="../../../../allclasses-noframe.html">すべてのクラス</a></li>\r
 330 </ul>\r
 331 <div>\r
 332 <script type="text/javascript"><!--\r
 333   allClassesLink = document.getElementById("allclasses_navbar_bottom");\r
 334   if(window==top) {\r
 335     allClassesLink.style.display = "block";\r
 336   }\r
 337   else {\r
 338     allClassesLink.style.display = "none";\r
 339   }\r
 340   //-->\r
 341 </script>\r
 342 </div>\r
 343 <div>\r
 344 <ul class="subNavList">\r
 345 <li>概要:&nbsp;</li>\r
 346 <li>ネスト&nbsp;|&nbsp;</li>\r
 347 <li><a href="#fields_inherited_from_class_org.hanei.jaxcel.parser.AbstractTLParser">フィールド</a>&nbsp;|&nbsp;</li>\r
 348 <li><a href="#constructor_summary">コンストラクタ</a>&nbsp;|&nbsp;</li>\r
 349 <li><a href="#method_summary">メソッド</a></li>\r
 350 </ul>\r
 351 <ul class="subNavList">\r
 352 <li>詳細:&nbsp;</li>\r
 353 <li>フィールド&nbsp;|&nbsp;</li>\r
 354 <li><a href="#constructor_detail">コンストラクタ</a>&nbsp;|&nbsp;</li>\r
 355 <li><a href="#method_detail">メソッド</a></li>\r
 356 </ul>\r
 357 </div>\r
 358 <a name="skip-navbar_bottom">\r
 359 <!--   -->\r
 360 </a></div>\r
 361 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 362 </body>\r
 363 </html>\r