birt.tld 33 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157
  1. <?xml version='1.0' encoding='ISO-8859-1' ?>
  2. <!DOCTYPE taglib
  3. PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN"
  4. "http://java.sun.com/dtd/web-jsptaglibrary_1_2.dtd">
  5. <taglib>
  6. <tlib-version>1.0</tlib-version>
  7. <jsp-version>1.2</jsp-version>
  8. <short-name>BIRT Tag Library</short-name>
  9. <uri>http://www.eclipse.org/birt/taglibs/birt.tld</uri>
  10. <description>
  11. This Tag Library makes user develope JSP with BIRT Viewer component easily.
  12. </description>
  13. <!--**********************************************-->
  14. <!-- Viewer Tag -->
  15. <!--**********************************************-->
  16. <tag>
  17. <name>viewer</name>
  18. <tag-class>org.eclipse.birt.report.taglib.ViewerTag</tag-class>
  19. <body-content>JSP</body-content>
  20. <description>
  21. The viewer tag is to specify how to import and control BIRT Report Viewer into JSP page.
  22. This tag will use Ajax framework to retrieve report content.
  23. </description>
  24. <attribute>
  25. <name>id</name>
  26. <required>true</required>
  27. <rtexprvalue>true</rtexprvalue>
  28. <description>
  29. Specifies the current viewer id. It should be unique.
  30. It can contain number,letter or underline.
  31. </description>
  32. </attribute>
  33. <attribute>
  34. <name>pattern</name>
  35. <required>false</required>
  36. <rtexprvalue>true</rtexprvalue>
  37. <description>
  38. Specifies which servlet pattern to be used to preview report.
  39. Default value is frameset.
  40. ( frameset or run )
  41. </description>
  42. </attribute>
  43. <attribute>
  44. <name>baseURL</name>
  45. <required>false</required>
  46. <rtexprvalue>true</rtexprvalue>
  47. <description>
  48. Specifies base URL of BIRT viewer.
  49. Default to the current context.
  50. </description>
  51. </attribute>
  52. <attribute>
  53. <name>title</name>
  54. <required>false</required>
  55. <rtexprvalue>true</rtexprvalue>
  56. <description>
  57. Specifies the report title displayed at the top.
  58. </description>
  59. </attribute>
  60. <attribute>
  61. <name>isHostPage</name>
  62. <required>false</required>
  63. <rtexprvalue>true</rtexprvalue>
  64. <description>
  65. Specifies whether the viewer occupies the whole page.
  66. Default to false.
  67. </description>
  68. </attribute>
  69. <attribute>
  70. <name>scrolling </name>
  71. <required>false</required>
  72. <rtexprvalue>true</rtexprvalue>
  73. <description>
  74. Sets the IFrame style "scrolling ".
  75. If isHostPage is true, ignore this attribute.
  76. ( auto | yes | no )
  77. </description>
  78. </attribute>
  79. <attribute>
  80. <name>position</name>
  81. <required>false</required>
  82. <rtexprvalue>true</rtexprvalue>
  83. <description>
  84. Sets the style "position" of report container.
  85. If isHostPage is true, ignore this attribute.
  86. ( static | absolute | fixed | relative )
  87. </description>
  88. </attribute>
  89. <attribute>
  90. <name>style</name>
  91. <required>false</required>
  92. <rtexprvalue>true</rtexprvalue>
  93. <description>
  94. Sets the style of report container.
  95. If isHostPage is true, ignore this attribute.
  96. </description>
  97. </attribute>
  98. <attribute>
  99. <name>height</name>
  100. <required>false</required>
  101. <rtexprvalue>true</rtexprvalue>
  102. <description>
  103. Sets the height of report container in pixels.
  104. If isHostPage is true, ignore this attribute.
  105. </description>
  106. </attribute>
  107. <attribute>
  108. <name>width</name>
  109. <required>false</required>
  110. <rtexprvalue>true</rtexprvalue>
  111. <description>
  112. Sets the width of report container in pixels.
  113. If isHostPage is true, ignore this attribute.
  114. </description>
  115. </attribute>
  116. <attribute>
  117. <name>top</name>
  118. <required>false</required>
  119. <rtexprvalue>true</rtexprvalue>
  120. <description>
  121. Sets the top of report container in pixels.
  122. If isHostPage is true, ignore this attribute.
  123. </description>
  124. </attribute>
  125. <attribute>
  126. <name>left</name>
  127. <required>false</required>
  128. <rtexprvalue>true</rtexprvalue>
  129. <description>
  130. Sets the left of report container in pixels.
  131. If isHostPage is true, ignore this attribute.
  132. </description>
  133. </attribute>
  134. <attribute>
  135. <name>frameborder</name>
  136. <required>false</required>
  137. <rtexprvalue>true</rtexprvalue>
  138. <description>
  139. Specifies whether displays the iframe border.
  140. Default to no.
  141. If isHostPage is true, ignore this attribute.
  142. ( Yes | No )
  143. </description>
  144. </attribute>
  145. <attribute>
  146. <name>reportDesign</name>
  147. <required>false</required>
  148. <rtexprvalue>true</rtexprvalue>
  149. <description>
  150. Specifies the report design file name.
  151. ( Absolute path, relative path or URL )
  152. </description>
  153. </attribute>
  154. <attribute>
  155. <name>reportDocument</name>
  156. <required>false</required>
  157. <rtexprvalue>true</rtexprvalue>
  158. <description>
  159. Specifies the report document file name.
  160. Noted: only support "file:" URL format.
  161. ( Absolute path, relative path or URL )
  162. </description>
  163. </attribute>
  164. <attribute>
  165. <name>reportletId</name>
  166. <required>false</required>
  167. <rtexprvalue>true</rtexprvalue>
  168. <description>
  169. Specifies the instance id of reportlet.
  170. The "reportDocument" attribute should be required.
  171. Noted: frameset pattern doesn't support reportlet.
  172. </description>
  173. </attribute>
  174. <attribute>
  175. <name>bookmark</name>
  176. <required>false</required>
  177. <rtexprvalue>true</rtexprvalue>
  178. <description>
  179. Specifies the targeted bookmark name.
  180. </description>
  181. </attribute>
  182. <attribute>
  183. <name>locale</name>
  184. <required>false</required>
  185. <rtexprvalue>true</rtexprvalue>
  186. <description>
  187. Specifies the Locale information.
  188. </description>
  189. </attribute>
  190. <attribute>
  191. <name>timeZone</name>
  192. <required>false</required>
  193. <rtexprvalue>true</rtexprvalue>
  194. <description>
  195. Specifies a time zone id. For example: "America/Los_Angeles" or "GMT+1" or "GMT+01:00".
  196. </description>
  197. </attribute>
  198. <attribute>
  199. <name>svg</name>
  200. <required>false</required>
  201. <rtexprvalue>true</rtexprvalue>
  202. <description>
  203. Specifies whether supports the SVG output format or not.
  204. </description>
  205. </attribute>
  206. <attribute>
  207. <name>format</name>
  208. <required>false</required>
  209. <rtexprvalue>true</rtexprvalue>
  210. <description>
  211. Specifies the output format of report.
  212. </description>
  213. </attribute>
  214. <attribute>
  215. <name>emitterId</name>
  216. <required>false</required>
  217. <rtexprvalue>true</rtexprvalue>
  218. <description>
  219. Specifies the emitter id for the report output.
  220. </description>
  221. </attribute>
  222. <attribute>
  223. <name>pageOverflow</name>
  224. <required>false</required>
  225. <rtexprvalue>true</rtexprvalue>
  226. <description>
  227. Specifies the page overflow setting for the PDF format.
  228. One of the following values:
  229. 0 for "auto", 1 for "actual size", 2 for "fit to page".
  230. </description>
  231. </attribute>
  232. <attribute>
  233. <name>rtl</name>
  234. <required>false</required>
  235. <rtexprvalue>true</rtexprvalue>
  236. <description>
  237. Specifies whether supports rtl page or not.
  238. </description>
  239. </attribute>
  240. <attribute>
  241. <name>pageNum</name>
  242. <required>false</required>
  243. <rtexprvalue>true</rtexprvalue>
  244. <description>
  245. Specifies output page number when render document file.
  246. </description>
  247. </attribute>
  248. <attribute>
  249. <name>pageRange</name>
  250. <required>false</required>
  251. <rtexprvalue>true</rtexprvalue>
  252. <description>
  253. Specifies page range when render document file.
  254. </description>
  255. </attribute>
  256. <attribute>
  257. <name>resourceFolder</name>
  258. <required>false</required>
  259. <rtexprvalue>true</rtexprvalue>
  260. <description>
  261. Specifies the referenced resource folder.
  262. Default value is defined in web.xml.
  263. </description>
  264. </attribute>
  265. <attribute>
  266. <name>forceOverwriteDocument</name>
  267. <required>false</required>
  268. <rtexprvalue>true</rtexprvalue>
  269. <description>
  270. Specifies whether forces to overwrite the generated document.
  271. If allowPageBreak is false,ignore this attribute.
  272. Default value is defined in web.xml.
  273. </description>
  274. </attribute>
  275. <attribute>
  276. <name>showTitle</name>
  277. <required>false</required>
  278. <rtexprvalue>true</rtexprvalue>
  279. <description>
  280. Specifies whether shows the report title.
  281. Default to true.
  282. </description>
  283. </attribute>
  284. <attribute>
  285. <name>showToolBar</name>
  286. <required>false</required>
  287. <rtexprvalue>true</rtexprvalue>
  288. <description>
  289. Specifies whether shows the toolbar.
  290. Default to true.
  291. </description>
  292. </attribute>
  293. <attribute>
  294. <name>showNavigationBar</name>
  295. <required>false</required>
  296. <rtexprvalue>true</rtexprvalue>
  297. <description>
  298. Specifies whether shows the Navigation Bar.
  299. If allowPageBreak is false,ignore this attribute.
  300. Default to true.
  301. </description>
  302. </attribute>
  303. <attribute>
  304. <name>showParameterPage</name>
  305. <required>false</required>
  306. <rtexprvalue>true</rtexprvalue>
  307. <description>
  308. Specifies whether show the parameter dialog or not.
  309. Default to true.
  310. </description>
  311. </attribute>
  312. <attribute>
  313. <name>isReportlet</name>
  314. <required>false</required>
  315. <rtexprvalue>true</rtexprvalue>
  316. <description>
  317. Specifies whether render reportlet by bookmark.
  318. Default to false.
  319. </description>
  320. </attribute>
  321. </tag>
  322. <!--**********************************************-->
  323. <!-- Report Tag -->
  324. <!--**********************************************-->
  325. <tag>
  326. <name>report</name>
  327. <tag-class>org.eclipse.birt.report.taglib.ReportTag</tag-class>
  328. <body-content>JSP</body-content>
  329. <description>
  330. The report tag can provide fast report preview without Ajax framework.
  331. The report content can be output to web browser directly.
  332. </description>
  333. <attribute>
  334. <name>id</name>
  335. <required>true</required>
  336. <rtexprvalue>true</rtexprvalue>
  337. <description>
  338. Specifies the current viewer id. It should be unique.
  339. It can contain number,letter or underline.
  340. </description>
  341. </attribute>
  342. <attribute>
  343. <name>baseURL</name>
  344. <required>false</required>
  345. <rtexprvalue>true</rtexprvalue>
  346. <description>
  347. Specifies base URL of BIRT viewer.
  348. Default to the current context.
  349. If report container is DIV, ignore this attribute.
  350. </description>
  351. </attribute>
  352. <attribute>
  353. <name>isHostPage</name>
  354. <required>false</required>
  355. <rtexprvalue>true</rtexprvalue>
  356. <description>
  357. Specifies whether the viewer occupies the whole page.
  358. Default to false.
  359. </description>
  360. </attribute>
  361. <attribute>
  362. <name>scrolling </name>
  363. <required>false</required>
  364. <rtexprvalue>true</rtexprvalue>
  365. <description>
  366. Sets the DIV/IFrame style "scrolling ".
  367. If isHostPage is true, ignore this attribute.
  368. ( auto | yes | no )
  369. </description>
  370. </attribute>
  371. <attribute>
  372. <name>position</name>
  373. <required>false</required>
  374. <rtexprvalue>true</rtexprvalue>
  375. <description>
  376. Sets the style "position" of report container.
  377. If isHostPage is true, ignore this attribute.
  378. ( static | absolute | fixed | relative )
  379. </description>
  380. </attribute>
  381. <attribute>
  382. <name>style</name>
  383. <required>false</required>
  384. <rtexprvalue>true</rtexprvalue>
  385. <description>
  386. Sets the style of report container.
  387. If isHostPage is true, ignore this attribute.
  388. </description>
  389. </attribute>
  390. <attribute>
  391. <name>height</name>
  392. <required>false</required>
  393. <rtexprvalue>true</rtexprvalue>
  394. <description>
  395. Sets the height of report container in pixels.
  396. If isHostPage is true, ignore this attribute.
  397. </description>
  398. </attribute>
  399. <attribute>
  400. <name>width</name>
  401. <required>false</required>
  402. <rtexprvalue>true</rtexprvalue>
  403. <description>
  404. Sets the width of report container in pixels.
  405. If isHostPage is true, ignore this attribute.
  406. </description>
  407. </attribute>
  408. <attribute>
  409. <name>top</name>
  410. <required>false</required>
  411. <rtexprvalue>true</rtexprvalue>
  412. <description>
  413. Sets the top of report container in pixels.
  414. If isHostPage is true, ignore this attribute.
  415. </description>
  416. </attribute>
  417. <attribute>
  418. <name>left</name>
  419. <required>false</required>
  420. <rtexprvalue>true</rtexprvalue>
  421. <description>
  422. Sets the left of report container in pixels.
  423. If isHostPage is true, ignore this attribute.
  424. </description>
  425. </attribute>
  426. <attribute>
  427. <name>frameborder</name>
  428. <required>false</required>
  429. <rtexprvalue>true</rtexprvalue>
  430. <description>
  431. Specifies whether displays the iframe border.
  432. Available when user IFrame.
  433. Default to no.
  434. ( Yes | No )
  435. </description>
  436. </attribute>
  437. <attribute>
  438. <name>reportDesign</name>
  439. <required>false</required>
  440. <rtexprvalue>true</rtexprvalue>
  441. <description>
  442. Specifies the report design file name.
  443. ( Absolute path, relative path or URL )
  444. </description>
  445. </attribute>
  446. <attribute>
  447. <name>reportDocument</name>
  448. <required>false</required>
  449. <rtexprvalue>true</rtexprvalue>
  450. <description>
  451. Specifies the report document file name.
  452. Noted: only support "file:" URL format.
  453. ( Absolute path, relative path or URL )
  454. </description>
  455. </attribute>
  456. <attribute>
  457. <name>reportletId</name>
  458. <required>false</required>
  459. <rtexprvalue>true</rtexprvalue>
  460. <description>
  461. Specifies the instance id of reportlet.
  462. The "reportDocument" attribute should be required.
  463. </description>
  464. </attribute>
  465. <attribute>
  466. <name>bookmark</name>
  467. <required>false</required>
  468. <rtexprvalue>true</rtexprvalue>
  469. <description>
  470. Specifies the targeted bookmark name.
  471. </description>
  472. </attribute>
  473. <attribute>
  474. <name>locale</name>
  475. <required>false</required>
  476. <rtexprvalue>true</rtexprvalue>
  477. <description>
  478. Specifies the Locale information.
  479. </description>
  480. </attribute>
  481. <attribute>
  482. <name>timeZone</name>
  483. <required>false</required>
  484. <rtexprvalue>true</rtexprvalue>
  485. <description>
  486. Specifies a time zone id. For example: "America/Los_Angeles" or "GMT+1" or "GMT+01:00".
  487. </description>
  488. </attribute>
  489. <attribute>
  490. <name>svg</name>
  491. <required>false</required>
  492. <rtexprvalue>true</rtexprvalue>
  493. <description>
  494. Specifies whether supports the SVG output format or not.
  495. </description>
  496. </attribute>
  497. <attribute>
  498. <name>format</name>
  499. <required>false</required>
  500. <rtexprvalue>true</rtexprvalue>
  501. <description>
  502. Specifies the output format of report.
  503. </description>
  504. </attribute>
  505. <attribute>
  506. <name>emitterId</name>
  507. <required>false</required>
  508. <rtexprvalue>true</rtexprvalue>
  509. <description>
  510. Specifies the emitter id for the report output.
  511. </description>
  512. </attribute>
  513. <attribute>
  514. <name>pageOverflow</name>
  515. <required>false</required>
  516. <rtexprvalue>true</rtexprvalue>
  517. <description>
  518. Specifies the page overflow setting for the PDF format.
  519. One of the following values:
  520. 0 for "auto", 1 for "actual size", 2 for "fit to page".
  521. </description>
  522. </attribute>
  523. <attribute>
  524. <name>rtl</name>
  525. <required>false</required>
  526. <rtexprvalue>true</rtexprvalue>
  527. <description>
  528. Specifies whether supports rtl page or not.
  529. </description>
  530. </attribute>
  531. <attribute>
  532. <name>showParameterPage</name>
  533. <required>false</required>
  534. <rtexprvalue>true</rtexprvalue>
  535. <description>
  536. Specifies whether show the parameter dialog or not.
  537. Default to true.
  538. If report container is DIV, ignore this attribute.
  539. </description>
  540. </attribute>
  541. <attribute>
  542. <name>resourceFolder</name>
  543. <required>false</required>
  544. <rtexprvalue>true</rtexprvalue>
  545. <description>
  546. Specifies the referenced resource folder.
  547. Default value is defined in web.xml.
  548. </description>
  549. </attribute>
  550. <attribute>
  551. <name>reportContainer</name>
  552. <required>false</required>
  553. <rtexprvalue>true</rtexprvalue>
  554. <description>
  555. Specifies iframe or div as report container.
  556. Default to iframe.
  557. ( iframe | div )
  558. </description>
  559. </attribute>
  560. <attribute>
  561. <name>pageNum</name>
  562. <required>false</required>
  563. <rtexprvalue>true</rtexprvalue>
  564. <description>
  565. Specifies output page number when render document file.
  566. </description>
  567. </attribute>
  568. <attribute>
  569. <name>pageRange</name>
  570. <required>false</required>
  571. <rtexprvalue>true</rtexprvalue>
  572. <description>
  573. Specifies page range when render document file.
  574. </description>
  575. </attribute>
  576. <attribute>
  577. <name>isReportlet</name>
  578. <required>false</required>
  579. <rtexprvalue>true</rtexprvalue>
  580. <description>
  581. Specifies whether render reportlet by bookmark.
  582. Default to false.
  583. </description>
  584. </attribute>
  585. </tag>
  586. <!--**********************************************-->
  587. <!-- Report Parameter Tag -->
  588. <!--**********************************************-->
  589. <tag>
  590. <name>param</name>
  591. <tag-class>org.eclipse.birt.report.taglib.ParamTag</tag-class>
  592. <body-content>JSP</body-content>
  593. <description>
  594. The param tag specifies the parameters defined in report design file.
  595. </description>
  596. <attribute>
  597. <name>name</name>
  598. <required>true</required>
  599. <rtexprvalue>true</rtexprvalue>
  600. <description>
  601. Specifies the report parameter name.
  602. </description>
  603. </attribute>
  604. <attribute>
  605. <name>pattern</name>
  606. <required>false</required>
  607. <rtexprvalue>true</rtexprvalue>
  608. <description>
  609. Specifies the report parameter pattern format.
  610. </description>
  611. </attribute>
  612. <attribute>
  613. <name>value</name>
  614. <required>false</required>
  615. <rtexprvalue>true</rtexprvalue>
  616. <description>
  617. Specifies the report parameter value. If doesn't set, value is null.
  618. </description>
  619. </attribute>
  620. <attribute>
  621. <name>displayText</name>
  622. <required>false</required>
  623. <rtexprvalue>true</rtexprvalue>
  624. <description>
  625. Specifies the report parameter display text.
  626. </description>
  627. </attribute>
  628. <attribute>
  629. <name>delim</name>
  630. <required>false</required>
  631. <rtexprvalue>true</rtexprvalue>
  632. <description>
  633. Specifies the delimiter for multiple values.
  634. Defaults to pipe "|".
  635. </description>
  636. </attribute>
  637. <attribute>
  638. <name>isLocale</name>
  639. <required>false</required>
  640. <rtexprvalue>true</rtexprvalue>
  641. <description>
  642. Specifies whether the report parameter value is a locale/format related string.
  643. </description>
  644. </attribute>
  645. </tag>
  646. <!--**********************************************-->
  647. <!-- Report Parameter Value Tag -->
  648. <!--**********************************************-->
  649. <tag>
  650. <name>value</name>
  651. <tag-class>org.eclipse.birt.report.taglib.ParamValueTag</tag-class>
  652. <body-content>JSP</body-content>
  653. <description>
  654. The param value tag specifies multiple values for a given param tag.
  655. </description>
  656. <attribute>
  657. <name>value</name>
  658. <required>false</required>
  659. <rtexprvalue>true</rtexprvalue>
  660. <description>
  661. Specifies the report parameter value. If doesn't set, value is null.
  662. </description>
  663. </attribute>
  664. <attribute>
  665. <name>displayText</name>
  666. <required>false</required>
  667. <rtexprvalue>true</rtexprvalue>
  668. <description>
  669. Specifies the report parameter display text.
  670. </description>
  671. </attribute>
  672. </tag>
  673. <!--**********************************************-->
  674. <!-- ParameterPage Tag -->
  675. <!--**********************************************-->
  676. <tag>
  677. <name>parameterPage</name>
  678. <tag-class>org.eclipse.birt.report.taglib.RequesterTag</tag-class>
  679. <body-content>JSP</body-content>
  680. <description>
  681. The parameterPage tag can help developers to display BIRT parameter page or create a user-defined parameter page.
  682. This tag can collect these parameters and submit to BIRT servlet to handle request.
  683. </description>
  684. <attribute>
  685. <name>id</name>
  686. <required>true</required>
  687. <rtexprvalue>true</rtexprvalue>
  688. <description>
  689. Specifies the parameter page id.It should be unique.
  690. It can contain number,letter or underline.
  691. </description>
  692. </attribute>
  693. <attribute>
  694. <name>name</name>
  695. <required>false</required>
  696. <rtexprvalue>true</rtexprvalue>
  697. <description>
  698. Specifies the parameter page name.
  699. If attribute 'isCustom' is true, this name should be required and unique.
  700. </description>
  701. </attribute>
  702. <attribute>
  703. <name>isCustom</name>
  704. <required>false</required>
  705. <rtexprvalue>true</rtexprvalue>
  706. <description>
  707. Specifies whether uses the user-defined parameter page.
  708. If false, use the BIRT parameter dialog.
  709. Default to false.
  710. </description>
  711. </attribute>
  712. <attribute>
  713. <name>title</name>
  714. <required>false</required>
  715. <rtexprvalue>true</rtexprvalue>
  716. <description>
  717. Specifies the report title displayed at the top.
  718. </description>
  719. </attribute>
  720. <attribute>
  721. <name>baseURL</name>
  722. <required>false</required>
  723. <rtexprvalue>true</rtexprvalue>
  724. <description>
  725. Specifies base URL of BIRT viewer.
  726. Default to the current context.
  727. </description>
  728. </attribute>
  729. <attribute>
  730. <name>scrolling </name>
  731. <required>false</required>
  732. <rtexprvalue>true</rtexprvalue>
  733. <description>
  734. Sets the DIV/IFrame style "scrolling ".
  735. ( auto | yes | no )
  736. </description>
  737. </attribute>
  738. <attribute>
  739. <name>position</name>
  740. <required>false</required>
  741. <rtexprvalue>true</rtexprvalue>
  742. <description>
  743. Sets the style "position" of parameter page.
  744. ( static | absolute | fixed | relative )
  745. </description>
  746. </attribute>
  747. <attribute>
  748. <name>style</name>
  749. <required>false</required>
  750. <rtexprvalue>true</rtexprvalue>
  751. <description>
  752. Sets the style of parameter page.
  753. </description>
  754. </attribute>
  755. <attribute>
  756. <name>height</name>
  757. <required>false</required>
  758. <rtexprvalue>true</rtexprvalue>
  759. <description>
  760. Sets the height of parameter page in pixels.
  761. </description>
  762. </attribute>
  763. <attribute>
  764. <name>width</name>
  765. <required>false</required>
  766. <rtexprvalue>true</rtexprvalue>
  767. <description>
  768. Sets the width of parameter page in pixels.
  769. </description>
  770. </attribute>
  771. <attribute>
  772. <name>top</name>
  773. <required>false</required>
  774. <rtexprvalue>true</rtexprvalue>
  775. <description>
  776. Sets the top of parameter page in pixels.
  777. </description>
  778. </attribute>
  779. <attribute>
  780. <name>left</name>
  781. <required>false</required>
  782. <rtexprvalue>true</rtexprvalue>
  783. <description>
  784. Sets the left of parameter page in pixels.
  785. </description>
  786. </attribute>
  787. <attribute>
  788. <name>frameborder</name>
  789. <required>false</required>
  790. <rtexprvalue>true</rtexprvalue>
  791. <description>
  792. Specifies whether displays the iframe border.
  793. Default to no.
  794. If set "isCustom" to true, ignore this attribute.
  795. ( Yes | No )
  796. </description>
  797. </attribute>
  798. <attribute>
  799. <name>reportDesign</name>
  800. <required>false</required>
  801. <rtexprvalue>true</rtexprvalue>
  802. <description>
  803. Specifies the report design file name.
  804. ( Absolute path, relative path or URL )
  805. </description>
  806. </attribute>
  807. <attribute>
  808. <name>reportDocument</name>
  809. <required>false</required>
  810. <rtexprvalue>true</rtexprvalue>
  811. <description>
  812. Specifies the report document file name.
  813. Noted: only support "file:" URL format.
  814. ( Absolute path, relative path or URL )
  815. </description>
  816. </attribute>
  817. <attribute>
  818. <name>reportletId</name>
  819. <required>false</required>
  820. <rtexprvalue>true</rtexprvalue>
  821. <description>
  822. Specifies the instance id of reportlet.
  823. The "reportDocument" attribute should be required.
  824. Noted: frameset pattern doesn't support reportlet.
  825. </description>
  826. </attribute>
  827. <attribute>
  828. <name>pattern</name>
  829. <required>false</required>
  830. <rtexprvalue>true</rtexprvalue>
  831. <description>
  832. Specifies the servlet pattern for request submit.
  833. BIRT supports three patterns: frameset, run and preview.
  834. Can refer to the user-defined servlet pattern.
  835. Default to frameset.
  836. </description>
  837. </attribute>
  838. <attribute>
  839. <name>target</name>
  840. <required>false</required>
  841. <rtexprvalue>true</rtexprvalue>
  842. <description>
  843. Specifies the target window for request submit.
  844. </description>
  845. </attribute>
  846. <attribute>
  847. <name>bookmark</name>
  848. <required>false</required>
  849. <rtexprvalue>true</rtexprvalue>
  850. <description>
  851. Specifies the targeted bookmark name.
  852. </description>
  853. </attribute>
  854. <attribute>
  855. <name>locale</name>
  856. <required>false</required>
  857. <rtexprvalue>true</rtexprvalue>
  858. <description>
  859. Specifies the Locale information.
  860. </description>
  861. </attribute>
  862. <attribute>
  863. <name>timeZone</name>
  864. <required>false</required>
  865. <rtexprvalue>true</rtexprvalue>
  866. <description>
  867. Specifies a time zone id. For example: "America/Los_Angeles" or "GMT+1" or "GMT+01:00".
  868. </description>
  869. </attribute>
  870. <attribute>
  871. <name>svg</name>
  872. <required>false</required>
  873. <rtexprvalue>true</rtexprvalue>
  874. <description>
  875. Specifies whether supports the SVG output format or not.
  876. </description>
  877. </attribute>
  878. <attribute>
  879. <name>format</name>
  880. <required>false</required>
  881. <rtexprvalue>true</rtexprvalue>
  882. <description>
  883. Specifies the output format of report.
  884. </description>
  885. </attribute>
  886. <attribute>
  887. <name>emitterId</name>
  888. <required>false</required>
  889. <rtexprvalue>true</rtexprvalue>
  890. <description>
  891. Specifies the emitter id for the report output.
  892. </description>
  893. </attribute>
  894. <attribute>
  895. <name>pageOverflow</name>
  896. <required>false</required>
  897. <rtexprvalue>true</rtexprvalue>
  898. <description>
  899. Specifies the page overflow setting for the PDF format.
  900. One of the following values:
  901. 0 for "auto", 1 for "actual size", 2 for "fit to page".
  902. </description>
  903. </attribute>
  904. <attribute>
  905. <name>rtl</name>
  906. <required>false</required>
  907. <rtexprvalue>true</rtexprvalue>
  908. <description>
  909. Specifies whether supports rtl page or not.
  910. </description>
  911. </attribute>
  912. <attribute>
  913. <name>resourceFolder</name>
  914. <required>false</required>
  915. <rtexprvalue>true</rtexprvalue>
  916. <description>
  917. Specifies the referenced resource folder.
  918. Default value is defined in web.xml.
  919. </description>
  920. </attribute>
  921. <attribute>
  922. <name>forceOverwriteDocument</name>
  923. <required>false</required>
  924. <rtexprvalue>true</rtexprvalue>
  925. <description>
  926. Specifies whether forces to overwrite the generated document.
  927. If allowPageBreak is false,ignore this attribute.
  928. Default value is defined in web.xml.
  929. </description>
  930. </attribute>
  931. <attribute>
  932. <name>showTitle</name>
  933. <required>false</required>
  934. <rtexprvalue>true</rtexprvalue>
  935. <description>
  936. Specifies whether shows the report title.
  937. Default to true.
  938. </description>
  939. </attribute>
  940. <attribute>
  941. <name>showToolBar</name>
  942. <required>false</required>
  943. <rtexprvalue>true</rtexprvalue>
  944. <description>
  945. Specifies whether shows the toolbar.
  946. Default to true.
  947. </description>
  948. </attribute>
  949. <attribute>
  950. <name>showNavigationBar</name>
  951. <required>false</required>
  952. <rtexprvalue>true</rtexprvalue>
  953. <description>
  954. Specifies whether shows the Navigation Bar.
  955. If allowPageBreak is false,ignore this attribute.
  956. Default to true.
  957. </description>
  958. </attribute>
  959. <attribute>
  960. <name>isReportlet</name>
  961. <required>false</required>
  962. <rtexprvalue>true</rtexprvalue>
  963. <description>
  964. Specifies whether render reportlet by bookmark.
  965. Default to false.
  966. </description>
  967. </attribute>
  968. </tag>
  969. <!--**********************************************-->
  970. <!-- Report Parameter Definition Tag -->
  971. <!--**********************************************-->
  972. <tag>
  973. <name>paramDef</name>
  974. <tag-class>org.eclipse.birt.report.taglib.ParamDefTag</tag-class>
  975. <body-content>JSP</body-content>
  976. <description>
  977. The param tag is used to generate html code for defined parameter in ParameterPage tag.
  978. </description>
  979. <attribute>
  980. <name>id</name>
  981. <required>true</required>
  982. <rtexprvalue>true</rtexprvalue>
  983. <description>
  984. Specifies the id of parameter control.It should be unique.
  985. It can contain number,letter or underline.
  986. </description>
  987. </attribute>
  988. <attribute>
  989. <name>name</name>
  990. <required>true</required>
  991. <rtexprvalue>true</rtexprvalue>
  992. <description>
  993. Specifies the report parameter name.
  994. </description>
  995. </attribute>
  996. <attribute>
  997. <name>pattern</name>
  998. <required>false</required>
  999. <rtexprvalue>true</rtexprvalue>
  1000. <description>
  1001. Specifies the report parameter pattern format.
  1002. It is used to parse defined parameter value string.
  1003. </description>
  1004. </attribute>
  1005. <attribute>
  1006. <name>value</name>
  1007. <required>false</required>
  1008. <rtexprvalue>true</rtexprvalue>
  1009. <description>
  1010. Specifies the report parameter value. If doesn't set, use default value.
  1011. </description>
  1012. </attribute>
  1013. <attribute>
  1014. <name>displayText</name>
  1015. <required>false</required>
  1016. <rtexprvalue>true</rtexprvalue>
  1017. <description>
  1018. Specifies the report parameter display text.
  1019. </description>
  1020. </attribute>
  1021. <attribute>
  1022. <name>isLocale</name>
  1023. <required>false</required>
  1024. <rtexprvalue>true</rtexprvalue>
  1025. <description>
  1026. Specifies whether the report parameter value is a locale/format related string.
  1027. It is used to parse defined parameter value string.
  1028. </description>
  1029. </attribute>
  1030. <attribute>
  1031. <name>title</name>
  1032. <required>false</required>
  1033. <rtexprvalue>true</rtexprvalue>
  1034. <description>
  1035. Specifies the title attribute of parameter control.
  1036. </description>
  1037. </attribute>
  1038. <attribute>
  1039. <name>cssClass</name>
  1040. <required>false</required>
  1041. <rtexprvalue>true</rtexprvalue>
  1042. <description>
  1043. Specifies the css class attribute of parameter control.
  1044. </description>
  1045. </attribute>
  1046. <attribute>
  1047. <name>style</name>
  1048. <required>false</required>
  1049. <rtexprvalue>true</rtexprvalue>
  1050. <description>
  1051. Specifies the parameter control style.
  1052. </description>
  1053. </attribute>
  1054. </tag>
  1055. </taglib>