[jboss-cvs] JBossAS SVN: r103797 - projects/docs/enterprise/5.0/Seam_Reference_Guide/en-US.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Mon Apr 12 02:28:02 EDT 2010
Author: misty at redhat.com
Date: 2010-04-12 02:28:02 -0400 (Mon, 12 Apr 2010)
New Revision: 103797
Modified:
projects/docs/enterprise/5.0/Seam_Reference_Guide/en-US/Itext.xml
Log:
Chapter almost done
Modified: projects/docs/enterprise/5.0/Seam_Reference_Guide/en-US/Itext.xml
===================================================================
--- projects/docs/enterprise/5.0/Seam_Reference_Guide/en-US/Itext.xml 2010-04-12 06:27:10 UTC (rev 103796)
+++ projects/docs/enterprise/5.0/Seam_Reference_Guide/en-US/Itext.xml 2010-04-12 06:28:02 UTC (rev 103797)
@@ -205,7 +205,7 @@
<varlistentry>
<term>Usage</term>
<listitem>
- <para><code><![CDATA[<p:document xmlns:p="http://jboss.com/products/seam/pdf"> The document goes here. </p:document>]]></code></para>
+ <para><code><![CDATA[<p:document xmlns:p="http://jboss.com/products/seam/pdf"> The document goes here. </p:document>]]></code></para>
</listitem>
</varlistentry>
</listitem>
@@ -643,7 +643,7 @@
<term>Usage</term>
<listitem>
<para>
- <code><![CDATA[<p:paragraph alignment="justify"> This is a simple document. It isn't very fancy. </p:paragraph>]]></code>
+ <code><![CDATA[<p:paragraph alignment="justify"> This is a simple document. It isn't very fancy. </p:paragraph>]]></code>
</para>
</listitem>
</varlistentry>
@@ -680,8 +680,8 @@
<varlistentry>
<term>Usage</term>
<listitem>
- <programlisting>
- <![CDATA[<p:paragraph> The item costs <p:text value="#{product.price}"> <f:convertNumber type="currency" currencySymbol="$"/> </p:text> </p:paragraph>]]>
+ <programlisting role="XML">
+ <![CDATA[<p:paragraph> The item costs <p:text value="#{product.price}"> <f:convertNumber type="currency" currencySymbol="$"/> </p:text> </p:paragraph>]]>
</programlisting>
</listitem>
</varlistentry>
@@ -709,22 +709,22 @@
<varlistentry>
<term>Usage</term>
<listitem>
- <programlisting>
- <![CDATA[
- <p:html value="This is HTML with <b>some markup</b>." />
- <p:html>
- <h1>This is more complex HTML</h1>
- <ul>
- <li>one</li>
- <li>two</li>
- <li>three</li>
- </ul>
- </p:html>
+ <programlisting role="XML">
+ <![CDATA[
+ <p:html value="This is HTML with <b>some markup</b>." />
+ <p:html>
+ <h1>This is more complex HTML</h1>
+ <ul>
+ <li>one</li>
+ <li>two</li>
+ <li>three</li>
+ </ul>
+ </p:html>
- <p:html>
- <s:formattedText value="*This* is |Seam Text| as HTML. It's very^cool^." />
- </p:html>
- ]]>
+ <p:html>
+ <s:formattedText value="*This* is |Seam Text| as HTML. It's very^cool^." />
+ </p:html>
+ ]]>
</programlisting>
</listitem>
</varlistentry>
@@ -770,8 +770,8 @@
<varlistentry>
<term>Usage</term>
<listitem>
- <programlisting>
- <![CDATA[<p:font name="courier" style="bold" size="24"> <p:paragraph>My Title</p:paragraph> </p:font>]]>
+ <programlisting role="XML">
+ <![CDATA[<p:font name="courier" style="bold" size="24"> <p:paragraph>My Title</p:paragraph> </p:font>]]>
</programlisting>
</listitem>
</varlistentry>
@@ -791,19 +791,20 @@
</para>
</listitem>
</varlistentry>
+ <!--
<varlistentry>
<term>Attributes</term>
<listitem>
<para>
- None
</para>
</listitem>
</varlistentry>
+ -->
<varlistentry>
<term>Usage</term>
<listitem>
- <programlisting>
- <![CDATA[<p:newPage />]]>
+ <programlisting role="XML">
+ <![CDATA[<p:newPage />]]>
</programlisting>
</listitem>
</varlistentry>
@@ -830,81 +831,81 @@
<term>Attributes</term>
<listitem>
<variablelist>
- <varlistitem>
+ <varlistentry>
<term>value</term>
<listitem><para>A resource name or a method expression that binds to an application.</para></listitem>
- </varlistitem>
- <varlistitem>
+ </varlistentry>
+ <varlistentry>
<term>rotation</term>
<listitem><para>The rotation of the image in degrees. </para></listitem>
- </varlistitem>
- <varlistitem>
+ </varlistentry>
+ <varlistentry>
<term>height</term>
<listitem><para>The height of the image.</para></listitem>
- </varlistitem>
- <varlistitem>
+ </varlistentry>
+ <varlistentry>
<term>width</term>
<listitem><para>The width of the image. </para></listitem>
- </varlistitem>
- <varlistitem>
+ </varlistentry>
+ <varlistentry>
<term>alignment</term>
<listitem><para>The alignment of the image. (See <xref linkend="itext.alignment" /> for possible values.)</para></listitem>
- </varlistitem>
- <varlistitem>
+ </varlistentry>
+ <varlistentry>
<term>alt</term>
<listitem><para>Alternative text representation for the image.</para></listitem>
- </varlistitem>
- <varlistitem>
+ </varlistentry>
+ <varlistentry>
<term>indentationLeft</term>
<listitem><para></para></listitem>
- </varlistitem>
- <varlistitem>
+ </varlistentry>
+ <varlistentry>
<term>indentationRight</term>
<listitem><para></para></listitem>
- </varlistitem>
- <varlistitem>
+ </varlistentry>
+ <varlistentry>
<term>spacingBefore</term>
<listitem><para>The blank space to be inserted before the element.</para></listitem>
- </varlistitem>
- <varlistitem>
+ </varlistentry>
+ <varlistentry>
<term>spacingAfter</term>
<listitem><para>The blank space to be inserted after the element.</para></listitem>
- </varlistitem>
- <varlistitem>
+ </varlistentry>
+ <varlistentry>
<term>widthPercentage</term>
<listitem><para></para></listitem>
- </varlistitem>
- <varlistitem>
+ </varlistentry>
+ <varlistentry>
<term>initialRotation</term>
<listitem><para></para></listitem>
- </varlistitem>
- <varlistitem>
+ </varlistentry>
+ <varlistentry>
<term>dpi</term>
<listitem><para></para></listitem>
- </varlistitem>
- <varlistitem>
+ </varlistentry>
+ <varlistentry>
<term>scalePercent</term>
<listitem><para>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>
- </varlistitem>
- <varlistitem>
+ </varlistentry>
+ <varlistentry>
<term>wrap</term>
<listitem><para></para></listitem>
- </varlistitem>
- <varlistitem>
+ </varlistentry>
+ <varlistentry>
<term>underlying</term>
<listitem><para></para></listitem>
- </varlistitem>
+ </varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term>Usage</term>
<listitem>
- <programlisting>
- <![CDATA[<p:image value="/jboss.jpg" />]]>
+ <programlisting role="XML">
+ <![CDATA[<p:image value="/jboss.jpg" />]]>
</programlisting>
- <programlisting>
- <![CDATA[<p:image value="#{images.chart}" />]]>
+ <programlisting role="XML">
+ <![CDATA[<p:image value="#{images.chart}" />]]>
</programlisting>
</listitem>
</varlistentry>
@@ -940,8 +941,8 @@
<varlistentry>
<term>Usage</term>
<listitem>
- <programlisting>
- <![CDATA[<p:listItem><p:anchor reference="#reason1">Reason 1</p:anchor></p:listItem> ... <p:paragraph> <p:anchor name="reason1">It's the quickest way to get "rich"</p:anchor> ... </p:paragraph>]]>
+ <programlisting role="XML">
+ <![CDATA[<p:listItem><p:anchor reference="#reason1">Reason 1</p:anchor></p:listItem> ... <p:paragraph> <p:anchor name="reason1">It's the quickest way to get "rich"</p:anchor> ... </p:paragraph>]]>
</programlisting>
</listitem>
</varlistentry>
@@ -956,6 +957,7 @@
<section id="itext.header">
<title>Headers and Footers</title>
+ <!--
<informaltable>
<tgroup cols="2">
<colspec colnum="1" colwidth="1*"></colspec>
@@ -1044,10 +1046,120 @@
</tbody>
</tgroup>
</informaltable>
+ -->
+ <remark>Rewriting the above table as a variablelist for Publican compatibility</remark>
+
+
+ <variablelist>
+ <varlistentry>
+ <term><p:header></term>
+ <term><p:footer></term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>Description</term>
+ <listitem>
+ <para>
+ The <varname>p:header</varname> and <varname>p:footer</varname> components let you place header and footer text on each page of a generated document. Header and footer declarations should appear at the beginning of a document.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Attributes</term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>alignment</term>
+ <listitem>
+ <para>
+ The alignment of the header/footer box section. (See <xref linkend="itext.colors" /> for alignment values.)
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>backgroundColor</term>
+ <listitem>
+ <para>
+ The background color of the header/footer box. (See <xref linkend="itext.colors" /> for color values.)
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>borderColor</term>
+ <listitem>
+ <para>
+ The border color of the header/footer box. Individual border sides can be set using <property>borderColorLeft</property>, <property>borderColorRight</property>, <property>borderColorTop</property> and <property>borderColorBottom</property>. (See <xref linkend="itext.colors" /> for color values.)
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>borderWidth</term>
+ <listitem>
+ <para>
+ The width of the border. Individual border sides can be specified using <property>borderWidthLeft</property>, <property>borderWidthRight</property>, <property>borderWidthTop</property> and <property>borderWidthBottom</property>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Usage</term>
+ <listitem>
+ <programlisting role="XML">
+ <![CDATA[<p:facet name="header">
+ <p:font size="12">
+ <p:footer borderWidthTop="1" borderColorTop="blue"
+ borderWidthBottom="0" alignment="center">
+ Why Seam? [<p:pageNumber />]
+ </p:footer>
+ </p:font>
+ </f:facet>]]>
+ </programlisting>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><p:pageNumber></term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>Description</term>
+ <listitem>
+ <para>
+ The current page number can be placed inside a header or footer with the p:pageNumber tag. The page number tag can only be used in the context of a header or footer and can only be used once.
+ </para>
+ </listitem>
+ </varlistentry>
+ <!--
+ <varlistentry>
+ <term>Attributes</term>
+ <listitem>
+
+ </listitem>
+ </varlistentry>
+ -->
+ <varlistentry>
+ <term>Usage</term>
+ <listitem>
+ <programlisting role="XML">
+ <p:footer borderWidthTop="1" borderColorTop="blue" borderWidthBottom="0" alignment="center"> Why Seam? [<p:pageNumber />] </p:footer>
+ </programlisting>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
</section>
<section id="itext.chapters">
<title>Chapters and Sections</title>
+ <!--
<informaltable>
<tgroup cols="2">
<colspec colnum="1" colwidth="1*"></colspec>
@@ -1130,6 +1242,112 @@
</tbody>
</tgroup>
</informaltable>
+ -->
+
+ <remark>Rewriting the above table for Publican compatibility</remark>
+
+ <variablelist>
+ <varlistentry>
+ <term><p:chapter></term>
+ <term><p:section></term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>Description</term>
+ <listitem>
+ <para>
+ If the generated document follows a book/article structure, the <varname>p:chapter</varname> and <varname>p:section</varname> tags can be used to provide structure. Sections can only be used inside chapters, but they may be nested to any depth required. Most PDF viewers provide easy navigation between chapters and sections in a document.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Attributes</term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>alignment</term>
+ <listitem>
+ <para>
+ The alignment of the header/footer box section. (See <xref linkend="itext.alignment" /> for alignment values.)
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>number</term>
+ <listitem>
+ <para>
+ The chapter number. Every chapter should be assigned a chapter number.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>numberDepth</term>
+ <listitem>
+ <para>
+ The depth of numbering for section. All sections are numbered relative to their surrounding chapters/sections. The fourth section of the first section of chapter three would be section 3.1.4, if displayed at the default number depth of 3. To omit the chapter number, a number depth of 2 should be used — this would display the section number as 1.4.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Usage</term>
+ <listitem>
+ <programlisting role="XML">
+ <![CDATA[<p:document xmlns:p="http://jboss.com/products/seam/pdf"
+ title="Hello">
+
+ <p:chapter number="1">
+ <p:title><p:paragraph>Hello</p:paragraph></p:title>
+ <p:paragraph>Hello #{user.name}!</p:paragraph>
+ </p:chapter>
+
+ <p:chapter number="2">
+ <p:title><p:paragraph>Goodbye</p:paragraph></p:title>
+ <p:paragraph>Goodbye #{user.name}.</p:paragraph>
+ </p:chapter>
+
+ </p:document> ]]>
+ </programlisting>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><p:header></term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>Description</term>
+ <listitem>
+ <para>
+ Any chapter or section can contain a <varname>p:title</varname>. The title will be displayed next to the chapter or section number. The body of the title may contain raw text or may be a <varname>p:paragraph</varname>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <!--
+ <varlistentry>
+ <term>Attributes</term>
+ <listitem>
+
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Usage</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ -->
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
<section id="itext.list">
@@ -1149,6 +1367,7 @@
</p:document>]]>
</programlisting>
+ <!--
<informaltable>
<tgroup cols="2">
<colspec colnum="1" colwidth="1*"></colspec>
@@ -1161,7 +1380,7 @@
</para>
</entry>
<entry valign="top">
- <!-- #modify: ??? description required? <para> <emphasis>Description</emphasis> </para> <para>...</para> --> <para>
+ --> <!-- #modify: ??? description required? <para> <emphasis>Description</emphasis> </para> <para>...</para> --> <!--<para>
<emphasis>Attributes</emphasis>
</para>
<itemizedlist>
@@ -1262,6 +1481,142 @@
</tbody>
</tgroup>
</informaltable>
+ -->
+ <remark>Rewriting the above table for Publican compatibility</remark>
+
+ <variablelist>
+ <varlistentry>
+ <term><p:list></term>
+ <listitem>
+ <variablelist>
+ <!--
+ <varlistentry>
+ <term>Description</term>
+ <listitem></listitem>
+ </varlistentry>
+ -->
+ <varlistentry>
+ <term>Attributes</term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>style</term>
+ <listitem>
+ <para>
+ The ordering/bulleting style of the list. One of: <property>NUMBERED</property>, <property>LETTERED</property>, <property>GREEK</property>, <property>ROMAN</property>, <property>ZAPFDINGBATS</property>, <property>ZAPFDINGBATS_NUMBER</property>. If no style is given, the list items are bulleted by default.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>listSymbol</term>
+ <listitem>
+ <para>
+ For bulleted lists, specifies the bullet symbol.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>indent</term>
+ <listitem>
+ <para>
+ The indentation level of the list.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>lowerCase</term>
+ <listitem>
+ <para>
+ For list styles using letters, indicates whether the letters should be lower case.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>charNumber</term>
+ <listitem>
+ <para>
+ For <property>ZAPFDINGBATS</property>, indicates the character code of the bullet character.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>numberType</term>
+ <listitem>
+ <para>
+ For <property>ZAPFDINGBATS_NUMBER</property>, indicates the numbering style.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Usage</term>
+ <listitem>
+ <programlisting role="XML">
+ <![CDATA[<p:list style="numbered">
+ <ui:repeat value="#{documents}" var="doc">
+ <p:listItem>#{doc.name}</p:listItem>
+ </ui:repeat>
+ </p:list>]]>
+ </programlisting>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><p:listItem></term>
+ <listitem>
+ <variablelist>
+ <!--
+ <varlistentry>
+ <term>Description</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ -->
+ <varlistentry>
+ <term>Attributes</term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>alignment</term>
+ <listitem>
+ <para>
+ The alignment of the header/footer box section. (See <xref linkend="itext.alignment" /> for alignment values.)
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>alignment</term>
+ <listitem>
+ <para>
+ The alignment of the list item. (See <xref linkend="itext.alignment" /> for possible values.)
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <!--
+ <varlistentry>
+ <term>Usage</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ -->
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
<section id="itext.tables">
@@ -1269,6 +1624,7 @@
<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 three columns, then every three 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>
+ <!--
<informaltable>
<tgroup cols="2">
<colspec colnum="1" colwidth="1*"></colspec>
@@ -1523,6 +1879,371 @@
</tbody>
</tgroup>
</informaltable>
+ -->
+
+ <remark>Rewriting above table for Publican compliance</remark>
+
+ <variablelist>
+ <varlistentry>
+ <term><p:table></term>
+ <listitem>
+ <variablelist>
+ <!--
+ <varlistentry>
+ <term>Description</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ -->
+ <varlistentry>
+ <term>Attributes</term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>columns</term>
+ <listitem>
+ <para>
+ The number of columns (cells) that make up a table row.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>widths</term>
+ <listitem>
+ <para>
+ The relative widths of each column. There should be one value for each column. For example: <code>widths="2 1 1"</code> would indicate that there are three columns and the first column should be twice the size of the second and third column.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>headerRows</term>
+ <listitem>
+ <para>
+ The initial number of rows considered to be header and footer rows, which should be repeated if the table spans multiple pages
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>footerRows</term>
+ <listitem>
+ <para>
+ The number of rows considered to be footer rows. This value is subtracted from the <varname>headerRows</varname> value. If document has two rows which make up the header and one row that makes up the footer, <varname>headerRows</varname> should be set to 3 and <varname>footerRows</varname> should be set to 1.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>widthPercentage</term>
+ <listitem>
+ <para>
+ The percentage of the page width spanned by the table.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>horizontalAlignment</term>
+ <listitem>
+ <para>
+ The horizontal alignment of the table. (See <xref linkend="itext.alignment" /> for possible values.)
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>skipFirstHeader</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>runDirection</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>lockedWidth</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>splitRows</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>spacingBefore</term>
+ <listitem>
+ <para>
+ The blank space to be inserted before the element.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>spacingAfter</term>
+ <listitem>
+ <para>
+ The blank space to be inserted after the element.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>extendLastRow</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>headersInEvent</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>splitLate</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>keepTogether</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Usage</term>
+ <listitem>
+ <programlisting role="XML">
+ <![CDATA[<p:table columns="3" headerRows="1">
+ <p:cell>name</p:cell>
+ <p:cell>owner</p:cell>
+ <p:cell>size</p:cell>
+ <ui:repeat value="#{documents}" var="doc">
+ <p:cell>#{doc.name}</p:cell>
+ <p:cell>#{doc.user.name}</p:cell>
+ <p:cell>#{doc.size}</p:cell>
+ </ui:repeat>
+ </p:table>]]>
+ </programlisting>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><p:cell></term>
+ <listitem>
+ <variablelist>
+ <!--
+ <varlistentry>
+ <term>Description</term>
+ <listitem></listitem>
+ </varlistentry>
+ -->
+ <varlistentry>
+ <term>Attributes</term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>colSpan</term>
+ <listitem>
+ <para>
+ Cells can span more than one column by declaring a colspan greater than one. Cells cannot span multiple rows.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>horizontalAlignment</term>
+ <listitem>
+ <para>
+ The horizontal alignment of the cell. (See <xref linkend="itext.alignment" /> for possible values.)
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>verticalAlignment</term>
+ <listitem>
+ <para>
+ The vertical alignment of the cell. (See <xref linkend="itext.alignment" /> for possible values.)
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>padding</term>
+ <listitem>
+ <para>
+ Specify padding on a particular side using <property>paddingLeft</property>, <property>paddingRight</property>, <property>paddingTop</property> and <property>paddingBottom</property>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>useBorderPadding</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>loading</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>multipliedLeading</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>indent</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>extraParagraphSpace</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>fixedHeight</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>noWrap</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>minimumHeight</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>followingIndent</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>rightIndent</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>spaceCharRation</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>runDirection</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>arabicOptions</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>useAscender</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>grayFill</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>rotation</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Usage</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
</section>
<section id="itext.constant">
@@ -1553,6 +2274,7 @@
<para>
Charting support is also provided with <filename>jboss-seam-pdf.jar</filename>. Charts can be used in PDF documents, or as images in an HTML page. To use charting, you will need to add the JFreeChart library (<filename>jfreechart.jar</filename> and <filename>jcommon.jar</filename>) 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">
<colspec colnum="1" colwidth="1*"></colspec>
@@ -2121,7 +2843,7 @@
<literal>key</literal> — The series name.
</para>
</listitem>
- <!-- <listitem> <para> <literal>seriesFillPaint</literal> — </para> </listitem> --> <listitem>
+--> <!-- <listitem> <para> <literal>seriesFillPaint</literal> — </para> </listitem> --> <!--<listitem>
<para>
<literal>seriesPaint</literal> — The color of each item in the series.
</para>
@@ -2136,7 +2858,7 @@
<literal>seriesOutlineStroke</literal> — The stroke used to draw each item in the series.
</para>
</listitem>
- <!-- <listitem> <para> <literal>seriesStroke</literal> </para> </listitem> --> <listitem>
+ --><!-- <listitem> <para> <literal>seriesStroke</literal> </para> </listitem> --> <!--<listitem>
<para>
<literal>seriesVisible</literal> — A Boolean indicating if the series should be displayed.
</para>
@@ -2331,13 +3053,1135 @@
</tbody>
</tgroup>
</informaltable>
+ -->
+ <remark>Rewriting the above table for Publican compatibility</remark>
+
+ <variablelist>
+ <varlistentry>
+ <term><p:barChart></term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>Description</term>
+ <listitem>
+ <para>
+ Displays a bar chart.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Attributes</term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>borderVisible</term>
+ <listitem>
+ <para>
+ Controls whether or not a border is displayed around the entire chart.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>borderPaint</term>
+ <listitem>
+ <para>
+ The color of the border, if visible.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>borderBackgroundPaint</term>
+ <listitem>
+ <para>
+ The default background color of the chart.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>borderStroke</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>domainAxisLabel</term>
+ <listitem>
+ <para>
+ The text label for the domain axis.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>domainLabelPosition</term>
+ <listitem>
+ <para>
+ The angle of the domain axis category labels. Valid values are <property>STANDARD</property>, <property>UP_45</property>, <property>UP_90</property>, <property>DOWN_45</property> and <property>DOWN_90</property>. The value can also be a positive or negative angle in radians.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>domainAxisPaint</term>
+ <listitem>
+ <para>
+ The color of the domain axis label.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>domainGridlinesVisible</term>
+ <listitem>
+ <para>
+ Controls whether or not gridlines for the domain axis are shown on the chart.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>domainGridlinesPaint</term>
+ <listitem>
+ <para>
+ The color of the domain gridlines, if visible.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>domainGridlinesStroke</term>
+ <listitem>
+ <para>
+ The stroke style of the domain gridlines, if visible.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>height</term>
+ <listitem>
+ <para>
+ The height of the chart.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>width</term>
+ <listitem>
+ <para>
+ The width of the chart.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>is3D</term>
+ <listitem>
+ <para>
+ A Boolean value indicating that the chart should be rendered in 3D instead of 2D.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>legend</term>
+ <listitem>
+ <para>
+ A Boolean value indicating whether or not the chart should include a legend.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>legendItemPaint</term>
+ <listitem>
+ <para>
+ The default colorof the text labels in the legend.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>legendItemBackgroundPaint</term>
+ <listitem>
+ <para>
+ The background color for the legend, if different from the chart background color.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>legendOutlinePaint</term>
+ <listitem>
+ <para>
+ The color of the border around the legend.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>orientation</term>
+ <listitem>
+ <para>
+ The orientation of the plot, either <property>vertical</property> (the default) or <property>horizontal</property>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>plotBackgroundPaint</term>
+ <listitem>
+ <para>
+ The color of the plot background.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>plotBackgroundAlpha</term>
+ <listitem>
+ <para>
+ The alpha (transparency) level of the plot background. This should be a number between 0 (completely transparent) and 1 (completely opaque).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>plotForegroundAlpha</term>
+ <listitem>
+ <para>
+ The alpha (transparency) level of the plot. This should be a number between 0 (completely transparent) and 1 (completely opaque).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>plotOutlinePaint</term>
+ <listitem>
+ <para>
+ The color of the range gridlines, if visible.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>plotOutlineStroke</term>
+ <listitem>
+ <para>
+ The stroke style of the range gridlines, if visible.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>rangeAxisLabel</term>
+ <listitem>
+ <para>
+ The text label for the range axis.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>rangeAxisPaint</term>
+ <listitem>
+ <para>
+ The color of the range axis label.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>rangeGridlinesVisible</term>
+ <listitem>
+ <para>
+ Controls whether or not gridlines for the range axis are shown on the chart.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>rangeGridlinesPaint</term>
+ <listitem>
+ <para>
+ The color of the range gridlines, if visible.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>rangeGridlinesStroke</term>
+ <listitem>
+ <para>
+ The stroke style of the range gridlines, if visible.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>title</term>
+ <listitem>
+ <para>
+ The chart title text.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>titlepaint</term>
+ <listitem>
+ <para>
+ The color of the chart title text.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>titleBackgroundPaint</term>
+ <listitem>
+ <para>
+ The background color around the chart title.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>width</term>
+ <listitem>
+ <para>
+ The width of the chart.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Usage</term>
+ <listitem>
+ <programlisting role="XML">
+ <![CDATA[<p:barchart title="Bar Chart" legend="true"
+ width="500" height="500">
+ <p:series key="Last Year">
+ <p:data columnKey="Joe" value="100" />
+ <p:data columnKey="Bob" value="120" />
+ </p:series> <p:series key="This Year">
+ <p:data columnKey="Joe" value="125" />
+ <p:data columnKey="Bob" value="115" />
+ </p:series>
+ </p:barchart>]]>
+ </programlisting>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><p:linechart></term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>Description</term>
+ <listitem>
+ <para>
+ Displays a line chart.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Attributes</term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>borderVisible</term>
+ <listitem>
+ <para>
+ Controls whether or not a border is displayed around the entire chart.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>borderPaint</term>
+ <listitem>
+ <para>
+ The color of the border, if visible.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>borderBackgroundPaint</term>
+ <listitem>
+ <para>
+ The default background color of the chart.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>borderStroke</term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>domainAxisLabel</term>
+ <listitem>
+ <para>
+ The text label for the domain axis.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>domainLabelPosition</term>
+ <listitem>
+ <para>
+ The angle of the domain axis category labels. Valid values are <property>STANDARD</property>, <property>UP_45</property>, <property>UP_90</property>, <property>DOWN_45</property> and <property>DOWN_90</property>. The value can also be a positive or negative angle in radians.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>domainAxisPaint</term>
+ <listitem>
+ <para>
+ The color of the domain axis label.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>domainGridlinesVisible</term>
+ <listitem>
+ <para>
+ Controls whether or not gridlines for the domain axis are shown on the chart.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>domainGridlinesPaint</term>
+ <listitem>
+ <para>
+ The color of the domain gridlines, if visible.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>domainGridlinesStroke</term>
+ <listitem>
+ <para>
+ The stroke style of the domain gridlines, if visible.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>height</term>
+ <listitem>
+ <para>
+ The height of the chart.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>width</term>
+ <listitem>
+ <para>
+ The width of the chart.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>is3D</term>
+ <listitem>
+ <para>
+ A Boolean value indicating that the chart should be rendered in 3D instead of 2D.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>legend</term>
+ <listitem>
+ <para>
+ A Boolean value indicating whether or not the chart should include a legend.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>legendItemPaint</term>
+ <listitem>
+ <para>
+ The default color of the text labels in the legend.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>legendItemBackgroundPaint</term>
+ <listitem>
+ <para>
+ The background color for the legend, if different from the chart background color.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>legendOutlinePaint</term>
+ <listitem>
+ <para>
+ The color of the border around the legend.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>orientation</term>
+ <listitem>
+ <para>
+ The orientation of the plot, either <property>vertical</property> (the default) or <property>horizontal</property>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>plotBackgroundPaint</term>
+ <listitem>
+ <para>
+ The color of the plot background.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>plotBackgroundAlpha</term>
+ <listitem>
+ <para>
+ The alpha (transparency) level of the plot background. It should be a number between 0 (completely transparent) and 1 (completely opaque).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>plotForegroundAlpha</term>
+ <listitem>
+ <para>
+ plotForegroundAlpha — The alpha (transparency) level of the plot. It should be a number between 0 (completely transparent) and 1 (completely opaque).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>plotOutlinePaint</term>
+ <listitem>
+ <para>
+ The color of the range gridlines, if visible.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>plotOutlineStroke</term>
+ <listitem>
+ <para>
+ The stroke style of the range gridlines, if visible.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>rangeAxisLabel</term>
+ <listitem>
+ <para>
+ The text label for the range axis.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>rangeAxisPaint</term>
+ <listitem>
+ <para>
+ The color of the range axis label.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>rangeGridlinesVisible</term>
+ <listitem>
+ <para>
+ Controls whether or not gridlines for the range axis are shown on the chart.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>rangeGridlinesPaint</term>
+ <listitem>
+ <para>
+ The color of the range gridlines, if visible.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>rangeGridlinesStroke</term>
+ <listitem>
+ <para>
+ The stroke style of the range gridlines, if visible.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>title</term>
+ <listitem>
+ <para>
+ The chart title text.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>titlePaint</term>
+ <listitem>
+ <para>
+ The color of the chart title text.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>titleBackgroundPaint</term>
+ <listitem>
+ <para>
+ The background color of the chart title.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>width</term>
+ <listitem>
+ <para>
+ The width of the chart.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Usage</term>
+ <listitem>
+ <programlisting role="XML">
+ <![CDATA[<p:linechart title="Line Chart"
+ width="500" height="500">
+ <p:series key="Prices">
+ <p:data columnKey="2003" value="7.36" />
+ <p:data columnKey="2004" value="11.50" />
+ <p:data columnKey="2005" value="34.625" />
+ <p:data columnKey="2006" value="76.30" />
+ <p:data columnKey="2007" value="85.05" />
+ </p:series>
+ </p:linechart>]]>
+ </programlisting>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><p:pieChart></term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>Description</term>
+ <listitem>
+ <para>
+ Displays a pie chart.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Attributes</term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>title</term>
+ <listitem>
+ <para>
+ The chart title text.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>label</term>
+ <listitem>
+ <para>
+ The default label text for pie sections.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>legend</term>
+ <listitem>
+ <para>
+ A Boolean value indicating whether or not the chart should include a legend. Default value is true.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>is3D</term>
+ <listitem>
+ <para>
+ A Boolean value indicating that the chart should be rendered in 3D instead of 2D.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>labelLinkMargin</term>
+ <listitem>
+ <para>
+ The link margin for labels.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>labelLinkPaint</term>
+ <listitem>
+ <para>
+ The paint used for the label linking lines.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>labelLinkStroke</term>
+ <listitem>
+ <para>
+ The stroke used for the label linking lines.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>labelLinksVisible</term>
+ <listitem>
+ <para>
+ A flag that controls whether or not the label links are drawn.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>labelOutlinePaint</term>
+ <listitem>
+ <para>
+ The paint used to draw the outline of the section labels.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>labelOutlineStroke</term>
+ <listitem>
+ <para>
+ The stroke used to draw the outline of the section labels.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>labelShadowPaint</term>
+ <listitem>
+ <para>
+ The paint used to draw the shadow for the section labels.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>labelPaint</term>
+ <listitem>
+ <para>
+ The color used to draw the section labels.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>labelGap</term>
+ <listitem>
+ <para>
+ The gap between the labels and the plot, as a percentage of the plot width.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>labelBackgroundPaint</term>
+ <listitem>
+ <para>
+ The color used to draw the background of the section labels. If this is null, the background is not filled.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>startAngle</term>
+ <listitem>
+ <para>
+ The starting angle of the first section.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>circular</term>
+ <listitem>
+ <para>
+ 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>
+ </varlistentry>
+ <varlistentry>
+ <term>direction</term>
+ <listitem>
+ <para>
+ The direction in which the pie sections are drawn. One of: clockwise or anticlockwise. The default is clockwise.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>sectionOutlinePaint</term>
+ <listitem>
+ <para>
+ The outline paint for all sections.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>sectionOutlineStroke</term>
+ <listitem>
+ <para>
+ The outline stroke for all sections.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>sectionOutlineVisible</term>
+ <listitem>
+ <para>
+ Indicates whether an outline is drawn for each section in the plot.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>baseSectionOutlinePaint</term>
+ <listitem>
+ <para>
+ The base section outline paint.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>baseSectionPaint</term>
+ <listitem>
+ <para>
+ The base section paint.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>baseSectionOutlineStroke</term>
+ <listitem>
+ <para>
+ The base section outline stroke.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Usage</term>
+ <listitem>
+ <programlisting role="XML">
+ <![CDATA[<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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><p:series></term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>Description</term>
+ <listitem>
+ <para>
+ Category data can be broken down into series. The series tag is used to categorize a data set with a series and apply styling to the entire series.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Attributes</term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>key</term>
+ <listitem>
+ <para>The series name</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>seriesPaint</term>
+ <listitem>
+ <para>
+ The color of each item in the series.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>seriesOutlinePaint</term>
+ <listitem>
+ <para>
+ The outline color for each item in the series.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>seriesOutlineStroke</term>
+ <listitem>
+ <para>
+ The stroke used to draw each item in the series.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>seriesVisible</term>
+ <listitem>
+ <para>
+ A Boolean indicating if the series should be displayed.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>seriesVisibleInLegend</term>
+ <listitem>
+ <para>
+ A Boolean indicating whether the series should be listed in the legend.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Usage</term>
+ <listitem>
+ <programlisting role="XML">
+ <![CDATA[<p:series key="data1"> <ui:repeat value="#{data.pieData1}" var="item"> <p:data columnKey="#{item.name}" value="#{item.value}" /> </ui:repeat> </p:series>]]>
+ </programlisting>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><p:data></term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>Description</term>
+ <listitem>
+ <para>
+ The data tag describes each data point to be displayed in the graph.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Attributes</term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>key</term>
+ <listitem>
+ <para>
+ The name of the data item.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>series</term>
+ <listitem>
+ <para>
+ The series name, when not embedded inside a <varname><p:series></varname>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>value</term>
+ <listitem>
+ <para>
+ The numeric data value.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>explodedPercent</term>
+ <listitem>
+ <para>
+ For pie charts, indicates how exploded from the pie a piece is.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>sectionOutlinePaint</term>
+ <listitem>
+ <para>
+ For bar charts, the color of the section outline.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>sectionOutlineStroke</term>
+ <listitem>
+ <para>
+ For bar charts, the stroke type for the section outline.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>sectionPaint</term>
+ <listitem>
+ <para>
+ For bar charts, the color of the section.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Usage</term>
+ <listitem>
+ <programlisting role="XML">
+ <![CDATA[<p:data key="foo" value="20" sectionPaint="#111111" explodedPercent=".2" /> <p:data key="bar" value="30" sectionPaint="#333333" /> <p:data key="baz" value="40" sectionPaint="#555555" sectionOutlineStroke="my-dot-style" />]]>
+ </programlisting>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><p:color></term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>Description</term>
+ <listitem>
+ <para>
+ The color component declares a color or gradient for filled shapes.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Attributes</term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>color</term>
+ <listitem>
+ <para>
+ The color value. For gradient colors, this indicates the starting color. See <xref linkend="itext.colors" /> for color values.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>color2</term>
+ <listitem>
+ <para>
+ For gradient colors, this is the color that ends the gradient.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>point</term>
+ <listitem>
+ <para>
+ The coordinates that mark the beginning of the gradient color.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>point2</term>
+ <listitem>
+ <para>
+ The coordinates that mark the end of the gradient color.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Usage</term>
+ <listitem>
+ <programlisting role="XML">
+ <![CDATA[<p:color id="foo" color="#0ff00f"/> <p:color id="bar" color="#ff00ff" color2="#00ff00" point="50 50" point2="300 300"/>]]>
+ </programlisting>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><p:stroke></term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>Description</term>
+ <listitem>
+ <para>
+ Describes a stroke used to draw lines in a chart.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Attributes</term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>width</term>
+ <listitem>
+ <para>
+ The width of the stroke.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>cap</term>
+ <listitem>
+ <para>
+ The line cap type. Valid values are <property>butt</property>, <property>round</property>, and <property>square</property>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>join</term>
+ <listitem>
+ <para>
+ The line join type. Valid values are <property>miter</property>, <property>round</property>, and <property>bevel</property>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>miterLimit</term>
+ <listitem>
+ <para>
+ For miter joins, this value is the limit of the size of the join.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>dash</term>
+ <listitem>
+ <para>
+ The dash value sets the dash pattern used to draw the line. Use space-separated integers to indicate the length of each alternating drawn and undrawn segment.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>dashPhase</term>
+ <listitem>
+ <para>
+ The dash phase indicates the point in the dash pattern that corresponds to the beginning of the stroke.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Usage</term>
+ <listitem>
+ <programlisting role="XML">
+ <![CDATA[<p:stroke id="dot2" width="2" cap="round" join="bevel" dash="2 3" />]]>
+ </programlisting>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
-
+
<section id="itext.barcodes">
<title>Bar codes</title>
<para>
Seam can use iText to generate barcodes in a wide variety of formats. These barcodes can be embedded in a PDF document or displayed as an image on a web page. However, barcodes cannot currently display barcode text when used with HTML images.
</para>
+ <!--
<informaltable id="itext.barcode">
<tgroup cols="2">
<colspec colnum="1" colwidth="1*"></colspec>
@@ -2434,6 +4278,139 @@
</tbody>
</tgroup>
</informaltable>
+
+-->
+ <remark>Rewriting the above table for Publican compatibility</remark>
+
+ <variablelist>
+ <varlistentry>
+ <term><p:barCode></term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>Description</term>
+ <listitem>
+ <para>
+ Displays a barcode image.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Attributes</term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>type</term>
+ <listitem>
+ <para>
+ A barcode type supported by iText. Valid values include: <property>EAN13</property>, <property>EAN8</property>, <property>UPCA</property>, <property>UPCE</property>, <property>SUPP2</property>, <property>SUPP5</property>, <property>POSTNET</property>, <property>PLANET</property>, <property>CODE128</property>, <property>CODE128_UCC</property>, <property>CODE128_RAW</property>, and <property>CODABAR</property>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>code</term>
+ <listitem>
+ <para>
+ The value to be encoded by the barcode.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>xpos</term>
+ <listitem>
+ <para>
+ For PDFs, the absolute <property>x</property> position of the barcode on the page.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>ypos</term>
+ <listitem>
+ <para>
+ For PDFs, the absolute <property>y</property> position of the barcode on the page.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>rotDegrees</term>
+ <listitem>
+ <para>
+ For PDFs, the rotation factor of the barcode in degrees.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>barHeight</term>
+ <listitem>
+ <para>
+ The height of the bars in the barcode.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>minBarWidth</term>
+ <listitem>
+ <para>
+ The minimum bar width.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>barMultiplier</term>
+ <listitem>
+ <para>
+ The bar multiplier for wide bars or the distance between bars for <property>POSTNET</property> and <property>PLANET</property> code.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>barColor</term>
+ <listitem>
+ <para>
+ The color the bars should be drawn in.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>textColor</term>
+ <listitem>
+ <para>
+ The color of any text on the barcode.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>textSize</term>
+ <listitem>
+ <para>
+ The size of any text on the barcode.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>altText</term>
+ <listitem>
+ <para>
+ The <varname>alt</varname> text for HTML image links.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Usage</term>
+ <listitem>
+ <programlisting role="XML">
+ <![CDATA[<p:barCode type="code128" barHeight="80" textSize="20" code="(10)45566(17)040301" codeType="code128_ucc" altText="My BarCode" />]]> </programlisting>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+
</section>
<section id="itext.fillinforms">
@@ -2441,6 +4418,7 @@
<para>
If you have a complex, pre-generated PDF with named fields, you can easily populate it with values from your application and present it to the user.
</para>
+ <!--
<informaltable>
<tgroup cols="2">
<colspec colnum="1" colwidth="1*"></colspec>
@@ -2484,50 +4462,170 @@
</tbody>
</tgroup>
</informaltable>
- <informaltable>
- <tgroup cols="2">
+ -->
+ <!--
+ <informaltable>
+ <tgroup cols="2">
<colspec colnum="1" colwidth="1*"></colspec>
<colspec colnum="2" colwidth="3*"></colspec>
<tbody>
- <row>
- <entry valign="top">
- <para>
- <literal><![CDATA[<p:field>]]></literal>
- </para>
- </entry>
- <entry valign="top">
- <para>
- <emphasis>Description</emphasis>
- </para>
- <para>
- Connects a field name to its value.
- </para>
- <para>
- <emphasis>Attributes</emphasis>
- </para>
- <itemizedlist>
- <listitem>
- <para>
- <literal>name</literal> — The name of the field.
- </para>
- </listitem>
- <listitem>
- <para>
- <literal>value</literal> — The value of the field.
- </para>
- </listitem>
- <listitem>
- <para>
- <literal>readOnly</literal> — Whether the field is read-only. The default is <literal>true</literal>.
- </para>
- </listitem>
- </itemizedlist>
- </entry>
- </row>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><![CDATA[<p:field>]]></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <para>
+ <emphasis>Description</emphasis>
+ </para>
+ <para>
+ Connects a field name to its value.
+ </para>
+ <para>
+ <emphasis>Attributes</emphasis>
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal>name</literal> — The name of the field.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>value</literal> — The value of the field.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>readOnly</literal> — Whether the field is read-only. The default is <literal>true</literal>.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </entry>
+ </row>
</tbody>
- </tgroup>
- </informaltable>
-
+ </tgroup>
+ </informaltable>
+ -->
+ <remark>Rewriting the above table for Publican compatibility</remark>
+
+ <variablelist>
+ <varlistentry>
+ <term><p:form></term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>Description</term>
+ <listitem>
+ <para>
+ Defines a form template to populate.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Attributes</term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>URL</term>
+ <listitem>
+ <para>
+ A URL that points to the PDF file to use as a template. If the value contains no protocol (://), the file is read locally.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>filename</term>
+ <listitem>
+ <para>
+ The filename to use for the generated PDF file.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>exportKey</term>
+ <listitem>
+ <para>
+ If set, no redirect will occur when the generated PDF file is placed in a <systemitem>DocumentData</systemitem> object under the specified key in the event context.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <!--
+ <varlistentry>
+ <term>Usage</term>
+ <listitem>
+ <programlisting role="XML">
+
+ </programlisting>
+ </listitem>
+ </varlistentry>
+ -->
+ </variablelist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><p:field></term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>Description</term>
+ <listitem>
+ <para>
+ Connects a field name to its value.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Attributes</term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>name</term>
+ <listitem>
+ <para>
+ The name of the field.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>value</term>
+ <listitem>
+ <para>
+ The value of the field.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>readOnly</term>
+ <listitem>
+ <para>
+ Whether the field is read-only. The default value is <property>true</property>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <!--
+ <varlistentry>
+ <term>Usage</term>
+ <listitem>
+ <programlisting role="XML">
+
+ </programlisting>
+ </listitem>
+ </varlistentry>
+ -->
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
<programlisting role="XML"> <![CDATA[
<p:form
xmlns:p="http://jboss.com/products/seam/pdf"
More information about the jboss-cvs-commits
mailing list