tiles-jsp.tld 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!--
  3. /*
  4. * $Id: tiles-jsp.tld 521636 2007-03-23 09:12:34Z apetrelli $
  5. *
  6. * Licensed to the Apache Software Foundation (ASF) under one
  7. * or more contributor license agreements. See the NOTICE file
  8. * distributed with this work for additional information
  9. * regarding copyright ownership. The ASF licenses this file
  10. * to you under the Apache License, Version 2.0 (the
  11. * "License"); you may not use this file except in compliance
  12. * with the License. You may obtain a copy of the License at
  13. *
  14. * http://www.apache.org/licenses/LICENSE-2.0
  15. *
  16. * Unless required by applicable law or agreed to in writing,
  17. * software distributed under the License is distributed on an
  18. * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  19. * KIND, either express or implied. See the License for the
  20. * specific language governing permissions and limitations
  21. * under the License.
  22. */
  23. -->
  24. <!DOCTYPE taglib PUBLIC
  25. "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN"
  26. "http://java.sun.com/dtd/web-jsptaglibrary_1_2.dtd">
  27. <taglib>
  28. <tlib-version>2.0</tlib-version>
  29. <jsp-version>1.2</jsp-version>
  30. <short-name>tiles</short-name>
  31. <uri>http://tiles.apache.org/tags-tiles</uri>
  32. <description>
  33. <![CDATA[
  34. <p>This tag library provides Tiles tags.</p>
  35. ]]>
  36. </description>
  37. <tag>
  38. <name>insertTemplate</name>
  39. <tag-class>org.apache.tiles.jsp.taglib.InsertTemplateTag</tag-class>
  40. <body-content>JSP</body-content>
  41. <description>
  42. <![CDATA[
  43. <p><strong>Insert a template.</strong></p>
  44. <p>Insert a template with the possibility to pass
  45. parameters (called attributes).
  46. A template can be seen as a procedure that can take parameters or attributes.
  47. <code>&lt;tiles:insertTemplate&gt;</code> allows to define these attributes
  48. and pass them to the inserted jsp page, called template.
  49. Attributes are defined using nested tag <code>&lt;tiles:put&gt;</code> or
  50. <code>&lt;tiles:putList&gt;</code>.
  51. </p>
  52. <p>You must specify <li><code>template</code> attribute, for inserting a template</p>
  53. <p><strong>Example : </strong></p>
  54. <pre>
  55. <code>
  56. &lt;tiles:insertTemplate template="/basic/myLayout.jsp" flush="true">
  57. &lt;tiles:put name="title" value="My first page" />
  58. &lt;tiles:put name="header" value="/common/header.jsp" />
  59. &lt;tiles:put name="footer" value="/common/footer.jsp" />
  60. &lt;tiles:put name="menu" value="/basic/menu.jsp" />
  61. &lt;tiles:put name="body" value="/basic/helloBody.jsp" />
  62. &lt;/tiles:insert>
  63. </code>
  64. </pre>
  65. ]]>
  66. </description>
  67. <attribute>
  68. <name>template</name>
  69. <required>true</required>
  70. <rtexprvalue>true</rtexprvalue>
  71. <description>
  72. <![CDATA[
  73. <p>A string representing the URI of a template (for example, a JSP
  74. page).
  75. </p>
  76. ]]>
  77. </description>
  78. </attribute>
  79. <attribute>
  80. <name>flush</name>
  81. <required>false</required>
  82. <rtexprvalue>false</rtexprvalue>
  83. <type>boolean</type>
  84. <description>
  85. <![CDATA[
  86. <p>True or false. If true, current page out stream is flushed
  87. before insertion.</p>
  88. ]]>
  89. </description>
  90. </attribute>
  91. <attribute>
  92. <name>ignore</name>
  93. <required>false</required>
  94. <rtexprvalue>true</rtexprvalue>
  95. <type>boolean</type>
  96. <description>
  97. <![CDATA[
  98. <p>If this attribute is set to true, and the attribute specified by the
  99. name does not exist, simply return without writing anything. The
  100. default value is false, which will cause a runtime exception to be
  101. thrown.</p>
  102. ]]>
  103. </description>
  104. </attribute>
  105. <attribute>
  106. <name>role</name>
  107. <required>false</required>
  108. <rtexprvalue>true</rtexprvalue>
  109. <description>
  110. <![CDATA[
  111. <p>If the user is in the specified role, the tag is taken into account;
  112. otherwise, the tag is ignored (skipped).</p>
  113. ]]>
  114. </description>
  115. </attribute>
  116. <attribute>
  117. <name>preparer</name>
  118. <required>false</required>
  119. <rtexprvalue>true</rtexprvalue>
  120. <description>
  121. The fully qualified class name of the preparer.
  122. </description>
  123. </attribute>
  124. </tag>
  125. <tag>
  126. <name>insertDefinition</name>
  127. <tag-class>org.apache.tiles.jsp.taglib.InsertDefinitionTag</tag-class>
  128. <body-content>JSP</body-content>
  129. <description>
  130. <![CDATA[
  131. <p><strong>Insert a definition.</strong></p>
  132. <p>Insert a definition with the possibility to override and specify
  133. parameters (called attributes).
  134. A definition can be seen as a (partially or totally) filled template that
  135. can override or complete attribute values.
  136. <code>&lt;tiles:insertDefinition&gt;</code> allows to define these attributes
  137. and pass them to the inserted jsp page, called template.
  138. Attributes are defined using nested tag <code>&lt;tiles:put&gt;</code> or
  139. <code>&lt;tiles:putList&gt;</code>.
  140. </p>
  141. <p>You must specify <code>name</code> tag attribute, for inserting a definition from
  142. definitions factory.</p>
  143. <p><strong>Example : </strong></p>
  144. <pre>
  145. <code>
  146. &lt;tiles:insertDefinition name=".my.tiles.defininition flush="true">
  147. &lt;tiles:put name="title" value="My first page" />
  148. &lt;tiles:put name="header" value="/common/header.jsp" />
  149. &lt;tiles:put name="footer" value="/common/footer.jsp" />
  150. &lt;tiles:put name="menu" value="/basic/menu.jsp" />
  151. &lt;tiles:put name="body" value="/basic/helloBody.jsp" />
  152. &lt;/tiles:insertDefinition>
  153. </code>
  154. </pre>
  155. ]]>
  156. </description>
  157. <attribute>
  158. <name>name</name>
  159. <required>true</required>
  160. <rtexprvalue>true</rtexprvalue>
  161. <description>
  162. <![CDATA[
  163. <p>Name of the definition to insert.</p>
  164. ]]>
  165. </description>
  166. </attribute>
  167. <attribute>
  168. <name>flush</name>
  169. <required>false</required>
  170. <rtexprvalue>false</rtexprvalue>
  171. <type>boolean</type>
  172. <description>
  173. <![CDATA[
  174. <p>True or false. If true, current page out stream is flushed
  175. before insertion.</p>
  176. ]]>
  177. </description>
  178. </attribute>
  179. <attribute>
  180. <name>ignore</name>
  181. <required>false</required>
  182. <rtexprvalue>true</rtexprvalue>
  183. <type>boolean</type>
  184. <description>
  185. <![CDATA[
  186. <p>If this attribute is set to true, and the attribute specified by the
  187. name does not exist, simply return without writing anything. The
  188. default value is false, which will cause a runtime exception to be
  189. thrown.</p>
  190. ]]>
  191. </description>
  192. </attribute>
  193. <attribute>
  194. <name>role</name>
  195. <required>false</required>
  196. <rtexprvalue>true</rtexprvalue>
  197. <description>
  198. <![CDATA[
  199. <p>If the user is in the specified role, the tag is taken into account;
  200. otherwise, the tag is ignored (skipped).</p>
  201. ]]>
  202. </description>
  203. </attribute>
  204. <attribute>
  205. <name>preparer</name>
  206. <required>false</required>
  207. <rtexprvalue>true</rtexprvalue>
  208. <description>
  209. The fully qualified class name of preparer.
  210. </description>
  211. </attribute>
  212. </tag>
  213. <tag>
  214. <name>insertAttribute</name>
  215. <tag-class>org.apache.tiles.jsp.taglib.InsertAttributeTag</tag-class>
  216. <body-content>JSP</body-content>
  217. <description>
  218. <![CDATA[
  219. <p><strong>Inserts the value of an attribute into the page.</strong></p>
  220. <p>This tag can be flexibly used to insert the value of an attribute into a page.
  221. As in other usages in Tiles, every attribute can be determined to have a "type",
  222. either set explicitly when it was defined, or "computed". If the type is not explicit, then
  223. if the attribute value is a valid definition, it will be inserted as such. Otherwise,
  224. if it begins with a "/" character, it will be treated as a "template". Finally, if it
  225. has not otherwise been assigned a type, it will be treated as a String and included without
  226. any special handling.</p>
  227. <p><strong>Example : </strong></p>
  228. <pre>
  229. <code>
  230. <tiles:insertAttribute name="body">
  231. </code>
  232. </pre>
  233. ]]>
  234. </description>
  235. <attribute>
  236. <name>name</name>
  237. <required>false</required>
  238. <rtexprvalue>true</rtexprvalue>
  239. <description>
  240. <![CDATA[
  241. <p>Name of the attribute to insert. This attribute will be ignored if
  242. the <code>value</code> attribute is specified.</p>
  243. ]]>
  244. </description>
  245. </attribute>
  246. <attribute>
  247. <name>value</name>
  248. <required>false</required>
  249. <rtexprvalue>true</rtexprvalue>
  250. <description>
  251. <![CDATA[
  252. <p>Attribute object to render directly. If it specified, the <code>name</code>
  253. attribute will be ignored.</p>
  254. ]]>
  255. </description>
  256. </attribute>
  257. <attribute>
  258. <name>flush</name>
  259. <required>false</required>
  260. <rtexprvalue>false</rtexprvalue>
  261. <type>boolean</type>
  262. <description>
  263. <![CDATA[
  264. <p>True or false. If true, current page out stream is flushed
  265. before insertion.</p>
  266. ]]>
  267. </description>
  268. </attribute>
  269. <attribute>
  270. <name>ignore</name>
  271. <required>false</required>
  272. <rtexprvalue>true</rtexprvalue>
  273. <type>boolean</type>
  274. <description>
  275. <![CDATA[
  276. <p>If this attribute is set to true, and the attribute specified by the
  277. name does not exist, simply return without writing anything. The
  278. default value is false, which will cause a runtime exception to be
  279. thrown.</p>
  280. ]]>
  281. </description>
  282. </attribute>
  283. <attribute>
  284. <name>role</name>
  285. <required>false</required>
  286. <rtexprvalue>true</rtexprvalue>
  287. <description>
  288. <![CDATA[
  289. <p>If the user is in the specified role, the tag is taken into account;
  290. otherwise, the tag is ignored (skipped).</p>
  291. ]]>
  292. </description>
  293. </attribute>
  294. <attribute>
  295. <name>preparer</name>
  296. <required>false</required>
  297. <rtexprvalue>true</rtexprvalue>
  298. <description>
  299. The fully qualified name of the preparer.
  300. </description>
  301. </attribute>
  302. </tag>
  303. <tag>
  304. <name>definition</name>
  305. <tag-class>org.apache.tiles.jsp.taglib.definition.DefinitionTag</tag-class>
  306. <body-content>JSP</body-content>
  307. <description>
  308. <![CDATA[
  309. <p><strong>Create a template definition bean.
  310. </strong></p>
  311. <p>Create a template definition as a bean.
  312. Newly created bean will be saved under specified "id", in the requested "scope".
  313. Definition tag has same syntax as <code>insert</code></p>
  314. ]]>
  315. </description>
  316. <attribute>
  317. <name>name</name>
  318. <required>true</required>
  319. <rtexprvalue>true</rtexprvalue>
  320. <description>
  321. <![CDATA[
  322. <p>Specifies the name under which the newly created definition bean
  323. will be saved.</p>
  324. ]]>
  325. </description>
  326. </attribute>
  327. <attribute>
  328. <name>scope</name>
  329. <required>false</required>
  330. <rtexprvalue>false</rtexprvalue>
  331. <description>
  332. <![CDATA[
  333. <p>Specifies the variable scope into which the newly defined bean
  334. will be created.
  335. If not specified, the bean will be created in page scope.</p>
  336. ]]>
  337. </description>
  338. </attribute>
  339. <attribute>
  340. <name>template</name>
  341. <required>false</required>
  342. <rtexprvalue>true</rtexprvalue>
  343. <description>
  344. <![CDATA[
  345. <p>A string representing the URI of a template
  346. (a JSP page).</p>
  347. ]]>
  348. </description>
  349. </attribute>
  350. <attribute>
  351. <name>role</name>
  352. <required>false</required>
  353. <rtexprvalue>true</rtexprvalue>
  354. <description>
  355. <![CDATA[
  356. <p>Role to check before inserting this definition. If role is not
  357. defined for current user, definition is not inserted. Checking is
  358. done at insert time, not during definition process.</p>
  359. ]]>
  360. </description>
  361. </attribute>
  362. <attribute>
  363. <name>extends</name>
  364. <required>false</required>
  365. <rtexprvalue>true</rtexprvalue>
  366. <description>
  367. <![CDATA[
  368. <p>Name of a parent definition that is used to initialize this new
  369. definition. Parent definition is searched in definitions factory.</p>
  370. ]]>
  371. </description>
  372. </attribute>
  373. </tag>
  374. <tag>
  375. <name>putAttribute</name>
  376. <tag-class>org.apache.tiles.jsp.taglib.PutAttributeTag</tag-class>
  377. <body-content>JSP</body-content>
  378. <description>
  379. <![CDATA[
  380. <p><strong>Put an attribute in enclosing attribute container tag.</strong></p>
  381. <p>
  382. Enclosing attribute container tag can be :
  383. <ul>
  384. <li>&lt;initContainer&gt;</li>
  385. <li>&lt;definition&gt;</li>
  386. <li>&lt;insertAttribute&gt;</li>
  387. <li>&lt;insertDefinition&gt;</li>
  388. <li>&lt;putListAttribute&gt;</li>
  389. </ul>
  390. (or any other tag which implements the <code>{@link PutAttributeTagParent}</code> interface.
  391. Exception is thrown if no appropriate tag can be found.</p>
  392. <p>Put tag can have following atributes :
  393. <ul>
  394. <li>name : Name of the attribute</li>
  395. <li>value : value to put as attribute</li>
  396. <li>type : value type. Only valid if value is a String and is set by
  397. value="something" or by a bean.
  398. Possible type are : string (value is used as direct string),
  399. template (value is used as a page url to insert),
  400. definition (value is used as a definition name to insert)</li>
  401. <li>direct : Specify if value is to be used as a direct string or as a
  402. page url to insert. This is another way to specify the type. It only apply
  403. if value is set as a string, and type is not present.</li>
  404. <li>beanName : Name of a bean used for setting value. Only valid if value is not set.
  405. If property is specified, value come from bean's property. Otherwise, bean
  406. itself is used for value.</li>
  407. <li>beanProperty : Name of the property used for retrieving value.</li>
  408. <li>beanScope : Scope containing bean. </li>
  409. <li>role : Role to check when 'insert' will be called. If enclosing tag is
  410. &lt;insert&gt;, role is checked immediately. If enclosing tag is
  411. &lt;definition&gt;, role will be checked when this definition will be
  412. inserted.</li>
  413. </ul></p>
  414. <p>Value can also come from tag body. Tag body is taken into account only if
  415. value is not set by one of the tag attributes. In this case Attribute type is
  416. "string", unless tag body define another type.</p>
  417. ]]>
  418. </description>
  419. <attribute>
  420. <name>name</name>
  421. <required>true</required>
  422. <rtexprvalue>true</rtexprvalue>
  423. <description>
  424. <![CDATA[
  425. <p>Name of the attribute.</p>
  426. ]]>
  427. </description>
  428. </attribute>
  429. <attribute>
  430. <name>value</name>
  431. <required>false</required>
  432. <rtexprvalue>true</rtexprvalue>
  433. <description>
  434. <![CDATA[
  435. <p>Attribute value. Could be a String or an Object.
  436. Value can come from a direct assignment (value="aValue") or from a bean.
  437. One of 'value' 'content' or 'beanName' must be present.</p>
  438. ]]>
  439. </description>
  440. </attribute>
  441. <attribute>
  442. <name>type</name>
  443. <required>false</required>
  444. <rtexprvalue>false</rtexprvalue>
  445. <description>
  446. <![CDATA[
  447. <p>Specify content type: string, template or definition.</p>
  448. <ul>
  449. <li>String : Content is printed directly.</li>
  450. <li>template : Content is included from specified URL. Value is used as an URL.</li>
  451. <li>definition : Value is the name of a definition defined in factory (xml file). Definition will be searched
  452. in the inserted tile, in a <code>&lt;tiles:insert attribute="attributeName"&gt;</code> tag, where 'attributeName'
  453. is the name used for this tag.</li>
  454. </ul>
  455. ]]>
  456. </description>
  457. </attribute>
  458. <attribute>
  459. <name>role</name>
  460. <required>false</required>
  461. <rtexprvalue>true</rtexprvalue>
  462. <description>
  463. <![CDATA[
  464. <p>
  465. If the user is in the specified role, the tag is taken into account;
  466. otherwise, the tag is ignored (skipped).
  467. </p>
  468. ]]>
  469. </description>
  470. </attribute>
  471. </tag>
  472. <tag>
  473. <name>putListAttribute</name>
  474. <tag-class>org.apache.tiles.jsp.taglib.PutListAttributeTag</tag-class>
  475. <body-content>JSP</body-content>
  476. <description>
  477. <![CDATA[
  478. <p><strong>Declare a list that will be pass as attribute to tile.
  479. </strong></p>
  480. <p>Declare a list that will be pass as attribute to tile.
  481. List elements are added using the tag 'add'.
  482. This tag can only be used inside 'insert' or 'definition' tag.</p>
  483. ]]>
  484. </description>
  485. <attribute>
  486. <name>name</name>
  487. <required>true</required>
  488. <rtexprvalue>true</rtexprvalue>
  489. <description>
  490. <![CDATA[
  491. <p>Name of the list.</p>
  492. ]]>
  493. </description>
  494. </attribute>
  495. </tag>
  496. <tag>
  497. <name>addAttribute</name>
  498. <!--
  499. Intentionally PutTag, it doubles for the AddTag
  500. The only difference between the two is that the name
  501. is not used in the Add Tag (and it's only valid within
  502. the PutList
  503. -->
  504. <tag-class>org.apache.tiles.jsp.taglib.AddAttributeTag</tag-class>
  505. <body-content>JSP</body-content>
  506. <description>
  507. <![CDATA[
  508. <p><strong>Add an element to the surrounding list.
  509. Equivalent to 'put', but for list element.</strong></p>
  510. <p>Add an element to the surrounding list.
  511. This tag can only be used inside putList tag.
  512. Value can come from a direct assignment (value="aValue") or from a bean.
  513. One of 'value' or 'beanName' must be present.</p>
  514. ]]>
  515. </description>
  516. <attribute>
  517. <name>value</name>
  518. <required>false</required>
  519. <rtexprvalue>true</rtexprvalue>
  520. <description>
  521. <![CDATA[
  522. <p>Attribute value. Can be a String or Object.</p>
  523. ]]>
  524. </description>
  525. </attribute>
  526. <attribute>
  527. <name>type</name>
  528. <required>false</required>
  529. <rtexprvalue>false</rtexprvalue>
  530. <description>
  531. <![CDATA[
  532. <p>Specify content type: string, template or definition.</p>
  533. <ul>
  534. <li>String : Content is printed directly.</li>
  535. <li>template : Content is included from specified URL. Value is used as an URL.</li>
  536. <li>definition : Value denote a definition defined in factory (xml file). Definition will be searched
  537. in the inserted tile, in a <code>&lt;insert attribute="attributeName"&gt;</code> tag, where 'attributeName'
  538. is the name used for this tag.</li>
  539. </ul>
  540. ]]>
  541. </description>
  542. </attribute>
  543. <attribute>
  544. <name>role</name>
  545. <required>false</required>
  546. <rtexprvalue>true</rtexprvalue>
  547. <description>
  548. <![CDATA[
  549. <p>If the user is in the specified role, the tag is taken into account;
  550. otherwise, the tag is ignored (skipped).</p>
  551. <p>The role isn't taken into account if <code>&lt;add&gt;</code>
  552. tag is used in a definition.</p>
  553. ]]>
  554. </description>
  555. </attribute>
  556. </tag>
  557. <tag>
  558. <name>addListAttribute</name>
  559. <tag-class>org.apache.tiles.jsp.taglib.AddListAttributeTag</tag-class>
  560. <body-content>JSP</body-content>
  561. <description>
  562. <![CDATA[
  563. <p><strong>Declare a list that will be pass as attribute to tile.
  564. </strong></p>
  565. <p>Declare a list that will be pass as attribute to tile.
  566. List elements are added using the tag 'add'.
  567. This tag can only be used inside 'insert' or 'definition' tag.</p>
  568. ]]>
  569. </description>
  570. </tag>
  571. <tag>
  572. <name>getAsString</name>
  573. <tag-class>org.apache.tiles.jsp.taglib.GetAsStringTag</tag-class>
  574. <body-content>empty</body-content>
  575. <description>
  576. <![CDATA[
  577. <p><strong>
  578. Render the value of the specified template attribute to the current JspWriter
  579. </strong></p>
  580. <p>Retrieve the value of the specified template attribute
  581. property, and render it to the current JspWriter as a String.
  582. The usual toString() conversions is applied on found value.</p>
  583. <p>Throw a JSPException if named value is not found.</p>
  584. ]]>
  585. </description>
  586. <attribute>
  587. <name>name</name>
  588. <required>true</required>
  589. <rtexprvalue>true</rtexprvalue>
  590. <description>
  591. <![CDATA[
  592. <p>Attribute name.</p>
  593. ]]>
  594. </description>
  595. </attribute>
  596. <attribute>
  597. <name>ignore</name>
  598. <required>false</required>
  599. <rtexprvalue>true</rtexprvalue>
  600. <type>boolean</type>
  601. <description>
  602. <![CDATA[
  603. <p>
  604. If this attribute is set to true, and the attribute specified by the name
  605. does not exist, simply return without writing anything. The default value is false, which will
  606. cause a runtime exception to be thrown.
  607. </p>
  608. ]]>
  609. </description>
  610. </attribute>
  611. <attribute>
  612. <name>role</name>
  613. <required>false</required>
  614. <rtexprvalue>true</rtexprvalue>
  615. <description>
  616. <![CDATA[
  617. <p>
  618. If the user is in the specified role, the tag is taken into account;
  619. otherwise, the tag is ignored (skipped).
  620. </p>
  621. ]]>
  622. </description>
  623. </attribute>
  624. </tag>
  625. <tag>
  626. <name>useAttribute</name>
  627. <tag-class>org.apache.tiles.jsp.taglib.UseAttributeTag</tag-class>
  628. <tei-class>org.apache.tiles.jsp.taglib.UseAttributeTag$Tei</tei-class>
  629. <body-content>empty</body-content>
  630. <description>
  631. <![CDATA[
  632. <p><strong>Use attribute value inside page.</strong></p>
  633. <p>Declare a Java variable, and an attribute in the specified scope,
  634. using tile attribute value.</p>
  635. <p>Java variable and attribute will have the name specified by 'id',
  636. or the original name if not specified.</p>
  637. ]]>
  638. </description>
  639. <attribute>
  640. <name>id</name>
  641. <required>false</required>
  642. <rtexprvalue>true</rtexprvalue>
  643. <description>
  644. <![CDATA[
  645. <p>Declared attribute and variable name.</p>
  646. ]]>
  647. </description>
  648. </attribute>
  649. <attribute>
  650. <name>classname</name>
  651. <required>false</required>
  652. <rtexprvalue>true</rtexprvalue>
  653. <description>
  654. <![CDATA[
  655. <p>Class of the declared variable.</p>
  656. ]]>
  657. </description>
  658. </attribute>
  659. <attribute>
  660. <name>scope</name>
  661. <required>false</required>
  662. <rtexprvalue>false</rtexprvalue>
  663. <description>
  664. <![CDATA[
  665. <p>Scope of the declared attribute. Default to 'page'.</p>
  666. ]]>
  667. </description>
  668. </attribute>
  669. <attribute>
  670. <name>name</name>
  671. <required>true</required>
  672. <rtexprvalue>true</rtexprvalue>
  673. <description>
  674. <![CDATA[
  675. <p>Tile's attribute name.</p>
  676. ]]>
  677. </description>
  678. </attribute>
  679. <attribute>
  680. <name>ignore</name>
  681. <required>false</required>
  682. <rtexprvalue>true</rtexprvalue>
  683. <type>boolean</type>
  684. <description>
  685. <![CDATA[
  686. <p>
  687. If this attribute is set to true, and the attribute specified by the name
  688. does not exist, simply return without error. The default value is false, which will
  689. cause a runtime exception to be thrown.
  690. </p>
  691. ]]>
  692. </description>
  693. </attribute>
  694. </tag>
  695. <tag>
  696. <name>importAttribute</name>
  697. <tag-class>org.apache.tiles.jsp.taglib.ImportAttributeTag</tag-class>
  698. <body-content>empty</body-content>
  699. <description>
  700. <![CDATA[
  701. <p><strong>Import Tile's attribute in specified context.</strong></p>
  702. <p>Import attribute from tile to requested scope.
  703. Attribute name and scope are optional. If not specified, all tile
  704. attributes are imported in page scope.
  705. Once imported, an attribute can be used as any other beans from jsp
  706. contexts.</p>
  707. ]]>
  708. </description>
  709. <attribute>
  710. <name>name</name>
  711. <required>false</required>
  712. <rtexprvalue>true</rtexprvalue>
  713. <description>
  714. <![CDATA[
  715. <p>Tile's attribute name. If not specified, all attributes are
  716. imported.</p>
  717. ]]>
  718. </description>
  719. </attribute>
  720. <attribute>
  721. <name>toName</name>
  722. <required>false</required>
  723. <rtexprvalue>true</rtexprvalue>
  724. <description>
  725. <![CDATA[
  726. <p>Name of the destination attribute. If not specified, the name will
  727. be the same as specified in <code>name</code> attribute</p>
  728. ]]>
  729. </description>
  730. </attribute>
  731. <attribute>
  732. <name>scope</name>
  733. <required>false</required>
  734. <rtexprvalue>false</rtexprvalue>
  735. <description>
  736. <![CDATA[
  737. <p>Scope into which attribute is imported. Default to page.</p>
  738. ]]>
  739. </description>
  740. </attribute>
  741. <attribute>
  742. <name>ignore</name>
  743. <required>false</required>
  744. <rtexprvalue>true</rtexprvalue>
  745. <type>boolean</type>
  746. <description>
  747. <![CDATA[
  748. <p>If this attribute is set to true, and the attribute specified by
  749. the name does not exist, simply return without error. The default
  750. value is false, which will cause a runtime exception to be thrown.</p>
  751. ]]>
  752. </description>
  753. </attribute>
  754. </tag>
  755. <tag>
  756. <name>initContainer</name>
  757. <tag-class>org.apache.tiles.jsp.taglib.definition.InitContainerTag</tag-class>
  758. <body-content>JSP</body-content>
  759. <description>
  760. <![CDATA[
  761. <p><strong>Initialize the TilesContainer.</strong></p>
  762. <p>
  763. In order to use the Tiles system, a TilesContainer must be instantiated.
  764. This initialization is generally done by the TilesListener (or perhaps the
  765. TilesServlet or TilesFilter).
  766. </p>
  767. <p>
  768. If the intialization needs to be dynamic, you can initialize the container using
  769. this tag. Realize however, that this tag MUST be executed prior to invoking
  770. any other definitions. Additionally, the initilization may only be done once,
  771. and any subsequent invocations will be ignored.
  772. </p>
  773. ]]>
  774. </description>
  775. <attribute>
  776. <name>containerFactory</name>
  777. <required>false</required>
  778. <rtexprvalue>true</rtexprvalue>
  779. <description> <![CDATA[ <p>Container Factory implementation used to instantiate the container.</p> ]]> </description>
  780. </attribute>
  781. </tag>
  782. <tag>
  783. <name>destroyContainer</name>
  784. <tag-class>org.apache.tiles.jsp.taglib.definition.DestroyContainerTag</tag-class>
  785. <body-content>empty</body-content>
  786. <description>
  787. <![CDATA[
  788. <p><strong>Destroy the TilesContainer.</strong></p>
  789. ]]>
  790. </description>
  791. </tag>
  792. </taglib>