[jboss-cvs] jboss-seam/doc/reference/en/modules ...
Norman Richards
norman.richards at jboss.com
Fri Nov 30 15:17:36 EST 2007
User: nrichards
Date: 07/11/30 15:17:36
Modified: doc/reference/en/modules itext.xml
Log:
improve chartings docs
Revision Changes Path
1.15 +87 -43 jboss-seam/doc/reference/en/modules/itext.xml
(In the diff below, changes in quantity of whitespace are not shown.)
Index: itext.xml
===================================================================
RCS file: /cvsroot/jboss/jboss-seam/doc/reference/en/modules/itext.xml,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -b -r1.14 -r1.15
--- itext.xml 24 Jul 2007 21:27:58 -0000 1.14
+++ itext.xml 30 Nov 2007 20:17:36 -0000 1.15
@@ -10,7 +10,7 @@
controls, which are used to construct views that can render to PDF, and the DocumentStore component, which
serves the rendered documents to the user. To include PDF support in your application, included
<literal>jboss-seam-pdf.jar</literal> in your <literal>WEB-INF/lib</literal> directory along with the
- iText JAR file. There is no further configuration needed to use Seam's iText supportfon. </para>
+ iText JAR file. There is no further configuration needed to use Seam's ciText supportfon. </para>
<para> The Seam iText module requires the use of Facelets as the view technology. Future versions of the library
may also support the use of JSP. Additionally, it requires the use of the seam-ui package.</para>
@@ -18,13 +18,9 @@
demonstrates proper deployment packaging, and it contains a number examples that demonstrate the key PDF
generation features current supported. </para>
-
-
<section id="itext.document">
<title>Creating a document</title>
-
-
<informaltable>
<tgroup cols="2">
<colspec colnum="1" colwidth="1*"/>
@@ -1447,6 +1443,11 @@
<section id="itext.charting">
<title>Charting</title>
+ <para> Charting support is also provided with <literal>jboss-seam-pdf.jar</literal>. Charts can be used in
+ PDF documents or can be used as images in an HTML page.
+ Charting requires the JFreeChart library (<literal>jfreechart.jar</literal> and <literal>jcommon.jar</literal>) to be added to the
+ <literal>WEB-INF/lib</literal> directory. Three types of charts are currently supported: pie charts, bar charts and line charts.
+ </para>
<informaltable id="itext.barchart">
<tgroup cols="2">
@@ -1894,126 +1895,142 @@
<listitem>
<para>
- <literal>title</literal>
+ <literal>title</literal>— The chart title text.
</para>
</listitem>
<listitem>
<para>
- <literal>label</literal>
+ <literal>label</literal>— The default label text for pie sections.
</para>
</listitem>
<listitem>
<para>
- <literal>legend</literal>
+ <literal>legend</literal>— A boolean value indicating whether or not the chart should include a legend. Default value is true
</para>
</listitem>
<listitem>
<para>
- <literal>is3D</literal>
+ <literal>is3D</literal>—A boolean value indicating that the chart should be rendered in 3D instead of 2D.
</para>
</listitem>
<listitem>
<para>
- <literal>labelLinkMargin</literal>
+ <literal>labelLinkMargin</literal>— The link margin for labels.
</para>
</listitem>
<listitem>
<para>
- <literal>labelLinkPaint</literal>
+ <literal>labelLinkPaint</literal>— The paint used for the label linking lines.
</para>
</listitem>
<listitem>
<para>
- <literal>labelLinkStroke</literal>
+ <literal>labelLinkStroke</literal>— he stroke used for the label linking lines.
</para>
</listitem>
+
<listitem>
<para>
- <literal>labelLinksVisible</literal>
+ <literal>labelLinksVisible</literal>— A flag that controls whether or not the label links are drawn.
</para>
</listitem>
<listitem>
<para>
- <literal>labelOutlinePaint</literal>
+ <literal>labelOutlinePaint</literal>— The paint used to draw the outline of the section labels.
</para>
</listitem>
<listitem>
<para>
- <literal>labelOutlineStroke</literal>
+ <literal>labelOutlineStroke</literal>— The stroke used to draw the outline of the section labels.
</para>
</listitem>
<listitem>
<para>
- <literal>labelShadowPaint</literal>
+ <literal>labelShadowPaint</literal>— The paint used to draw the shadow for the section labels.
</para>
</listitem>
<listitem>
<para>
- <literal>labelPaint</literal>
+ <literal>labelPaint</literal>— The color used to draw the section labels
</para>
</listitem>
<listitem>
<para>
- <literal>labelGap</literal>
+ <literal>labelGap</literal>— The gap between the labels and the plot as a percentage of the plot width.
</para>
</listitem>
<listitem>
<para>
- <literal>labelBackgroundPaint</literal>
+ <literal>labelBackgroundPaint</literal>— The color used to draw the background of the section labels. If this is null, the background is not filled.
</para>
</listitem>
<listitem>
<para>
- <literal>startAngle</literal>
+ <literal>startAngle</literal>— The starting angle of the first section.
</para>
</listitem>
<listitem>
<para>
- <literal>circular</literal>
+ <literal>circular</literal>— A boolean value indicating that the chart should be drawn as a circle.
+ If false, the chart is drawn as an ellipse. The default is true.
</para>
</listitem>
<listitem>
<para>
- <literal>direction</literal>
+ <literal>direction</literal>—
+ The direction the pie section are drawn. One of: <literal>clockwise</literal> or <literal>anticlockwise</literal>.
+ The default is <literal>clockwise</literal>.
</para>
</listitem>
<listitem>
<para>
- <literal>sectionOutlinePaint</literal>
+ <literal>sectionOutlinePaint</literal>— The outline paint for all sections.
</para>
</listitem>
<listitem>
<para>
- <literal>sectionOutlineStroke</literal>
+ <literal>sectionOutlineStroke</literal>— The outline stroke for all sections
</para>
</listitem>
<listitem>
<para>
- <literal>sectionOutlinesVisible</literal>
+ <literal>sectionOutlinesVisible</literal>— Indicates whether an outline is drawn for each section in the plot.
</para>
</listitem>
<listitem>
<para>
- <literal>baseSectionOutlinePaint</literal>
+ <literal>baseSectionOutlinePaint</literal>— The base section outline paint.
</para>
</listitem>
<listitem>
<para>
- <literal>baseSectionPaint</literal>
+ <literal>baseSectionPaint</literal>— The base section paint.
</para>
</listitem>
<listitem>
<para>
- <literal>baseSectionOutlineStroke</literal>
+ <literal>baseSectionOutlineStroke</literal>— The base section outline stroke.
</para>
</listitem>
-
</itemizedlist>
<para>
<emphasis>Usage</emphasis>
</para>
- <programlisting/>
+ <programlisting>
+
+<p:piechart title="Pie Chart" circular="false" direction="anticlockwise"
+ startAngle="30" labelGap="0.1" labelLinkPaint="red">
+ <p:series key="Prices">
+ <p:data key="2003" columnKey="2003" value="7.36" />
+ <p:data key="2004" columnKey="2004" value="11.50" />
+ <p:data key="2005" columnKey="2005" value="34.625" />
+ <p:data key="2006" columnKey="2006" value="76.30" />
+ <p:data key="2007" columnKey="2007" value="85.05" />
+ </p:series>
+</p:piechart>
+
+ </programlisting>
</entry>
</row>
@@ -2327,7 +2344,7 @@
<row>
<entry valign="top">
<para>
- <literal><p:barcode></literal>
+ <literal><p:barCode></literal>
</para>
</entry>
<entry valign="top">
@@ -2343,47 +2360,68 @@
<listitem>
<para>
- <literal>type</literal>
+ <literal>type</literal> — A barcode type supported by iText.
+ Valid values include:
+ <literal>EAN13</literal>, <literal>EAN8</literal>, <literal>UPCA</literal>,
+ <literal>UPCE</literal>,
+ <literal>SUPP2</literal>, <literal>SUPP5</literal>, <literal>POSTNET</literal>,
+ <literal>PLANET</literal>, <literal>CODE128</literal>,
+ <literal>CODE128_UCC</literal>, <literal>CODE128_RAW</literal> and <literal>CODABAR</literal>.
+
</para>
</listitem>
<listitem>
<para>
- <literal>code</literal>
+ <literal>code</literal>— The value to be encoded by the barcode.
</para>
</listitem>
<listitem>
<para>
- <literal>xpos</literal>
+ <literal>xpos</literal>— For PDFs, the absolute y position of the barcode on the page.
</para>
</listitem>
<listitem>
<para>
- <literal>ypos</literal>
+ <literal>ypos</literal>— For PDFs, the absolute y position of the barcode on the page.
</para>
</listitem>
<listitem>
<para>
- <literal>rotDegrees</literal>
+ <literal>rotDegrees</literal> — For PDFs, the rotation factor of the barcode in degrees.
</para>
</listitem>
<listitem>
<para>
- <literal>barHeight</literal>
+ <literal>barHeight</literal> — The height of the bars in the barCode
</para>
</listitem>
+
<listitem>
<para>
- <literal>textSize</literal>
+ <literal>minBarWidth</literal> — The minimum bar width.
</para>
</listitem>
<listitem>
<para>
- <literal>minBarWidth</literal>
+ <literal>barMultiplier</literal> — The bar multiplier for wide bars or the
+ distance between bars for <literal>POSTNET</literal> and <literal>PLANET</literal> code.
+
</para>
</listitem>
<listitem>
<para>
- <literal>barMultiplier</literal>
+ <literal>barColor</literal> — The color to draw the bars.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>textColor</literal> — The color of any text on the barcode.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>textSize</literal> — The size of the barcode text, if any.
</para>
</listitem>
@@ -2392,7 +2430,13 @@
<para>
<emphasis>Usage</emphasis>
</para>
- <programlisting/>
+ <programlisting>
+<p:barCode type="code128"
+ barHeight="80"
+ textSize="20"
+ code="(10)45566(17)040301"
+ codeType="code128_ucc"
+ altText="My BarCode" /></programlisting>
</entry>
</row>
More information about the jboss-cvs-commits
mailing list