[jboss-cvs] jboss-seam/doc/reference/en/modules ...
Norman Richards
norman.richards at jboss.com
Fri Jun 1 16:57:25 EDT 2007
User: nrichards
Date: 07/06/01 16:57:25
Modified: doc/reference/en/modules controls.xml elenhancements.xml
itext.xml
Log:
doc updates
Revision Changes Path
1.36 +109 -137 jboss-seam/doc/reference/en/modules/controls.xml
(In the diff below, changes in quantity of whitespace are not shown.)
Index: controls.xml
===================================================================
RCS file: /cvsroot/jboss/jboss-seam/doc/reference/en/modules/controls.xml,v
retrieving revision 1.35
retrieving revision 1.36
diff -u -b -r1.35 -r1.36
--- controls.xml 8 May 2007 08:02:30 -0000 1.35
+++ controls.xml 1 Jun 2007 20:57:25 -0000 1.36
@@ -12,10 +12,8 @@
To use these controls, define the "<literal>s</literal>" namespace in your page as follows (facelets only):
</para>
- <programlisting><![CDATA[
-<html xmlns="http://www.w3.org/1999/xhtml"
- xmlns:s="http://jboss.com/products/seam/taglib">]]>
- </programlisting>
+ <programlisting><![CDATA[<html xmlns="http://www.w3.org/1999/xhtml"
+ xmlns:s="http://jboss.com/products/seam/taglib">]]></programlisting>
<para>
The ui example demonstrates the use of a number of these tags.
@@ -86,9 +84,8 @@
</listitem>
</itemizedlist>
<para><emphasis>Usage</emphasis></para>
- <programlisting><![CDATA[
- <s:button id="cancel" value="Cancel" action="#{hotelBooking.cancel}"/>
-]]></programlisting>
+ <programlisting><![CDATA[<s:button id="cancel" value="Cancel"
+ action="#{hotelBooking.cancel}"/>]]></programlisting>
</entry>
</row>
@@ -130,8 +127,7 @@
</listitem>
</itemizedlist>
<para><emphasis>Usage</emphasis></para>
- <programlisting><![CDATA[
- <s:cache key="entry-#{blogEntry.id}" region="pageFragments">
+ <programlisting><![CDATA[<s:cache key="entry-#{blogEntry.id}" region="pageFragments">
<div class="blogEntry">
<h3>#{blogEntry.title}</h3>
<div>
@@ -140,12 +136,12 @@
<p>
[Posted on 
<h:outputText value="#{blogEntry.date}">
- <f:convertDateTime timezone="#{blog.timeZone}" locale="#{blog.locale}" type="both"/>
+ <f:convertDateTime timezone="#{blog.timeZone}" locale="#{blog.locale}"
+ type="both"/>
</h:outputText>]
</p>
</div>
- </s:cache>
-]]></programlisting>
+</s:cache>]]></programlisting>
</entry>
</row>
@@ -199,11 +195,9 @@
</listitem>
</itemizedlist>
<para><emphasis>Usage</emphasis></para>
- <programlisting><![CDATA[
- <h:commandButton value="Apply" action="#{personHome.update}">
+ <programlisting><![CDATA[<h:commandButton value="Apply" action="#{personHome.update}">
<s:conversationPropagation type="join" />
- </h:commandButton>
-]]></programlisting>
+</h:commandButton>]]></programlisting>
</entry>
</row>
@@ -221,11 +215,9 @@
None.
</para>
<para><emphasis>Usage</emphasis></para>
- <programlisting><![CDATA[
- <h:outputText value="#{item.orderDate}">
+ <programlisting><![CDATA[<h:outputText value="#{item.orderDate}">
<s:convertDateTime type="both" dateStyle="full"/>
- </h:outputText>
-]]></programlisting>
+</h:outputText>]]></programlisting>
</entry>
</row>
@@ -261,15 +253,15 @@
If your <emphasis>Managed Persistence Context</emphasis> isn't called
<literal>entityManager</literal>, then you need to set it in components.xml:
</para>
- <programlisting><![CDATA[
- <component name="org.jboss.seam.ui.entityConverter">
+ <programlisting><![CDATA[<component name="org.jboss.seam.ui.entityConverter">
<property name="entityManager">#{em}</property>
- </component>
-]]></programlisting>
+</component>]]></programlisting>
<para><emphasis>Usage</emphasis></para>
<programlisting><![CDATA[<h:selectOneMenu value="#{person.continent}" required="true">
- <s:selectItems value="#{continents.resultList}" var="continent" label="#{continent.name}" noSelectionLabel="Please Select..."/>
+ <s:selectItems value="#{continents.resultList}" var="continent"
+ label="#{continent.name}"
+ noSelectionLabel="Please Select..."/>
<s:convertEntity />
</h:selectOneMenu>]]></programlisting>
</entry>
@@ -291,12 +283,12 @@
None.
</para>
<para><emphasis>Usage</emphasis></para>
- <programlisting><![CDATA[
- <h:selectOneMenu value="#{person.honorific}">
- <s:selectItems value="#{honorifics}" var="honorific" label="#{honorific.label}" noSelectionLabel="Please select" />
+ <programlisting><![CDATA[<h:selectOneMenu value="#{person.honorific}">
+ <s:selectItems value="#{honorifics}" var="honorific"
+ label="#{honorific.label}"
+ noSelectionLabel="Please select" />
<s:convertEnum />
- </h:selectOneMenu>
-]]></programlisting>
+</h:selectOneMenu>]]></programlisting>
</entry>
</row>
@@ -321,21 +313,20 @@
</listitem>
</itemizedlist>
<para><emphasis>Usage</emphasis></para>
- <programlisting><![CDATA[
- <f:facet name="afterInvalidField">
+ <programlisting><![CDATA[<f:facet name="afterInvalidField">
<s:span>
 Error: 
<s:message/>
</s:span>
- </f:facet>
- <f:facet name="aroundInvalidField">
+</f:facet>
+<f:facet name="aroundInvalidField">
<s:span styleClass="errors"/>
- </f:facet>
+</f:facet>
- <s:decorate>
- <h:inputText value="#{blogEntry.id}" size="20" maxlength="20" required="true" id="id"/>
- </s:decorate>
-]]></programlisting>
+<s:decorate>
+ <h:inputText value="#{blogEntry.id}" size="20" maxlength="20"
+ required="true" id="id"/>
+</s:decorate>]]></programlisting>
</entry>
</row>
@@ -355,11 +346,9 @@
None.
</para>
<para><emphasis>Usage</emphasis></para>
- <programlisting><![CDATA[
- <s:div rendered="#{selectedMember == null}">
+ <programlisting><![CDATA[<s:div rendered="#{selectedMember == null}">
Sorry, but this member does not exist.
- </s:div>
-]]></programlisting>
+</s:div>]]></programlisting>
</entry>
</row>
@@ -389,21 +378,16 @@
</listitem>
</itemizedlist>
<para><emphasis>Usage</emphasis></para>
- <programlisting><![CDATA[
- <h:selectOneRadio id="radioList"
+ <programlisting><![CDATA[<h:selectOneRadio id="radioList"
layout="lineDirection"
value="#{newPayment.paymentFrequency}">
<s:convertEnum />
<s:enumItem enumValue="ONCE" label="Only Once" />
- <s:enumItem enumValue="EVERY_MINUTE" label="Every Minute (testing)" />
- <s:enumItem enumValue="HOURLY" label="Every Hour (testing)" />
+ <s:enumItem enumValue="EVERY_MINUTE" label="Every Minute" />
+ <s:enumItem enumValue="HOURLY" label="Every Hour" />
<s:enumItem enumValue="DAILY" label="Every Day" />
<s:enumItem enumValue="WEEKLY" label="Every Week" />
- <ui:remove>
- <f:selectItems value="#{newPayment.frequencies}" />
- </ui:remove>
- </h:selectOneRadio>
-]]></programlisting>
+</h:selectOneRadio>]]></programlisting>
</entry>
</row>
@@ -420,16 +404,14 @@
an encoding type of <literal>multipart/form-data</literal>, i.e:
</para>
- <programlisting><![CDATA[
- <h:form enctype="multipart/form-data">]]></programlisting>
+ <programlisting><![CDATA[<h:form enctype="multipart/form-data">]]></programlisting>
<para>
For multipart requests, the Seam Multipart servlet filter must also be configured
in <literal>web.xml</literal>:
</para>
- <programlisting><![CDATA[
-<filter>
+ <programlisting><![CDATA[<filter>
<filter-name>Seam Filter</filter-name>
<filter-class>org.jboss.seam.web.SeamFilter</filter-class>
</filter>
@@ -463,8 +445,7 @@
Here's an example:
</para>
- <programlisting><![CDATA[
-<component class="org.jboss.seam.web.MultipartFilter">
+ <programlisting><![CDATA[<component class="org.jboss.seam.web.MultipartFilter">
<property name="createTempFiles">true</property>
<property name="maxRequestSize">1000000</property>
</component>]]></programlisting>
@@ -507,10 +488,9 @@
</listitem>
</itemizedlist>
<para><emphasis>Usage</emphasis></para>
- <programlisting><![CDATA[
- <s:fileUpload id="picture" data="#{register.picture}" accept="image/png"
- contentType="#{register.pictureContentType}" />
-]]></programlisting>
+ <programlisting><![CDATA[<s:fileUpload id="picture" data="#{register.picture}"
+ accept="image/png"
+ contentType="#{register.pictureContentType}" />]]></programlisting>
</entry>
</row>
@@ -533,8 +513,7 @@
</listitem>
</itemizedlist>
<para><emphasis>Usage</emphasis></para>
- <programlisting><![CDATA[<s:formattedText value="#{blog.text}"/>
-]]></programlisting>
+ <programlisting><![CDATA[<s:formattedText value="#{blog.text}"/>]]></programlisting>
<para><emphasis>Example</emphasis></para>
<mediaobject>
<imageobject role="fo">
@@ -563,11 +542,9 @@
None.
</para>
<para><emphasis>Usage</emphasis></para>
- <programlisting><![CDATA[
- <s:fragment rendered="#{auction.highBidder ne null}">
+ <programlisting><![CDATA[<s:fragment rendered="#{auction.highBidder ne null}">
Current bid:
- </s:fragment>
-]]></programlisting>
+</s:fragment>]]></programlisting>
</entry>
</row>
@@ -671,11 +648,10 @@
to set your transformed image. Transforms are applied in the order specified in the view.
</para>
<para><emphasis>Usage</emphasis></para>
- <programlisting><![CDATA[
- <s:graphicImage rendered="#{auction.image ne null}" value="#{auction.image.data}">
+ <programlisting><![CDATA[<s:graphicImage rendered="#{auction.image ne null}"
+ value="#{auction.image.data}">
<s:transformImageSize width="200" maintainRatio="true"/>
- </s:graphicImage>
-]]></programlisting>
+</s:graphicImage>]]></programlisting>
</entry>
</row>
@@ -735,9 +711,8 @@
</listitem>
</itemizedlist>
<para><emphasis>Usage</emphasis></para>
- <programlisting><![CDATA[
- <s:link id="register" view="/register.xhtml" value="Register New User"/>
-]]></programlisting>
+ <programlisting><![CDATA[<s:link id="register" view="/register.xhtml"
+ value="Register New User"/>]]></programlisting>
</entry>
</row>
@@ -757,14 +732,12 @@
None.
</para>
<para><emphasis>Usage</emphasis></para>
- <programlisting><![CDATA[
- <f:facet name="afterInvalidField">
+ <programlisting><![CDATA[<f:facet name="afterInvalidField">
<s:span>
 Error: 
<s:message/>
</s:span>
- </f:facet>
-]]></programlisting>
+</f:facet>]]></programlisting>
</entry>
</row>
@@ -813,16 +786,16 @@
<para><emphasis>Usage</emphasis></para>
<para>
- <programlisting><![CDATA[
- <div class="row">
+ <programlisting><![CDATA[<div class="row">
<h:outputLabel for="dob">Date of birth<em>*</em></h:outputLabel>
<h:inputText id="dob" value="#{user.dob}" required="true">
<s:convertDateTime pattern="MM/dd/yyyy"/>
</h:inputText>
- <s:selectDate for="dob" startYear="1910" endYear="2007"><img src="img/datepicker.png"/></s:selectDate>
+ <s:selectDate for="dob" startYear="1910" endYear="2007">
+ <img src="img/datepicker.png"/>
+ </s:selectDate>
<div class="validationError"><h:message for="dob"/></div>
- </div>
-]]></programlisting>
+</div>]]></programlisting>
</para>
<para><emphasis>Example</emphasis></para>
@@ -1003,11 +976,10 @@
</listitem>
</itemizedlist>
<para><emphasis>Usage</emphasis></para>
- <programlisting><![CDATA[
-<h:selectOneMenu value="#{person.age}" converter="#{converters.ageConverter}">
+ <programlisting><![CDATA[<h:selectOneMenu value="#{person.age}"
+ converter="#{converters.ageConverter}">
<s:selectItems value="#{ages}" var="age" label="#{age}" />
-</h:selectOneMenu>
-]]></programlisting>
+</h:selectOneMenu>]]></programlisting>
</entry>
</row>
@@ -1027,9 +999,7 @@
None.
</para>
<para><emphasis>Usage</emphasis></para>
- <programlisting><![CDATA[
- <s:span styleClass="required" rendered="#{required}">*</s:span>
-]]></programlisting>
+ <programlisting><![CDATA[<s:span styleClass="required" rendered="#{required}">*</s:span>]]></programlisting>
</entry>
</row>
@@ -1070,8 +1040,8 @@
None.
</para>
<para><emphasis>Usage</emphasis></para>
- <programlisting><![CDATA[
-<h:inputText id="userName" required="true" value="#{customer.userName}">
+ <programlisting><![CDATA[<h:inputText id="userName" required="true"
+ value="#{customer.userName}">
<s:validate />
</h:inputText>
<h:message for="userName" styleClass="error" />]]></programlisting>
@@ -1093,21 +1063,23 @@
None.
</para>
<para><emphasis>Usage</emphasis></para>
- <programlisting><![CDATA[
-<s:validateAll>
+ <programlisting><![CDATA[<s:validateAll>
<div class="entry">
<h:outputLabel for="username">Username:</h:outputLabel>
- <h:inputText id="username" value="#{user.username}" required="true"/>
+ <h:inputText id="username" value="#{user.username}"
+ required="true"/>
<h:message for="username" styleClass="error" />
</div>
<div class="entry">
<h:outputLabel for="password">Password:</h:outputLabel>
- <h:inputSecret id="password" value="#{user.password}" required="true"/>
+ <h:inputSecret id="password" value="#{user.password}"
+ required="true"/>
<h:message for="password" styleClass="error" />
</div>
<div class="entry">
<h:outputLabel for="verify">Verify Password:</h:outputLabel>
- <h:inputSecret id="verify" value="#{register.verify}" required="true"/>
+ <h:inputSecret id="verify" value="#{register.verify}"
+ required="true"/>
<h:message for="verify" styleClass="error" />
</div>
</s:validateAll>]]></programlisting>
1.7 +2 -1 jboss-seam/doc/reference/en/modules/elenhancements.xml
(In the diff below, changes in quantity of whitespace are not shown.)
Index: elenhancements.xml
===================================================================
RCS file: /cvsroot/jboss/jboss-seam/doc/reference/en/modules/elenhancements.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -b -r1.6 -r1.7
--- elenhancements.xml 30 May 2007 00:42:18 -0000 1.6
+++ elenhancements.xml 1 Jun 2007 20:57:25 -0000 1.7
@@ -30,7 +30,8 @@
Any value expression may be used as a parameter:
</para>
- <programlisting><![CDATA[<h:commandButton action="#{hotelBooking.bookHotel(hotel.id, user.username)}" value="Book Hotel"/>]]></programlisting>
+ <programlisting><![CDATA[<h:commandButton action="#{hotelBooking.bookHotel(hotel.id, user.username)}"
+ value="Book Hotel"/>]]></programlisting>
<para>
<emphasis>Note:</emphasis> You can not pass objects as arguments! All that is passed is names, for example,
1.7 +1249 -1003jboss-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.6
retrieving revision 1.7
diff -u -b -r1.6 -r1.7
--- itext.xml 10 Feb 2007 16:46:57 -0000 1.6
+++ itext.xml 1 Jun 2007 20:57:25 -0000 1.7
@@ -6,11 +6,11 @@
<section id="itext.intro">
<title>Using PDF Support</title>
- <para>iText support is provided by <literal>jboss-seam-pdf.jar</literal>. This JAR contains the iText JSF controls, which are used
- to construct views that can render to PDF, and the DocumentStore component, which serves the rendered
- documents to the user. To include PDF support in your application, included <literal>jboss-seam-pdf.jar</literal> in your
- <literal>WEB-INF/lib</literal> directory along with the iText JAR file. There is no further configuration needed to use Seam's
- iText support. </para>
+ <para>iText support is provided by <literal>jboss-seam-pdf.jar</literal>. This JAR contains the iText JSF
+ controls, which are used to construct views that can render to PDF, and the DocumentStore component, which
+ serves the rendered documents to the user. To include PDF support in your application, included
+ <literal>jboss-seam-pdf.jar</literal> in your <literal>WEB-INF/lib</literal> directory along with the
+ iText JAR file. There is no further configuration needed to use Seam's iText support. </para>
<para> The Seam iText module requires the use of Facelets as the view technology. Future versions of the library
may also support the use of JSP. Additionally, it requires the use of the seam-ui package.</para>
@@ -23,124 +23,122 @@
<section id="itext.document">
<title>Creating a document</title>
+
+
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+
+ <tbody>
+
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><p:document></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <para>
+ <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 DocumentStore and renders an HTML redirect to that stored
- content. The following is a a small PDF document consisting only a single line of text: </para>
- <programlisting>
-<p:document xmlns:p="http://jboss.com/products/seam/pdf">
- The document goes here.
-</p:document>
- </programlisting>
+ <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>
+ <emphasis>Attributes</emphasis>
+ </para>
- <section>
- <title>p:document</title>
- <para> The <literal>p:document</literal> tag supports the following attributes: </para>
- <variablelist>
- <varlistentry>
- <term>
- <literal>type</literal>
- </term>
+ <itemizedlist>
<listitem>
- <para>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>
+ <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>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>pageSize</literal>
- </term>
+
<listitem>
- <para>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 equizalent to the LETTER page size.</para>
+ <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>
- </varlistentry>
-
- <varlistentry>
- <term>
- <literal>orientation</literal>
- </term>
<listitem>
- <para>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>
+ <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>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>margins</literal>
- </term>
+
<listitem>
- <para>The left, right, top and bottom margin values.</para>
+ <para>
+ <literal>margins</literal> — The left, right, top and bottom margin
+ values. </para>
</listitem>
- </varlistentry>
-
- <varlistentry>
- <term>
- <literal>marginMirroring</literal>
- </term>
<listitem>
- <para>Indicates that margin settings should be reversed an alternating pages.</para>
+ <para>
+ <literal>marginMirroring</literal> — Indicates that margin settings
+ should be reversed an alternating pages.</para>
</listitem>
- </varlistentry>
- </variablelist>
+ </itemizedlist>
- <para>Document metadata is also set as attributes of the document tag. The following metadata fields are
- supported:</para>
- <variablelist>
- <varlistentry>
- <term>
- <literal>title</literal>
- </term>
+
+ <para>
+ <emphasis>Metadata Attributes</emphasis>
+ </para>
+
+
+ <itemizedlist>
<listitem>
- <para/>
+ <para>
+ <literal>title</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>subject</literal>
- </term>
<listitem>
- <para/>
+ <para>
+ <literal>subject</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>keywords</literal>
- </term>
<listitem>
- <para/>
+ <para>
+ <literal>keywords</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>author</literal>
- </term>
<listitem>
- <para/>
+ <para>
+ <literal>author</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>creator</literal>
- </term>
<listitem>
- <para/>
+ <para>
+ <literal>creator</literal>
+ </para>
</listitem>
- </varlistentry>
+ </itemizedlist>
+ <para>
+ <emphasis>Usage</emphasis>
+ </para>
+ <programlisting><p:document xmlns:p="http://jboss.com/products/seam/pdf">
+ The document goes here.
+</p:document></programlisting>
+
+
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
- </variablelist>
- </section>
</section>
@@ -153,415 +151,574 @@
<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>
- <programlisting>
-<p:document xmlns:p="http://jboss.com/products/seam/pdf">
- <p:image alignment="right" wrap="true" resource="/logo.jpg" />
- <p:font size="24">
- <p:paragraph spacingAfter="50">My First Document</p:paragraph>
- </p:font>
- <p:paragraph alignment="justify">
- This is a simple document. It isn't very fancy.
- </p:paragraph>
-</p:document>
- </programlisting>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+
+ <tbody>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><p:paragraph></literal>
+ </para>
+ </entry>
- <section>
- <title>p:paragraph</title>
- <para>Most uses of text should be sectioned into paragraphs so that text fragments can be flowed, formatted
- and styled in logical groups. </para>
- <variablelist>
- <varlistentry>
- <term>
- <literal>firstLineIndent</literal>
- </term>
+ <entry valign="top">
+ <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>
+ <emphasis>Attributes</emphasis>
+ </para>
+
+ <itemizedlist>
<listitem>
- <para> </para>
+ <para>
+ <literal>firstLineIndent</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>extraParagraphSpace</literal>
- </term>
<listitem>
- <para> </para>
+ <para>
+ <literal>extraParagraphSpace</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>leading</literal>
- </term>
<listitem>
- <para> </para>
+ <para>
+ <literal>leading</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>multipliedLeading</literal>
- </term>
<listitem>
- <para> </para>
+ <para>
+ <literal>multipliedLeading</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>spacingBefore</literal>
- </term>
<listitem>
- <para>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>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>spacingAfter</literal>
- </term>
<listitem>
- <para>The blank space to be inserted after the element.</para>
+ <para>
+ <literal>spacingAfter</literal> — The blank space to be inserted after
+ the element.</para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>indentationLeft</literal>
- </term>
<listitem>
- <para> </para>
+ <para>
+ <literal>indentationLeft</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>indentationRight</literal>
- </term>
<listitem>
- <para> </para>
+ <para>
+ <literal>indentationRight</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
+ <listitem>
+ <para>
<literal>keepTogether</literal>
- </term>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ <emphasis>Usage</emphasis>
+ </para>
+ <programlisting><p:paragraph alignment="justify">
+ This is a simple document. It isn't very fancy.
+</p:paragraph></programlisting>
+
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+
+
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+
+ <tbody>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><p:text></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <para>
+ <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
+ <literal>outputText</literal> tag used when rendering HTML documents. </para>
+
+ <para>
+ <emphasis>Attributes</emphasis>
+ </para>
+
+
+ <itemizedlist>
<listitem>
- <para> </para>
+ <para><literal>value</literal> — The value to be displayed. This will
+ typically be a value binding expression.</para>
</listitem>
- </varlistentry>
- </variablelist>
- </section>
+ </itemizedlist>
- <section>
- <title>p:text</title>
- <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. Here is an example: </para>
+ <para>
+ <emphasis>Usage</emphasis>
+ </para>
- <programlisting>
-<p:paragraph>
+ <programlisting><p:paragraph>
The item costs <p:text value="#{product.price}">
<f:convertNumber type="currency" currencySymbol="$"/>
</p:text>
-</p:paragraph>
- </programlisting>
+</p:paragraph></programlisting>
+
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+
+
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+
+ <tbody>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><p:font></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <para>
+ <emphasis>Description</emphasis>
+ </para>
+
+ <para> The font tag defines the default font to be used for all text inside of it. </para>
+
+ <para>
+ <emphasis>Attributes</emphasis>
+ </para>
- <variablelist>
- <varlistentry>
- <term>
- <literal>value</literal>
- </term>
- <listitem>
- <para>The value to be displayed. This will typically be a value binding expression.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </section>
- <section>
- <title>p:font</title>
- <para>Font declarations have no direct </para>
- <variablelist>
- <varlistentry>
- <term>
- <literal>familyName</literal>
- </term>
+ <itemizedlist>
<listitem>
- <para>The font family. One of: <literal>COURIER</literal>, <literal>HELVETICA</literal>,
+ <para><literal>familyName</literal> — The font family. One of:
+ <literal>COURIER</literal>, <literal>HELVETICA</literal>,
<literal>TIMES-ROMAN</literal>, <literal>SYMBOL</literal> or
<literal>ZAPFDINGBATS</literal>.</para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>size</literal>
- </term>
- <listitem>
- <para>The point size of the font.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>style</literal>
- </term>
- <listitem>
- <para>The font styles. Any combination of : <literal>NORMAL</literal>, <literal>BOLD</literal>,
- <literal>ITALIC</literal>, <literal>OBLIQUE</literal>, <literal>UNDERLINE</literal>,
- <literal>LINE-THROUGH</literal></para>
+
+ <listitem>
+ <para><literal>size</literal> — The point size of the font.</para>
</listitem>
- </varlistentry>
- </variablelist>
- </section>
+
+ <listitem>
+ <para><literal>style</literal> — The font styles. Any combination of :
+ <literal>NORMAL</literal>, <literal>BOLD</literal>,
+ <literal>ITALIC</literal>, <literal>OBLIQUE</literal>,
+ <literal>UNDERLINE</literal>, <literal>LINE-THROUGH</literal></para>
+
+ </listitem>
+ </itemizedlist>
+ <para>
+ <emphasis>Usage</emphasis>
+ </para>
+
+ <programlisting><p:font size="24">
+ <p:paragraph spacingAfter="50">My First Document</p:paragraph>
+</p:font></programlisting>
+
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+
+
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+
+ <tbody>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><p:newPage></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <para>
+ <emphasis>Description</emphasis>
+ </para>
- <section>
- <title>p:newPage</title>
<para><literal>p:newPage</literal> inserts a page break. </para>
- </section>
- <section>
- <title>p:image</title>
- <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>
+ <emphasis>Attributes</emphasis>
</para>
+ -->
- <programlisting><p:image resource="/jboss.jpg" /></programlisting>
- <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>
+ <emphasis>Usage</emphasis>
</para>
- <programlisting><p:image imageData="#{images.chart}" /></programlisting>
+ <programlisting><p:newPage /></programlisting>
+
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+
- <variablelist>
- <varlistentry>
- <term>
- <literal>resource</literal>
- </term>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+
+ <tbody>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><p:image></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <para>
+ <emphasis>Description</emphasis>
+ </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
+ <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>
+
+
+
+
+ <para>
+ <emphasis>Attributes</emphasis>
+ </para>
+
+ <itemizedlist>
<listitem>
- <para>The location of the image resource to be included. Resources should be relative to the
- document root of the web application.</para>
+ <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>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>imageData</literal>
- </term>
<listitem>
- <para>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>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>rotation</literal>
- </term>
+
+
<listitem>
- <para>The rotation of the image in degrees.</para>
+ <para><literal>rotation</literal> — The rotation of the image in degrees.
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>height</literal>
- </term>
+
+
<listitem>
- <para>The height of the image.</para>
+ <para><literal>height</literal> — The height of the image. </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>width</literal>
- </term>
+
<listitem>
- <para>The width of the image.</para>
+ <para><literal>width</literal> — The width of the image. </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>alignment</literal>
- </term>
+
<listitem>
- <para>The alignment of the image. (see <xref linkend="itext.alignment"/> for possible values)
- </para>
+ <para>
+ <literal>alignment</literal>— The alignment of the image. (see <xref
+ linkend="itext.alignment"/> for possible values) </para>
+
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>alt</literal>
- </term>
<listitem>
- <para>Alternative text representation for the image.</para>
+
+ <para>
+ <literal>alt</literal> — Alternative text representation for the
+ image.</para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>indentationLeft</literal>
- </term>
<listitem>
- <para> </para>
+ <para>
+ <literal>indentationLeft</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>indentationRight</literal>
- </term>
<listitem>
- <para> </para>
+ <para>
+ <literal>indentationRight</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>spacingBefore</literal>
- </term>
<listitem>
- <para>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>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>spacingAfter</literal>
- </term>
<listitem>
- <para>The blank space to be inserted after the element.</para>
+ <para>
+ <literal>spacingAfter</literal> — The blank space to be inserted after
+ the element.</para>
+
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>widthPercentage</literal>
- </term>
<listitem>
- <para/>
+
+ <para>
+ <literal>widthPercentage</literal>
+ </para>
+
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>initialRotation</literal>
- </term>
<listitem>
- <para> </para>
+ <para>
+ <literal>initialRotation</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
+ <listitem>
+
+ <para>
<literal>dpi</literal>
- </term>
+ </para>
+ </listitem>
<listitem>
- <para/>
+ <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>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>scalePercent</literal>
- </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>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>wrap</literal>
- </term>
<listitem>
- <para> </para>
+ <para>
+ <literal>wrap</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>underlying</literal>
- </term>
<listitem>
- <para> </para>
+ <para>
+ <literal>underlying</literal>
+ </para>
</listitem>
- </varlistentry>
- </variablelist>
- </section>
+ </itemizedlist>
+
+ <para>
+ <emphasis>Usage</emphasis>
+ </para>
- <section>
- <title>p:anchor</title>
- <para><literal>p:anchor</literal> defines clickable links from a document. It supports the following
- attributes:</para>
+ <programlisting><p:image value="/jboss.jpg" /></programlisting>
+ <programlisting><p:image value="#{images.chart}" /></programlisting>
- <variablelist>
- <varlistentry>
- <term>
- <literal>name</literal>
- </term>
+
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+
+ <tbody>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><p:anchor></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <para>
+ <emphasis>Description</emphasis>
+ </para>
+ <para><literal>p:anchor</literal> defines clickable links from a document. It supports the
+ following attributes:</para>
+
+
+ <para>
+ <emphasis>Attributes</emphasis>
+ </para>
+
+
+ <itemizedlist>
<listitem>
- <para>The name of an in-document anchor destination.</para>
+ <para><literal>name</literal> — The name of an in-document anchor
+ destination.</para>
+
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>reference</literal>
- </term>
<listitem>
- <para>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>
- </varlistentry>
+ </itemizedlist>
- </variablelist>
- </section>
+ <para>
+ <emphasis>Usage</emphasis>
+ </para>
+ <programlisting><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>
+
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
</section>
<section id="itext.header">
<title>Headers and Footers</title>
- <section>
- <title>p:header and p:footer</title>
- <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>
-
- <variablelist>
- <varlistentry>
- <term>
- <literal>alignment</literal>
- </term>
- <listitem>
- <para>The alignment of the header/footer box section. (see <xref linkend="itext.alignment"/> for
- alignment values)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>backgroundColor</literal>
- </term>
+
+
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+
+ <tbody>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><p:header></literal>
+ </para>
+ <para>
+ <literal><p:footer></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <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>
+ <emphasis>Attributes</emphasis>
+ </para>
+
+
+ <itemizedlist>
+
+
<listitem>
- <para>The background color of the header/footer box. (see <xref linkend="itext.color"/> for
- color values) </para>
+ <para>
+ <literal>alignment</literal> — The alignment of the header/footer box
+ section. (see <xref linkend="itext.alignment"/> for alignment values)</para>
+
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>borderColor</literal>
- </term>
+
+ <listitem>
+ <para><literal>backgroundColor</literal> — The background color of the
+ header/footer box. (see <xref linkend="itext.color"/> for color values) </para>
+ </listitem>
+
+
+
+
<listitem>
- <para>The border color of the header/footer box. Individual border sides can be set using
+ <para><literal>borderColor</literal> — The border color of the
+ 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 color values) </para>
+ <literal>borderColorTop</literal> and
+ <literal>borderColorBottom</literal>.(see <xref linkend="itext.color"/> for
+ color values) </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>borderWidth</literal>
- </term>
- <listitem>
- <para>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>
+ <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>borderWidthBottom</literal>.</para>
</listitem>
- </varlistentry>
- </variablelist>
- </section>
- <section>
- <title>p:pageNumber</title>
+ </itemizedlist>
+ <para>
+ <emphasis>Usage</emphasis>
+ </para>
+ <programlisting><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>
+
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+
+
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+
+ <tbody>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><p:pageNumber></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <para>
+ <emphasis>Description</emphasis>
+ </para>
<para>The current page number can be placed inside of a header or footer using the
- <literal>p:pageNumber</literal> tag. The page number tag can only be used in the context of a header or
- footer and can only be used once.</para>
- </section>
+ <literal>p:pageNumber</literal> tag. The page number tag can only be used in the
+ context of a header or footer and can only be used once.</para>
+ <para>
+ <emphasis>Usage</emphasis>
+ </para>
+ <programlisting><p:footer borderWidthTop="1" borderColorTop="blue"
+ borderWidthBottom="0" alignment="center">
+ Why Seam? [<p:pageNumber />]
+</p:footer></programlisting>
+
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</section>
@@ -570,14 +727,66 @@
<section id="itext.chapters">
<title>Chapters and Sections</title>
- <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>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+
+ <tbody>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><p:chapter></literal>
+ </para>
+ <para>
+ <literal><p:section></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <para>
+ <emphasis>Description</emphasis>
+ </para>
+
+ <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>
+
+ <para>
+ <emphasis>Attributes</emphasis>
+ </para>
- <programlisting>
-<p:document xmlns:p="http://jboss.com/products/seam/pdf"
+ <itemizedlist>
+
+
+ <listitem>
+ <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>
+ </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>
+ </listitem>
+ </itemizedlist>
+ <para>
+ <emphasis>Usage</emphasis>
+ </para>
+
+ <programlisting><p:document xmlns:p="http://jboss.com/products/seam/pdf"
title="Hello">
<p:chapter number="1">
@@ -590,46 +799,42 @@
<p:paragraph>Goodbye #{user.name}.</p:paragraph>
</p:chapter>
-</p:document>
- </programlisting>
+</p:document> </programlisting>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
- <section>
- <title>p:chapter and p:section</title>
- <variablelist>
- <varlistentry>
- <term>
- <literal>number</literal>
- </term>
- <listitem>
- <para>The chapter number. Every chapter should be assigned a chapter number.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>
- <literal>numberDepth</literal>
- </term>
- <listitem>
- <para>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>
- </varlistentry>
- </variablelist>
- </section>
- <section>
- <title>p:title</title>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+ <tbody>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><p:header></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <para>
+ <emphasis>Description</emphasis>
+ </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>
- </section>
+ <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>
+
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</section>
@@ -641,8 +846,7 @@
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"
+ <programlisting><p:document xmlns:p="http://jboss.com/products/seam/pdf"
xmlns:ui="http://java.sun.com/jsf/facelets"
title="Hello">
<p:list style="numbered">
@@ -650,113 +854,161 @@
<p:listItem>#{doc.name}</p:listItem>
</ui:repeat>
</p:list>
-</p:document>
- </programlisting>
+</p:document></programlisting>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
- <section>
- <title>p:list</title>
+ <tbody>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><p:list></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <!--
+ <para>
+ <emphasis>Description</emphasis>
+ </para>
+ <para>...</para>
+ -->
+ <para>
+ <emphasis>Attributes</emphasis>
+ </para>
+ <itemizedlist>
- <para><literal>p:list</literal> supports the following attributes:</para>
+ <listitem>
+ <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>
+ </listitem>
+ <listitem>
+ <para><literal>listSymbol</literal> — For bulleted lists, specifies the
+ bullet symbol. </para>
+ </listitem>
- <variablelist>
- <varlistentry>
- <term>
- <literal>style</literal>
- </term>
<listitem>
- <para>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>
+ <para><literal>indent</literal> — The indentation level of the
+ list.</para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>listSymbol</literal>
- </term>
+
+
<listitem>
- <para>For bulleted lists, specifies the bullet symbol. </para>
+ <para><literal>lowerCase</literal> — For list styles using letters,
+ indicates whether the letters should be lower case.</para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>indent</literal>
- </term>
+
+
<listitem>
- <para>The indentation level of the list.</para>
+ <para><literal>charNumber</literal> — For ZAPFDINGBATS, indicates the
+ character code of the bullet character.</para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>lowerCase</literal>
- </term>
+
+
<listitem>
- <para>For list styles using letters, indicates whether the letters should be lower case.</para>
+ <para><literal>numberType</literal> — For ZAPFDINGBATS_NUMBER, indicates
+ the numbering style.</para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>charNumber</literal>
- </term>
+
+ </itemizedlist>
+ <para>
+ <emphasis>Usage</emphasis>
+ </para>
+ <programlisting><p:list style="numbered">
+ <ui:repeat value="#{documents}" var="doc">
+ <p:listItem>#{doc.name}</p:listItem>
+ </ui:repeat>
+</p:list></programlisting>
+
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+
+ <tbody>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><p:listItem></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <para>
+ <emphasis>Description</emphasis>
+ </para>
+ <para><literal>p:listItem</literal> supports the following attributes:</para>
+
+ <para>
+ <emphasis>Attributes</emphasis>
+ </para>
+
+
+ <itemizedlist>
+
+
<listitem>
- <para>For ZAPFDINGBATS, indicates the character code of the bullet character.</para>
+ <para>
+ <literal>alignment</literal> — The alignment of the header/footer box
+ section. (see <xref linkend="itext.alignment"/> for alignment values)</para>
+
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>numberType</literal>
- </term>
+
<listitem>
- <para>For ZAPFDINGBATS_NUMBER, indicates the numbering style.</para>
+ <para><literal>alignment</literal> — The alignment of the list item. (See
+ <xref linkend="itext.alignment"/> for possible values)</para>
</listitem>
- </varlistentry>
- </variablelist>
- </section>
- <section>
- <title>p:listItem</title>
- <para><literal>p:listItem</literal> supports the following attributes:</para>
- <variablelist>
- <varlistentry>
- <term>
- <literal>alignment</literal>
- </term>
- <listitem>
- <para>The alignment of the list item. (See <xref linkend="itext.alignment"/> for possible
- values)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>indentationLeft</literal>
- </term>
<listitem>
- <para>The left indentation amount.</para>
+ <para><literal>indentationLeft</literal> — The left indentation
+ amount.</para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>indentationRight</literal>
- </term>
+
+
+
<listitem>
- <para>The right indentation amount.</para>
+ <para><literal>indentationRight</literal> — The right indentation
+ amount.</para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>listSymbol</literal>
- </term>
+
+
+
<listitem>
- <para>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>
- </varlistentry>
- </variablelist>
- </section>
+
+
+ </itemizedlist>
+ <para>
+ <emphasis>Usage</emphasis>
+ </para>
+ <programlisting>...</programlisting>
+
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+
+
+
</section>
<section id="itext.tables">
@@ -767,8 +1019,7 @@
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"
+ <programlisting><p:document xmlns:p="http://jboss.com/products/seam/pdf"
xmlns:ui="http://java.sun.com/jsf/facelets"
title="Hello">
<p:table columns="3" headerRows="1">
@@ -781,340 +1032,344 @@
<p:cell>#{doc.size}</p:cell>
</ui:repeat>
</p:table>
-</p:document>
- </programlisting>
+</p:document> </programlisting>
+
- <section>
- <title>p:table</title>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+
+ <tbody>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><p:table></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <para>
+ <emphasis>Description</emphasis>
+ </para>
<para><literal>p:table</literal> supports the following attributes.</para>
- <variablelist>
- <varlistentry>
- <term>
- <literal>columns</literal>
- </term>
- <listitem>
- <para>The number of columns (cells) that make up a table row.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>widths</literal>
- </term>
- <listitem>
- <para>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>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>headerRows</literal>
- </term>
- <listitem>
- <para>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>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>footerRows</literal>
- </term>
- <listitem>
- <para>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>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>widthPercentage</literal>
- </term>
+
+ <para>
+ <emphasis>Attributes</emphasis>
+ </para>
+
+ <itemizedlist>
+
+
<listitem>
- <para>The percentage of the page width that the table spans.</para>
+ <para><literal>columns</literal> — The number of columns (cells) that make
+ up a table row.</para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>horizontalAlignment</literal>
- </term>
- <listitem>
- <para>The horizontal alignment of the table. (See <xref linkend="itext.alignment"/> for possible
- values)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>skipFirstHeader</literal>
- </term>
+
+
+
<listitem>
- <para> </para>
+ <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>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>runDirection</literal>
- </term>
+
+
+
<listitem>
- <para> </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>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>lockedWidth</literal>
- </term>
+
+
+
<listitem>
- <para> </para>
+ <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>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>splitRows</literal>
- </term>
+
+
+
<listitem>
- <para> </para>
+ <para><literal>widthPercentage</literal> — The percentage of the page
+ width that the table spans.</para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>spacingBefore</literal>
- </term>
+
<listitem>
- <para>The blank space to be inserted before the element.</para>
+ <para><literal>horizontalAlignment</literal> — The horizontal alignment of
+ the table. (See <xref linkend="itext.alignment"/> for possible values)</para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>spacingAfter</literal>
- </term>
+
<listitem>
- <para>The blank space to be inserted after the element.</para>
+ <para>
+ <literal>skipFirstHeader</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>extendLastRow</literal>
- </term>
+
<listitem>
- <para> </para>
+ <para>
+ <literal>runDirection</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>headersInEvent</literal>
- </term>
+
<listitem>
- <para> </para>
+ <para>
+ <literal>lockedWidth</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>splitLate</literal>
- </term>
+
+
+
<listitem>
- <para> </para>
+ <para>
+ <literal>splitRows</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>keepTogether</literal>
- </term>
+
+
+
<listitem>
- <para> </para>
+ <para><literal>spacingBefore</literal> — The blank space to be inserted
+ before the element.</para>
+ </listitem>
+
+
+ <listitem>
+ <para><literal>spacingAfter</literal> — The blank space to be inserted
+ after the element.</para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>extendLastRow</literal>
+ </para>
+ </listitem>
+
+
+
+ <listitem>
+ <para>
+ <literal>headersInEvent</literal>
+ </para>
+ </listitem>
+
+
+ <listitem>
+ <para>
+ <literal>splitLate</literal>
+ </para>
</listitem>
- </varlistentry>
- </variablelist>
- </section>
- <section>
- <title>p:cell</title>
+ <listitem>
+ <para>
+ <literal>keepTogether</literal>
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ <para>
+ <emphasis>Usage</emphasis>
+ </para>
+ <programlisting>...</programlisting>
+
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+
+ <tbody>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><p:cell></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <para>
+ <emphasis>Description</emphasis>
+ </para>
<para><literal>p:cell</literal> supports the following attributes.</para>
- <variablelist>
- <varlistentry>
- <term>
- <literal>colspan</literal>
- </term>
- <listitem>
- <para>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>
- </varlistentry>
-
- <varlistentry>
- <term>
- <literal>horizontalAlignment</literal>
- </term>
- <listitem>
- <para>The horizontal alignment of the cell. (see <xref linkend="itext.alignment"/> for possible
- values)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>verticalAlignment</literal>
- </term>
+ <para>
+ <emphasis>Attributes</emphasis>
+ </para>
+
+
+ <itemizedlist>
+
<listitem>
- <para>The vertical alignment of the cell. (see <xref linkend="itext.alignment"/> for possible
- values)</para>
+ <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>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>padding</literal>
- </term>
- <listitem>
- <para>Padding on a given side can also be specified using <literal>paddingLeft</literal>,
- <literal>paddingRight</literal>, <literal>paddingTop</literal> and
- <literal>paddingBottom</literal>.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>useBorderPadding</literal>
- </term>
+
+
+
<listitem>
- <para> </para>
+ <para><literal>horizontalAlignment</literal> — The horizontal alignment of
+ the cell. (see <xref linkend="itext.alignment"/> for possible values)</para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>leading</literal>
- </term>
+
+
+
<listitem>
- <para> </para>
+ <para><literal>verticalAlignment</literal> — The vertical alignment of the
+ cell. (see <xref linkend="itext.alignment"/> for possible values)</para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>multipliedLeading</literal>
- </term>
+
+
+
<listitem>
- <para> </para>
+ <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>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>indent</literal>
- </term>
+
+
<listitem>
- <para> </para>
+ <para>
+ <literal>useBorderPadding</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>verticalAlignment</literal>
- </term>
+
<listitem>
- <para> </para>
+ <para>
+ <literal>leading</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>extraParagraphSpace</literal>
- </term>
+
+
+
<listitem>
- <para> </para>
+ <para>
+ <literal>multipliedLeading</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>fixedHeight</literal>
- </term>
+
+
+
<listitem>
- <para> </para>
+ <para>
+ <literal>indent</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>noWrap</literal>
- </term>
+
<listitem>
- <para> </para>
+ <para>
+ <literal>verticalAlignment</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>minimumHeight</literal>
- </term>
+
<listitem>
- <para> </para>
+ <para>
+ <literal>extraParagraphSpace</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>followingIndent</literal>
- </term>
+
+
<listitem>
- <para> </para>
+ <para>
+ <literal>fixedHeight</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>rightIndent</literal>
- </term>
+
+
<listitem>
- <para> </para>
+ <para>
+ <literal>noWrap</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>spaceCharRatio</literal>
- </term>
+
<listitem>
- <para> </para>
+ <para>
+ <literal>minimumHeight</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>runDirection</literal>
- </term>
+
+
<listitem>
- <para> </para>
+ <para>
+ <literal>followingIndent</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>arabicOptions</literal>
- </term>
+
+
+
<listitem>
- <para> </para>
+ <para>
+ <literal>rightIndent</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>useAscender</literal>
- </term>
+
<listitem>
- <para> </para>
+ <para>
+ <literal>spaceCharRatio</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>grayFill</literal>
- </term>
+
<listitem>
- <para> </para>
+ <para>
+ <literal>runDirection</literal>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <literal>rotation</literal>
- </term>
+
<listitem>
- <para> </para>
+ <para>
+ <literal>arabicOptions</literal>
+ </para>
+ </listitem>
+
+
+ <listitem>
+ <para>
+ <literal>useAscender</literal>
+ </para>
+ </listitem>
+
+
+
+ <listitem>
+ <para>
+ <literal>grayFill</literal>
+ </para>
</listitem>
- </varlistentry>
- </variablelist>
- </section>
- </section>
+ <listitem>
+ <para>
+ <literal>rotation</literal>
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ <para>
+ <emphasis>Usage</emphasis>
+ </para>
+ <programlisting>...</programlisting>
+
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
+
<section id="itext.constant">
<title>Document Constants</title>
@@ -1152,8 +1407,7 @@
<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>
+ <programlisting><filter>
<filter-name>Seam Servlet Filter</filter-name>
<filter-class>org.jboss.seam.servlet.SeamServletFilter</filter-class>
</filter>
@@ -1177,28 +1431,20 @@
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"
+ <programlisting><components xmlns="http://jboss.com/products/seam/components"
xmlns:pdf="http://jboss.com/products/seam/pdf">
<pdf:documentStore useExtensions="true" />
-</components>
-</programlisting>
-
-
-
-
+</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>
- <programlisting>
-<pdf:documentStore useExtensions="true" errorPage="/pdfMissing.seam" />
-</programlisting>
+ <programlisting><pdf:documentStore useExtensions="true" errorPage="/pdfMissing.seam" /></programlisting>
</section>
<section id="itext.links">
- <title>iText links</title>
+ <title>Further documentation</title>
<para>For further information on iText, see:</para>
<para>
More information about the jboss-cvs-commits
mailing list