[jboss-cvs] jboss-seam/doc/reference/en/modules ...
Norman Richards
norman.richards at jboss.com
Mon Jun 4 21:15:39 EDT 2007
User: nrichards
Date: 07/06/04 21:15:39
Modified: doc/reference/en/modules itext.xml
Log:
tag documentation for charting
Revision Changes Path
1.8 +1736 -965 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.7
retrieving revision 1.8
diff -u -b -r1.7 -r1.8
--- itext.xml 1 Jun 2007 20:57:25 -0000 1.7
+++ itext.xml 5 Jun 2007 01:15:39 -0000 1.8
@@ -17,7 +17,7 @@
<para> The <literal>examples/itext</literal> project contains an example of the PDF support in action. It
demonstrates proper deployment packaging, and it contains a number examples that demonstrate the key PDF
generation features current supported. </para>
- </section>
+
<section id="itext.document">
@@ -43,9 +43,9 @@
<emphasis>Description</emphasis>
</para>
<para> Documents are generated by facelets documents using tags in the
- <literal>http://jboss.com/products/seam/pdf</literal> namespace. Documents should
- always have the <literal>document</literal> tag at the root of the document. The
- <literal>document</literal> tag prepares Seam to generate a document into the
+ <literal>http://jboss.com/products/seam/pdf</literal> namespace. Documents
+ should always have the <literal>document</literal> tag at the root of the document.
+ The <literal>document</literal> tag prepares Seam to generate a document into the
DocumentStore and renders an HTML redirect to that stored content.</para>
<para>
@@ -58,37 +58,38 @@
<para>
<literal>type</literal> — The type of the document to be produced.
Valid values are <literal>PDF</literal>, <literal>RTF</literal> and
- <literal>HTML</literal> modes. Seam defaults to PDF generation, and many of
- the features only work correctly when generating PDF documents.</para>
+ <literal>HTML</literal> modes. Seam defaults to PDF generation, and many
+ of the features only work correctly when generating PDF documents.</para>
</listitem>
<listitem>
<para>
- <literal>pageSize</literal> — The size of the page to be generate. The
- most commonly used values would be <literal>LETTER</literal> and
- <literal>A4</literal>. A full list of supported pages sizes can be found in
- <literal>com.lowagie.text.PageSize</literal> class. Alternatively, pageSize
- can provide the width and height of the page directly. The value "612 792", for
- example, is equivalent to the LETTER page size. </para>
+ <literal>pageSize</literal> — The size of the page to be generate.
+ The most commonly used values would be <literal>LETTER</literal> and
+ <literal>A4</literal>. A full list of supported pages sizes can be found
+ in <literal>com.lowagie.text.PageSize</literal> class. Alternatively,
+ pageSize can provide the width and height of the page directly. The value
+ "612 792", for example, is equivalent to the LETTER page size. </para>
</listitem>
<listitem>
<para>
- <literal>orientation</literal> — The orientation of the page. Valid
- values are <literal>portrait</literal> and <literal>landscape</literal>. In
- landscape mode, the height and width page size values are reversed. </para>
+ <literal>orientation</literal> — The orientation of the page.
+ Valid values are <literal>portrait</literal> and
+ <literal>landscape</literal>. In landscape mode, the height and width page
+ size values are reversed. </para>
</listitem>
<listitem>
<para>
- <literal>margins</literal> — The left, right, top and bottom margin
- values. </para>
+ <literal>margins</literal> — The left, right, top and bottom
+ margin values. </para>
</listitem>
<listitem>
<para>
- <literal>marginMirroring</literal> — Indicates that margin settings
- should be reversed an alternating pages.</para>
+ <literal>marginMirroring</literal> — Indicates that margin
+ settings should be reversed an alternating pages.</para>
</listitem>
</itemizedlist>
@@ -145,11 +146,12 @@
<section id="itext.text">
<title>Basic Text Elements</title>
- <para> Useful documents will need to contain more than just text; however, the standard UI components are geared
- towards HTML generation and are not useful for generating PDF content. Instead, Seam provides a special UI
- components for generating suitable PDF content. Tags like <literal><p:image></literal> and
- <literal><p:paragraph></literal> are the basic foundations of simple documents. Tags like
- <literal><p:font></literal> provide style information to all the content surrounging them. </para>
+ <para> Useful documents will need to contain more than just text; however, the standard UI components are
+ geared towards HTML generation and are not useful for generating PDF content. Instead, Seam provides a
+ special UI components for generating suitable PDF content. Tags like
+ <literal><p:image></literal> and <literal><p:paragraph></literal> are the
+ basic foundations of simple documents. Tags like <literal><p:font></literal> provide style
+ information to all the content surrounging them. </para>
<informaltable>
@@ -170,8 +172,8 @@
<para>
<emphasis>Description</emphasis>
</para>
- <para> Most uses of text should be sectioned into paragraphs so that text fragments can be
- flowed, formatted and styled in logical groups.</para>
+ <para> Most uses of text should be sectioned into paragraphs so that text fragments can
+ be flowed, formatted and styled in logical groups.</para>
<para>
<emphasis>Attributes</emphasis>
@@ -205,8 +207,8 @@
</listitem>
<listitem>
<para>
- <literal>spacingAfter</literal> — The blank space to be inserted after
- the element.</para>
+ <literal>spacingAfter</literal> — The blank space to be inserted
+ after the element.</para>
</listitem>
<listitem>
<para>
@@ -257,8 +259,8 @@
<emphasis>Description</emphasis>
</para>
- <para> The <literal>text</literal> tag allows text fragments to be produced from application
- data using normal JSF converter mechanisms. It is very similar to the
+ <para> The <literal>text</literal> tag allows text fragments to be produced from
+ application data using normal JSF converter mechanisms. It is very similar to the
<literal>outputText</literal> tag used when rendering HTML documents. </para>
<para>
@@ -410,15 +412,15 @@
</para>
- <para><literal>p:image</literal> inserts an image into the document. Images can be be loaded
- from the classpath or from the web application context using the
+ <para><literal>p:image</literal> inserts an image into the document. Images can be be
+ loaded from the classpath or from the web application context using the
<literal>resource</literal> attribute. </para>
<para>Resources can also be dynamically generated by application code. The
- <literal>imageData</literal> attribute can specify a value binding expression whose
- value is a <literal>java.awt.Image</literal> object. </para>
+ <literal>imageData</literal> attribute can specify a value binding expression
+ whose value is a <literal>java.awt.Image</literal> object. </para>
@@ -429,19 +431,19 @@
<itemizedlist>
<listitem>
- <para><literal>resource</literal> — The location of the image resource to
- be included. Resources should be relative to the document root of the web
+ <para><literal>resource</literal> — The location of the image resource
+ to be included. Resources should be relative to the document root of the web
application. </para>
</listitem>
<listitem>
- <para><literal>value</literal> — A resource name or a method expression
- binding to an application-generated image. </para>
+ <para><literal>value</literal> — A resource name or a method
+ expression binding to an application-generated image. </para>
</listitem>
<listitem>
- <para><literal>rotation</literal> — The rotation of the image in degrees.
- </para>
+ <para><literal>rotation</literal> — The rotation of the image in
+ degrees. </para>
</listitem>
@@ -455,8 +457,8 @@
<listitem>
<para>
- <literal>alignment</literal>— The alignment of the image. (see <xref
- linkend="itext.alignment"/> for possible values) </para>
+ <literal>alignment</literal>— The alignment of the image. (see
+ <xref linkend="itext.alignment"/> for possible values) </para>
</listitem>
<listitem>
@@ -482,8 +484,8 @@
</listitem>
<listitem>
<para>
- <literal>spacingAfter</literal> — The blank space to be inserted after
- the element.</para>
+ <literal>spacingAfter</literal> — The blank space to be inserted
+ after the element.</para>
</listitem>
<listitem>
@@ -506,9 +508,10 @@
</listitem>
<listitem>
<para>
- <literal>scalePercent</literal> — The scaling factor (as a percentage)
- to use for the image. This can be expressed as a single percentage value or as
- two percentage values representing separate x and y scaling percentages.</para>
+ <literal>scalePercent</literal> — The scaling factor (as a
+ percentage) to use for the image. This can be expressed as a single
+ percentage value or as two percentage values representing separate x and y
+ scaling percentages.</para>
</listitem>
<listitem>
<para>
@@ -553,8 +556,8 @@
<para>
<emphasis>Description</emphasis>
</para>
- <para><literal>p:anchor</literal> defines clickable links from a document. It supports the
- following attributes:</para>
+ <para><literal>p:anchor</literal> defines clickable links from a document. It supports
+ the following attributes:</para>
<para>
@@ -571,11 +574,11 @@
<listitem>
- <para><literal>reference</literal> — The destination the link refers to.
- Links to other points in the document should begin with a "#". For example,
- "#link1" to refer to an anchor postion with a <literal>name</literal> of
- <literal>link1</literal>. Links may also be a full URL to point to a
- resource outside of the document.</para>
+ <para><literal>reference</literal> — The destination the link refers
+ to. Links to other points in the document should begin with a "#". For
+ example, "#link1" to refer to an anchor postion with a
+ <literal>name</literal> of <literal>link1</literal>. Links may also be a
+ full URL to point to a resource outside of the document.</para>
</listitem>
</itemizedlist>
@@ -622,10 +625,10 @@
<para>
<emphasis>Description</emphasis>
</para>
- <para>The <literal>p:header</literal> and <literal>p:footer</literal> components provide the
- ability to place header and footer text on each page of a generated document, with the
- exception of the first page. Header and footer declarations should appear near the top
- of a document. </para>
+ <para>The <literal>p:header</literal> and <literal>p:footer</literal> components provide
+ the ability to place header and footer text on each page of a generated document,
+ with the exception of the first page. Header and footer declarations should appear
+ near the top of a document. </para>
<para>
@@ -638,14 +641,15 @@
<listitem>
<para>
- <literal>alignment</literal> — The alignment of the header/footer box
- section. (see <xref linkend="itext.alignment"/> for alignment values)</para>
+ <literal>alignment</literal> — The alignment of the header/footer
+ box section. (see <xref linkend="itext.alignment"/> for alignment values)</para>
</listitem>
<listitem>
<para><literal>backgroundColor</literal> — The background color of the
- header/footer box. (see <xref linkend="itext.color"/> for color values) </para>
+ header/footer box. (see <xref linkend="itext.colors"/> for color values)
+ </para>
</listitem>
@@ -656,14 +660,15 @@
header/footer box. Individual border sides can be set using
<literal>borderColorLeft</literal>, <literal>borderColorRight</literal>,
<literal>borderColorTop</literal> and
- <literal>borderColorBottom</literal>.(see <xref linkend="itext.color"/> for
+ <literal>borderColorBottom</literal>.(see <xref linkend="itext.colors"/> for
color values) </para>
</listitem>
<listitem>
<para>
- <literal>borderWidth</literal> — The width of the border. Inidvidual
- border sides can be specified using <literal>borderWidthLeft</literal>,
- <literal>borderWidthRight</literal>, <literal>borderWidthTop</literal> and
+ <literal>borderWidth</literal> — The width of the border.
+ Inidvidual border sides can be specified using
+ <literal>borderWidthLeft</literal>, <literal>borderWidthRight</literal>,
+ <literal>borderWidthTop</literal> and
<literal>borderWidthBottom</literal>.</para>
</listitem>
</itemizedlist>
@@ -749,9 +754,9 @@
<para>If the generated document follows a book/article structure, the
<literal>p:chapter</literal> and <literal>p:section</literal> tags can be used to
- provide the necessary structure. Sections can only be used inside of chapters, but they
- may be nested arbitrarily deep. Most PDF viewers provide easy navigation between
- chapters and sections in a document. </para>
+ provide the necessary structure. Sections can only be used inside of chapters, but
+ they may be nested arbitrarily deep. Most PDF viewers provide easy navigation
+ between chapters and sections in a document. </para>
<para>
<emphasis>Attributes</emphasis>
@@ -763,23 +768,23 @@
<listitem>
<para>
- <literal>alignment</literal> — The alignment of the header/footer box
- section. (see <xref linkend="itext.alignment"/> for alignment values)</para>
+ <literal>alignment</literal> — The alignment of the header/footer
+ box section. (see <xref linkend="itext.alignment"/> for alignment values)</para>
</listitem>
<listitem>
- <para><literal>number</literal> — The chapter number. Every chapter should
- be assigned a chapter number.</para>
+ <para><literal>number</literal> — The chapter number. Every chapter
+ should be assigned a chapter number.</para>
</listitem>
<listitem>
- <para><literal>numberDepth</literal> — The depth of numbering for section.
- All sections are numbered relative to their surrounding chapter/sections. The
- fourth section of of the first section of chapter three would be section 3.1.4,
- if displayed at the default number depth of three. To omit the chapter number, a
- number depth of 2 should be used. In that case, the section number would be
- displayed as 1.4.</para>
+ <para><literal>numberDepth</literal> — The depth of numbering for
+ section. All sections are numbered relative to their surrounding
+ chapter/sections. The fourth section of of the first section of chapter
+ three would be section 3.1.4, if displayed at the default number depth of
+ three. To omit the chapter number, a number depth of 2 should be used. In
+ that case, the section number would be displayed as 1.4.</para>
</listitem>
</itemizedlist>
<para>
@@ -827,8 +832,8 @@
</para>
<para>Any chapter or section can contain a <literal>p:title</literal>. The title will be
- displayed next to the chapter/section number. The body of the title may contain raw text
- or may be a <literal>p:paragraph</literal>. </para>
+ displayed next to the chapter/section number. The body of the title may contain raw
+ text or may be a <literal>p:paragraph</literal>. </para>
</entry>
</row>
@@ -843,8 +848,8 @@
<para>List structures can be displayed using the <literal>p:list</literal> and <literal>p:listItem</literal>
tags. Lists may contain arbitrarily-nested sublists. List items may not be used outside of a list. he
- following document uses the <literal>ui:repeat</literal> tag to to display a list of values retrieved from a
- Seam component. </para>
+ following document uses the <literal>ui:repeat</literal> tag to to display a list of values retrieved
+ from a Seam component. </para>
<programlisting><p:document xmlns:p="http://jboss.com/products/seam/pdf"
xmlns:ui="http://java.sun.com/jsf/facelets"
@@ -884,15 +889,15 @@
<itemizedlist>
<listitem>
- <para><literal>style</literal> — The ordering/bulleting style of list. One
- of: <literal>NUMBERED</literal>, <literal>LETTERED</literal>,
+ <para><literal>style</literal> — The ordering/bulleting style of list.
+ One of: <literal>NUMBERED</literal>, <literal>LETTERED</literal>,
<literal>GREEK</literal>, <literal>ROMAN</literal>,
- <literal>ZAPFDINGBATS</literal>, <literal>ZAPFDINGBATS_NUMBER</literal>. If no
- style is given, the list items are bulleted.</para>
+ <literal>ZAPFDINGBATS</literal>, <literal>ZAPFDINGBATS_NUMBER</literal>.
+ If no style is given, the list items are bulleted.</para>
</listitem>
<listitem>
- <para><literal>listSymbol</literal> — For bulleted lists, specifies the
- bullet symbol. </para>
+ <para><literal>listSymbol</literal> — For bulleted lists, specifies
+ the bullet symbol. </para>
</listitem>
<listitem>
@@ -914,8 +919,8 @@
<listitem>
- <para><literal>numberType</literal> — For ZAPFDINGBATS_NUMBER, indicates
- the numbering style.</para>
+ <para><literal>numberType</literal> — For ZAPFDINGBATS_NUMBER,
+ indicates the numbering style.</para>
</listitem>
</itemizedlist>
@@ -963,14 +968,14 @@
<listitem>
<para>
- <literal>alignment</literal> — The alignment of the header/footer box
- section. (see <xref linkend="itext.alignment"/> for alignment values)</para>
+ <literal>alignment</literal> — The alignment of the header/footer
+ box section. (see <xref linkend="itext.alignment"/> for alignment values)</para>
</listitem>
<listitem>
- <para><literal>alignment</literal> — The alignment of the list item. (See
- <xref linkend="itext.alignment"/> for possible values)</para>
+ <para><literal>alignment</literal> — The alignment of the list item.
+ (See <xref linkend="itext.alignment"/> for possible values)</para>
</listitem>
@@ -989,8 +994,8 @@
<listitem>
- <para><literal>listSymbol</literal> — Overrides the default list symbol
- for this list item.</para>
+ <para><literal>listSymbol</literal> — Overrides the default list
+ symbol for this list item.</para>
</listitem>
@@ -1014,10 +1019,10 @@
<section id="itext.tables">
<title>Tables</title>
- <para>Table structures can be created using the <literal>p:table</literal> and <literal>p:cell</literal> tags.
- Unlike many table structures, there is no explicit row declaration. If a table has 3 columns, then every 3
- cells will automatically form a row. Header and footer rows can be declared, and the headers and footers
- will be repeated in the event a table structure spans multiple pages.</para>
+ <para>Table structures can be created using the <literal>p:table</literal> and <literal>p:cell</literal>
+ tags. Unlike many table structures, there is no explicit row declaration. If a table has 3 columns, then
+ every 3 cells will automatically form a row. Header and footer rows can be declared, and the headers and
+ footers will be repeated in the event a table structure spans multiple pages.</para>
<programlisting><p:document xmlns:p="http://jboss.com/products/seam/pdf"
xmlns:ui="http://java.sun.com/jsf/facelets"
@@ -1062,8 +1067,8 @@
<listitem>
- <para><literal>columns</literal> — The number of columns (cells) that make
- up a table row.</para>
+ <para><literal>columns</literal> — The number of columns (cells) that
+ make up a table row.</para>
</listitem>
@@ -1071,16 +1076,16 @@
<listitem>
<para><literal>widths</literal> — The relative widths of each column.
There should be one value for each column. For example: widths="2 1 1" would
- indicate that there are 3 columns and the first column should be twice the size
- of the second and third column.</para>
+ indicate that there are 3 columns and the first column should be twice the
+ size of the second and third column.</para>
</listitem>
<listitem>
- <para><literal>headerRows</literal> — The initial number of rows which are
- considered to be headers or footer rows and should be repeated if the table
- spans multiple pages. </para>
+ <para><literal>headerRows</literal> — The initial number of rows which
+ are considered to be headers or footer rows and should be repeated if the
+ table spans multiple pages. </para>
</listitem>
@@ -1088,9 +1093,10 @@
<listitem>
<para><literal>footerRows</literal> — The number of rows that are
considered to be footer rows. This value is subtracted from the
- <literal>headerRows</literal> value. If document has 2 rows which make up
- the header and one row that makes up the footer, <literal>headerRows</literal>
- should be set to 3 and <literal>footerRows</literal> should be set to 1</para>
+ <literal>headerRows</literal> value. If document has 2 rows which make
+ up the header and one row that makes up the footer,
+ <literal>headerRows</literal> should be set to 3 and
+ <literal>footerRows</literal> should be set to 1</para>
</listitem>
@@ -1101,8 +1107,9 @@
</listitem>
<listitem>
- <para><literal>horizontalAlignment</literal> — The horizontal alignment of
- the table. (See <xref linkend="itext.alignment"/> for possible values)</para>
+ <para><literal>horizontalAlignment</literal> — The horizontal
+ alignment of the table. (See <xref linkend="itext.alignment"/> for possible
+ values)</para>
</listitem>
<listitem>
@@ -1134,8 +1141,8 @@
<listitem>
- <para><literal>spacingBefore</literal> — The blank space to be inserted
- before the element.</para>
+ <para><literal>spacingBefore</literal> — The blank space to be
+ inserted before the element.</para>
</listitem>
@@ -1211,23 +1218,24 @@
<listitem>
<para>
- <literal>colspan</literal> — Cells can span more than one column by
- declaring a <literal>colspan</literal> greater than 1. Tables do not have the
- ability to span across multiple rows. </para>
+ <literal>colspan</literal> — Cells can span more than one column
+ by declaring a <literal>colspan</literal> greater than 1. Tables do not have
+ the ability to span across multiple rows. </para>
</listitem>
<listitem>
- <para><literal>horizontalAlignment</literal> — The horizontal alignment of
- the cell. (see <xref linkend="itext.alignment"/> for possible values)</para>
+ <para><literal>horizontalAlignment</literal> — The horizontal
+ alignment of the cell. (see <xref linkend="itext.alignment"/> for possible
+ values)</para>
</listitem>
<listitem>
- <para><literal>verticalAlignment</literal> — The vertical alignment of the
- cell. (see <xref linkend="itext.alignment"/> for possible values)</para>
+ <para><literal>verticalAlignment</literal> — The vertical alignment of
+ the cell. (see <xref linkend="itext.alignment"/> for possible values)</para>
</listitem>
@@ -1235,8 +1243,9 @@
<listitem>
<para>
<literal>padding</literal> — Padding on a given side can also be
- specified using <literal>paddingLeft</literal>, <literal>paddingRight</literal>,
- <literal>paddingTop</literal> and <literal>paddingBottom</literal>.</para>
+ specified using <literal>paddingLeft</literal>,
+ <literal>paddingRight</literal>, <literal>paddingTop</literal> and
+ <literal>paddingBottom</literal>.</para>
</listitem>
@@ -1375,13 +1384,14 @@
<para>This section documents some of the constants shared by attributes on multiple tags. </para>
- <section id="itext.color">
+ <section id="itext.colors">
<title>Color Values</title>
<para>Seam documents do not yet support a full color specification. Currently, only named colors are
- supported. They are: <literal>white</literal>, <literal>gray</literal>, <literal>lightgray</literal>,
- <literal>darkgray</literal>, <literal>black</literal>, <literal>red</literal>,
- <literal>pink</literal>, <literal>yellow</literal>, <literal>green</literal>,
- <literal>magenta</literal>, <literal>cyan</literal> and <literal>blue</literal>. </para>
+ supported. They are: <literal>white</literal>, <literal>gray</literal>,
+ <literal>lightgray</literal>, <literal>darkgray</literal>, <literal>black</literal>,
+ <literal>red</literal>, <literal>pink</literal>, <literal>yellow</literal>,
+ <literal>green</literal>, <literal>magenta</literal>, <literal>cyan</literal> and
+ <literal>blue</literal>. </para>
</section>
@@ -1399,13 +1409,14 @@
<section id="itext.configuration">
<title>Configuring iText</title>
- <para>Document generation works out of the box with no additional configuration needed. However, there are a few
- points of configuration that are needed for more serious applications. </para>
+ <para>Document generation works out of the box with no additional configuration needed. However, there are a
+ few points of configuration that are needed for more serious applications. </para>
- <para> The default implementation serves PDF documents from a generic URL, <literal>/seam-doc.seam</literal>.
- Many browsers (and users) would prefer to see URLs that contain the actual PDF name like
- <literal>/myDocument.pdf</literal>. This capability requires some configuration. To serve PDF files, all
- *.pdf resources should be mapped to the Seam Servlet Filter and to the DocumentStoreServlet:</para>
+ <para> The default implementation serves PDF documents from a generic URL,
+ <literal>/seam-doc.seam</literal>. Many browsers (and users) would prefer to see URLs that contain the
+ actual PDF name like <literal>/myDocument.pdf</literal>. This capability requires some configuration. To
+ serve PDF files, all *.pdf resources should be mapped to the Seam Servlet Filter and to the
+ DocumentStoreServlet:</para>
<programlisting><filter>
<filter-name>Seam Servlet Filter</filter-name>
@@ -1427,20 +1438,780 @@
<url-pattern>*.pdf</url-pattern>
</servlet-mapping></programlisting>
- <para> The <literal>useExtensions</literal> option on the document store component completes the functionality
- by instructing the document store to generate URLs with the correct filename extension for the document type
- being generated. </para>
+ <para> The <literal>useExtensions</literal> option on the document store component completes the
+ functionality by instructing the document store to generate URLs with the correct filename extension for
+ the document type being generated. </para>
<programlisting><components xmlns="http://jboss.com/products/seam/components"
xmlns:pdf="http://jboss.com/products/seam/pdf">
<pdf:documentStore useExtensions="true" />
</components></programlisting>
- <para> Generated documents are stored in conversation scope and will expire when the conversation ends. At that
- point, references to the document will be invalid. To You can specify a default view to be shown when a
- document does not exist using the <literal>errorPage</literal> property of the documentStore. </para>
+ <para> Generated documents are stored in conversation scope and will expire when the conversation ends. At
+ that point, references to the document will be invalid. To You can specify a default view to be shown
+ when a document does not exist using the <literal>errorPage</literal> property of the documentStore. </para>
<programlisting><pdf:documentStore useExtensions="true" errorPage="/pdfMissing.seam" /></programlisting>
</section>
+ </section>
+
+
+ <section id="itext.charting">
+ <title>Charting</title>
+
+
+ <informaltable id="itext.barchart">
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+
+ <tbody>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><p:barchart></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <para>
+ <emphasis>Description</emphasis>
+ </para>
+ <para>Displays a bar chart.</para>
+ <para>
+ <emphasis>Attributes</emphasis>
+ </para>
+
+ <itemizedlist>
+ <!--- UICategoryChartBase -->
+ <listitem>
+ <para>
+ <literal>domainGridlinesVisible</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>domainGridlinePaint</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>domainGridlineStroke</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>rangeGridlinesVisible</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>rangeGridlinesVisible</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>rangeGridlinePaint</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>rangeGridlinePaint</literal>
+ </para>
+ </listitem>
+ <!--- UIBarChart -->
+
+
+
+ <listitem>
+ <para>
+ <literal>title</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>categoryAxisLabel</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>valueAxisLabel</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>orientation</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>legend</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>is3D</literal>
+ </para>
+ </listitem>
+
+
+ </itemizedlist>
+ <para>
+ <emphasis>Usage</emphasis>
+ </para>
+ <programlisting/>
+
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+
+ <informaltable id="itext.linechart">
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+
+ <tbody>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><p:linechart></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <para>
+ <emphasis>Description</emphasis>
+ </para>
+ <para>Displays a line chart.</para>
+ <para>
+ <emphasis>Attributes</emphasis>
+ </para>
+
+ <itemizedlist>
+
+ <!--- UICategoryChartBase -->
+ <listitem>
+ <para>
+ <literal>domainGridlinesVisible</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>domainGridlinePaint</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>domainGridlineStroke</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>rangeGridlinesVisible</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>rangeGridlinesVisible</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>rangeGridlinePaint</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>rangeGridlinePaint</literal>
+ </para>
+ </listitem>
+ <!--- UILineChart -->
+
+ <listitem>
+ <para>
+ <literal>title</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>domainAxisLabel</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>rangeAxisLabel</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>orientation</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>legend</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>is3D</literal>
+ </para>
+ </listitem>
+
+
+ </itemizedlist>
+ <para>
+ <emphasis>Usage</emphasis>
+ </para>
+ <programlisting/>
+
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+ <informaltable id="itext.piechart">
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+
+ <tbody>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><p:piechart></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <para>
+ <emphasis>Description</emphasis>
+ </para>
+ <para>Displays a pie chart.</para>
+ <para>
+ <emphasis>Attributes</emphasis>
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>title</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>label</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>legend</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>is3D</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>labelLinkMargin</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>labelLinkPaint</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>labelLinkStroke</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>labelLinksVisible</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>labelOutlinePaint</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>labelOutlineStroke</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>labelShadowPaint</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>labelPaint</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>labelGap</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>labelBackgroundPaint</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>startAngle</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>circular</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>direction</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>sectionOutlinePaint</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>sectionOutlineStroke</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>sectionOutlinesVisible</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>baseSectionOutlinePaint</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>baseSectionPaint</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>baseSectionOutlineStroke</literal>
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ <para>
+ <emphasis>Usage</emphasis>
+ </para>
+ <programlisting/>
+
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+
+ <informaltable id="itext.series">
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+
+ <tbody>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><p:series></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <para>
+ <emphasis>Description</emphasis>
+ </para>
+ <para>Category data can be broken down into series. The series tag is
+ used to categorize a set of data with a series and apply styling to the entire series.
+
+ </para>
+ <para>
+ <emphasis>Attributes</emphasis>
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>key</literal> — The series name.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>seriesPaint</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>seriesFillPaint</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>seriesOutlinePaint</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>seriesOutlineStroke</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>seriesStroke</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>seriesVisible</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>seriesVisibleInLegend</literal>
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ <para>
+ <emphasis>Usage</emphasis>
+ </para>
+ <programlisting><p:barchart title="Bar Chart3D">
+ <p:series key="data1">
+ <ui:repeat value="#{data.pieData1}" var="item">
+ <p:data columnKey="#{item.name}" value="#{item.value}" />
+ </ui:repeat>
+ </p:series>
+ <p:series key="data2" seriesPaint="green" seriesStroke="dot2">
+ <ui:repeat value="#{data.pieData2}" var="item">
+ <p:data columnKey="#{item.name}" value="#{item.value}" />
+ </ui:repeat>
+ </p:series>
+</p:barchart></programlisting>
+
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+ <informaltable id="itext.chartdata">
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+
+ <tbody>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><p:data></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <para>
+ <emphasis>Description</emphasis>
+ </para>
+ <para>The data tag describes each data point to be displayed in the graph.</para>
+ <para>
+ <emphasis>Attributes</emphasis>
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal>key</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>columnKey</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>rowKey</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>value</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>explodedPercent</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>sectionPaint</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>sectionOutlinePaint</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>sectionOutlineStroke</literal>
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ <emphasis>Usage</emphasis>
+ </para>
+ <programlisting/>
+
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+
+
+ <informaltable id="itext.color">
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+
+ <tbody>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><p:color></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <para>
+ <emphasis>Description</emphasis>
+ </para>
+ <para>The color component declares a color or gradient than can be referenced when drawing
+ filled shapes. </para>
+ <para>
+ <emphasis>Attributes</emphasis>
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>color</literal> — The color value. For gradient colors, this
+ the starting color. <link linkend="itext.colors"/>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>color2</literal> — For gradient colors, this is the color
+ that ends the gradient. </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>point</literal> — The co-ordinates where the gradient color
+ begins. </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>point2</literal> — The co-ordinates where the gradient color
+ ends. </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ <emphasis>Usage</emphasis>
+ </para>
+ <programlisting><p:color id="foo" color="#0ff00f"/>
+<p:color id="bar" color="#ff00ff" color2="#00ff00"
+ point="50 50" point2="300 300"/> </programlisting>
+
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+
+ <informaltable id="itext.stroke">
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+
+ <tbody>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><p:stroke></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <para>
+ <emphasis>Description</emphasis>
+ </para>
+ <para>Describes a stroke used to draw lines in a chart.</para>
+ <para>
+ <emphasis>Attributes</emphasis>
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>width</literal> — The width of the stroke. </para>
+ </listitem>
+
+ <listitem>
+ <para><literal>cap</literal> — The line cap type. Valid values are
+ <literal>butt</literal>, <literal>round</literal> and
+ <literal>square</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>join</literal> — The line join type. Valid values are
+ <literal>miter</literal>, <literal>round</literal> and
+ <literal>bevel</literal></para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>miterLimit</literal> — For miter joins, this value is the
+ limit of the size of the join. </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>dash</literal> — The dash value sets the dash pattern to be
+ used to draw the line. The space separated integers indicate the length of each
+ alternating drawn and undrawn segments. </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>dashPhase</literal> — The dash phase indicates the offset
+ into the dash pattern that the the line should be drawn with. </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ <emphasis>Usage</emphasis>
+ </para>
+ <programlisting><p:stroke id="dot2" width="2" cap="round" join="bevel" dash="2 3" /> </programlisting>
+
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+
+ </section>
+
+ <section id="itext.barcodes">
+ <title>Bar codes</title>
+ <para>...</para>
+
+ <informaltable id="itext.barcode">
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+
+ <tbody>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><p:barcode></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <para>
+ <emphasis>Description</emphasis>
+ </para>
+ <para/>
+ <para>
+ <emphasis>Attributes</emphasis>
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>type</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>code</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>xpos</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>ypos</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>rotDegrees</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>barHeight</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>textSize</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>minBarWidth</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>barMultiplier</literal>
+ </para>
+ </listitem>
+
+
+ </itemizedlist>
+ <para>
+ <emphasis>Usage</emphasis>
+ </para>
+ <programlisting/>
+
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
+
<section id="itext.links">
More information about the jboss-cvs-commits
mailing list