[seam-commits] Seam SVN: r8573 - trunk/doc/Seam_Reference_Guide/en-US.
seam-commits at lists.jboss.org
seam-commits at lists.jboss.org
Tue Aug 5 04:27:56 EDT 2008
Author: nickarls
Date: 2008-08-05 04:27:56 -0400 (Tue, 05 Aug 2008)
New Revision: 8573
Modified:
trunk/doc/Seam_Reference_Guide/en-US/Excel.xml
Log:
Added xrefs and ulinks, expanded examples
Modified: trunk/doc/Seam_Reference_Guide/en-US/Excel.xml
===================================================================
--- trunk/doc/Seam_Reference_Guide/en-US/Excel.xml 2008-08-04 23:25:48 UTC (rev 8572)
+++ trunk/doc/Seam_Reference_Guide/en-US/Excel.xml 2008-08-05 08:27:56 UTC (rev 8573)
@@ -4,10 +4,10 @@
</title>
<para>
Seam also supports generation of <trademark class="registered">Microsoft</trademark> <trademark class="registered">Excel</trademark>
- spreadsheets through the excellent JExcelAPI library. The generated document is compatible with
+ spreadsheets through the excellent <ulink url="http://jexcelapi.sourceforge.net/"><literal>JExcelAPI</literal></ulink> library. The generated document is compatible with
<trademark class="registered">Microsoft</trademark> <trademark class="registered">Excel</trademark> spreadsheet applications
versions 95, 97, 2000, XP and 2003. Currently a limited subset of the library functionality is exposed but the ultimate goal
- is to be able to do everything the library allows for. Please visit the JExcelAPI [link] home page for more information on
+ is to be able to do everything the library allows for. Please refer to the JExcelAPI documentation for more information on
capabilities and limitations.
</para>
@@ -24,7 +24,7 @@
<literal>jboss-seam-excel.jar</literal>
in your
<literal>WEB-INF/lib</literal>
- directory along with the jxl.jar JAR file. Furthermore, you need to configure the DocumentStore servlet in your
+ directory along with the <literal>jxl.jar</literal> JAR file. Furthermore, you need to configure the DocumentStore servlet in your
web.xml
</para>
<para>
@@ -45,7 +45,7 @@
<literal>org.jboss.seam.excel.<myModule></literal>
and set the UIWorkbook type to
<literal>myModule</literal>
- and your own exporter will be used. Default is "jxl", but support for csv has also been added, using the type
+ and your own exporter will be used. Default is "jxl", but support for CSV has also been added, using the type
"csv".
</para>
@@ -90,7 +90,7 @@
</section>
<section id="excel.workbook">
<title>Workbooks</title>
- <para>Workbooks are the top-level containers of worksheets, cell templates and worksheet templates</para>
+ <para>Workbooks are the top-level parents of worksheets, cell templates and worksheet templates.</para>
<informaltable>
<tgroup cols="2">
<colspec colnum="1" colwidth="1*" />
@@ -240,7 +240,7 @@
<listitem>
<para>
<literal>temporaryFileDuringWriteDirectory</literal>
- —Used in conjunction with the useTemporaryFileDuringWrite setting to set the target
+ —Used in conjunction with the <literal>useTemporaryFileDuringWrite</literal> setting to set the target
directory for the temporary files. This value can be NULL, in which case the normal system
default temporary directory is used instead. The value is a string (the directory to which
temporary files should be written).
@@ -268,19 +268,19 @@
<listitem>
<para>
<literal><e:cellTemplate/></literal>
- —A cell template. See link for more information.
+ —Zero or more cell templates (see <xref linkend="excel.templates.cell"/>).
</para>
</listitem>
<listitem>
<para>
<literal><e:worksheetTemplate/></literal>
- —A worksheet template. See link for more information.
+ —Zero or more worksheet templates (see <xref linkend="excel.templates.worksheetsettings"/>).
</para>
</listitem>
<listitem>
<para>
<literal><e:worksheet/></literal>
- —A worksheet. See link for more information.
+ —Zero or more worksheets (see <xref linkend="excel.worksheet"/>).
</para>
</listitem>
</itemizedlist>
@@ -301,11 +301,11 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
- <e:workbook>
- <e:worksheet>
- <e:cell value="Hello World" row="1" column="1"/>
- </e:worksheet>
- <e:workbook>
+<e:workbook>
+ <e:worksheet>
+ <e:cell value="Hello World" row="0" column="0"/>
+ </e:worksheet>
+<e:workbook>
]]>
</programlisting>
<para>defines a workbook with a worksheet and a greeting at A1</para>
@@ -313,7 +313,11 @@
</section>
<section id="excel.worksheet">
<title>Worksheets</title>
- <para>Worksheets are the children of workbooks and the parent of columns</para>
+ <para>
+ Worksheets are the children of workbooks and the parent of columns and worksheet commands
+ They can also contain explicitly placed cells, formulas, images and hyperlinks. They are the
+ pages that make up the workbook.
+ </para>
<informaltable>
<tgroup cols="2">
<colspec colnum="1" colwidth="1*" />
@@ -346,7 +350,7 @@
—The name of the worksheet. The valus is a string. Defaults to Sheet# where # is the
worksheet index. If the given worksheet name exists, that sheet is selected. This can be
used for merging several data sets into a single worksheet, just define the same name for
- them (using startRow and startCol to make sure that they don't occupy the same space).
+ them (using <literal>startRow</literal> and <literal>startCol</literal> to make sure that they don't occupy the same space).
</para>
</listitem>
<listitem>
@@ -368,8 +372,8 @@
<listitem>
<para>
<literal>templates</literal>
- —The comma-separated list of worksheetTemplates to cascade on. The value is a
- string. See link for more information on cascading worksheet settings
+ —The comma-separated list of <literal>worksheetTemplates</literal> to cascade on. The value is a
+ string (see <xref linkend="excel.templates.cell"/>).
</para>
</listitem>
<listitem>
@@ -507,8 +511,7 @@
<para>
<literal>paperSize</literal>
—The paper size to be used when printing this sheet. The value is a string that can
- be one of "a4", "a3", "letter", "legal" etc. See the jxl.format.PaperSize JavaDoc for the
- full list.
+ be one of "a4", "a3", "letter", "legal" etc (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/PaperSize.html">jxl.format.PaperSize</ulink>).
</para>
</listitem>
<listitem>
@@ -613,21 +616,26 @@
<listitem>
<para>
<literal><e:printArea/></literal>
- —Zero or more print area definitions. See link.
+ —Zero or more print area definitions (see <xref linkend="excel.printareatitles"/>).
</para>
</listitem>
<listitem>
<para>
<literal><e:printTitle/></literal>
- —Zero or more print title definitions. See link.
+ —Zero or more print title definitions (see <xref linkend="excel.printareatitles"/>).
</para>
</listitem>
<listitem>
<para>
<literal><e:headerFooter/></literal>
- —Zero or more header/footer definitions. See link.
+ —Zero or more header/footer definitions ((see <xref linkend="excel.headersfooters"/>)).
</para>
</listitem>
+ <listitem>
+ <para>
+ Zero or more worksheet commands (see <xref linkend="excel.worksheetcommands"/> ).
+ </para>
+ </listitem>
</itemizedlist>
<para>
<emphasis>Facets</emphasis>
@@ -646,24 +654,26 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
- <e:workbook>
- <e:worksheet name="foo" startColumn="2" startRow="2">
- <e:column value="#{personList}" var="person">
- <f:facet name="header">
- <e:cell value="Last name"/>
- </f:facet>
- <e:cell value="#{person.lastName}"/>
- </e:column>
- </e:worksheet>
- <e:workbook>
+<e:workbook>
+ <e:worksheet name="foo" startColumn="1" startRow="1">
+ <e:column value="#{personList}" var="person">
+ <f:facet name="header">
+ <e:cell value="Last name"/>
+ </f:facet>
+ <e:cell value="#{person.lastName}"/>
+ </e:column>
+ </e:worksheet>
+<e:workbook>
]]>
</programlisting>
<para>defines a worksheet with the name "foo", starting at B2.</para>
- <para>See also link e:worksheetTemplate</para>
</section>
<section id="excel.columns">
<title>Columns</title>
- <para>Columns are the children of worksheets and the parents of cells</para>
+ <para>
+ Columns are the children of worksheets and the parents of cells, images, formulas and hyperlinks.
+ They are the structure that control the iteration of the worksheet data.
+ </para>
<informaltable>
<tgroup cols="2">
<colspec colnum="1" colwidth="1*" />
@@ -706,25 +716,25 @@
<listitem>
<para>
<literal><e:cell/></literal>
- —A cell that contains bindings to the actual value. See link for more information.
+ —Zero or more cells (see <xref linkend="excel.cells"/>).
</para>
</listitem>
<listitem>
<para>
<literal><e:formula/></literal>
- —A formula. See link for more information.
+ —Zero or more formulas (see <xref linkend="excel.formulas"/>).
</para>
</listitem>
<listitem>
<para>
<literal><e:image/></literal>
- —An image. See link for more information.
+ —Zero or more images (see <xref linkend="excel.images"/>).
</para>
</listitem>
<listitem>
<para>
<literal><e:hyperLink/></literal>
- —A hyperlink. See link for more information.
+ —Zero or more hyperlinks (see <xref linkend="excel.hyperlinks"/>).
</para>
</listitem>
</itemizedlist>
@@ -754,16 +764,16 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
- <e:workbook>
- <e:worksheet>
- <e:column value="#{personList}" var="person">
- <f:facet name="header">
- <e:cell value="Last name"/>
- </f:facet>
- <e:cell value="#{person.lastName}"/>
- </e:column>
- </e:worksheet>
- <e:workbook>
+<e:workbook>
+ <e:worksheet>
+ <e:column value="#{personList}" var="person">
+ <f:facet name="header">
+ <e:cell value="Last name"/>
+ </f:facet>
+ <e:cell value="#{person.lastName}"/>
+ </e:column>
+ </e:worksheet>
+<e:workbook>
]]>
</programlisting>
<para>defines a column with a header and an iterated output</para>
@@ -772,9 +782,9 @@
<section id="excel.cells">
<title>Cells</title>
<para>
- Cells are nested within columns (for iteration) or inside worksheets (for direct placement using the column and
- row attributes) and are responsible for outputting the value (usually though en EL-expression involving the
- var-attribute of the datatable. They can contains fonts and other formattings and can also use pre-defined
+ Cells are nested within columns (for iteration) or inside worksheets (for direct placement using the <literal>column</literal> and
+ <literal>row</literal> attributes) and are responsible for outputting the value (usually though en EL-expression involving the
+ <literal>var</literal>-attribute of the datatable. They can contains fonts and other formattings and can also use pre-defined
templates.
</para>
<informaltable>
@@ -797,14 +807,14 @@
<para>
<literal>column</literal>
—The column where to place the cell. The default is the internal counter. The value
- is a number.
+ is a number. Note that the value is 0-based.
</para>
</listitem>
<listitem>
<para>
<literal>row</literal>
—The row where to place the cell. The default is the internal counter. The value is
- number.
+ number. Note that the value is 0-based.
</para>
</listitem>
<listitem>
@@ -818,7 +828,7 @@
<para>
<literal>templates</literal>
—A comma-separated list of cascading, predefined templates to apply before the own
- formattings.
+ formattings (see <xref linkend="excel.templates.cell"/>).
</para>
</listitem>
<listitem>
@@ -870,7 +880,7 @@
<listitem>
<para>
<literal>mask</literal>
- —See link for information on format masks.
+ —A format mask (see <xref linkend="excel.cells.formatmasks"/>).
</para>
</listitem>
<listitem>
@@ -909,24 +919,24 @@
<listitem>
<para>
<literal><e:font/></literal>
- —Zero or more font definitions. See link.
+ —Zero or more font definitions (see <xref linkend="excel.cells.fonts"/>).
</para>
</listitem>
<listitem>
<para>
<literal><e:border/></literal>
- —Zero or more border definitions. See link.
+ —Zero or more border definitions (see <xref linkend="excel.cells.borders"/>).
</para>
</listitem>
<listitem>
<para>
<literal><e:background/></literal>
- —Zero or more background definitions. See link.
+ —Zero or more background definitions (see <xref linkend="excel.cells.backgrounds"/>).
</para>
</listitem>
<listitem>
<para>
- <literal>Zero or more validation conditions. See link for more information</literal>
+ Zero or more validation conditions (see <xref linkend="excel.cells.validation"/>).
</para>
</listitem>
@@ -948,20 +958,23 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
- <e:column value="#{personList}" var="person">
- <f:facet name="header">
- <e:cell value="Last name"/>
- </f:facet>
- <e:cell value="#{person.lastName}"/>
- </e:column>
+<e:workbook>
+ <e:worksheet>
+ <e:column value="#{personList}" var="person">
+ <f:facet name="header">
+ <e:cell value="Last name"/>
+ </f:facet>
+ <e:cell value="#{person.lastName}"/>
+ </e:column>
+ </e:worksheet>
+</e:workbook>
]]>
</programlisting>
<para>defines a column with a header and an iterated output</para>
- <para>See also e:cellTemplate</para>
- <section id="excel.fonts">
+ <section id="excel.cells.fonts">
<title>Fonts</title>
<para>
- Fonts are nested inside e:cell, e:formula and e:cellTemplate tags and are defined through the e:font tag.
+ Fonts are nested inside cells, formulas, hyperlinks or cell templates. They determine the typeface of the cell data
</para>
<informaltable>
<tgroup cols="2">
@@ -991,7 +1004,7 @@
<para>
<literal>color</literal>
—The color of the background. The value is a string that can be one of "blue",
- "red" etc. See the JExcelAPI Javadoc for jxl.format.Colour for the full list.
+ "red" etc (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/Colour.html">jxl.format.Colour</ulink>).
</para>
</listitem>
<listitem>
@@ -1060,18 +1073,24 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
- <e:cell value="#{person.age">
- <e:font fontName="Times New Roman" color="red" bold="true"/>
- </e:cell>
+<e:workbook>
+ <e:worksheet>
+ <e:column value="#{personList}" var="person">
+ <e:cell value="#{person.age">
+ <e:font fontName="Times New Roman" color="red" bold="true"/>
+ </e:cell>
+ </e:column>
+ </e:worksheet>
+</e:workbook>
]]>
</programlisting>
<para>defines a cell with a red, bold, Times New Roman font.</para>
</section>
- <section id="excel.backgrounds">
+ <section id="excel.cells.backgrounds">
<title>Backgrounds</title>
<para>
- Backgrounds are nested inside e:cell, e:formula and e:cellTemplate tags and are defined through the
- e:background tag.
+ Backgrounds are nested inside cells, formulas, hyperlinks or cell templates. They determine
+ the color and pattern of the cell.
</para>
<informaltable>
<tgroup cols="2">
@@ -1093,7 +1112,7 @@
<para>
<literal>pattern</literal>
—The pattern of the background. The value is a string that can be one of "solid",
- "grey_25" etc. See the JExcelAPI Javadocs for jxl.format.Pattern for the full list. The
+ "grey_25" etc (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/Pattern.html">jxl.format.Pattern</ulink>). The
default is "solid".
</para>
</listitem>
@@ -1101,7 +1120,7 @@
<para>
<literal>color</literal>
—The color of the background. The value is a string that can be one of "blue",
- "red" etc. See the JExcelAPI Javadoc for jxl.format.Colour for the full list.
+ "red" etc
</para>
</listitem>
</itemizedlist>
@@ -1132,17 +1151,24 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
- <e:cell value="#{person.age">
- <e:background color="green" pattern="grey_25"/>
- </e:cell>
+<e:workbook>
+ <e:worksheet>
+ <e:column value="#{personList}" var="person">
+ <e:cell value="#{person.age">
+ <e:background color="green" pattern="grey_25"/>
+ </e:cell>
+ </e:column>
+ </e:worksheet>
+</e:workbook>
]]>
</programlisting>
<para>defined a green cell background with a 25% grey mask.</para>
</section>
- <section id="excel.borders">
+ <section id="excel.cells.borders">
<title>Borders</title>
<para>
- Borders are nested inside e:cell, e:formula and e:cellTemplate tags and are defined through e:border tags.
+ Borders are nested inside cells, formulas, hyperlinks and cell templates.
+ They determine the color and line style of the cell borders.
</para>
<informaltable>
<tgroup cols="2">
@@ -1171,14 +1197,14 @@
<para>
<literal>lineStyle</literal>
—The border line style. The value is a string that can be one of "medium", "thin"
- etc. See the JExcelAPI Javadoc for jxl.format.BorderLineStyle for the full list.
+ etc (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/BorderLineStyler.html">jxl.format.BorderLineStyle</ulink>).
</para>
</listitem>
<listitem>
<para>
<literal>color</literal>
—The color of the border. The value is a string that can be one of "blue", "red"
- etc. See the JExcelAPI Javadoc for jxl.format.Colour for the full list.
+ etc (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/Colour.html">jxl.format.Colour</ulink>).
</para>
</listitem>
</itemizedlist>
@@ -1209,18 +1235,24 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
- <e:cell value="#{person.age">
- <e:border border="left" color="green" lineStyle="thin"/>
- </e:cell>
+<e:workbook>
+ <e:worksheet>
+ <e:column value="#{personList}" var="person">
+ <e:cell value="#{person.age">
+ <e:border border="left" color="green" lineStyle="thin"/>
+ </e:cell>
+ </e:column>
+ </e:worksheet>
+</e:workbook>
]]>
</programlisting>
<para>defined a thin green border on the left edge of the cell.</para>
</section>
- <section id="excel.validation">
+ <section id="excel.cells.validation">
<title>Validation</title>
<para>
- Validations are nested inside e:cell, e:formula and e:cellTemplate tags and are defined trough
- e:numericValidation, e:rangeValidation and e:listValidation / e:listValidationItem tags.
+ Validations are nested inside cells, formulas or cell templates.
+ They add constrains for the cell data.
</para>
<informaltable>
<tgroup cols="2">
@@ -1314,9 +1346,15 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
- <e:cell value="#{person.age">
- <e:numericValidation condition="between" value="4" value2="18"/>
- </e:cell>
+<e:workbook>
+ <e:worksheet>
+ <e:column value="#{personList}" var="person">
+ <e:cell value="#{person.age">
+ <e:numericValidation condition="between" value="4" value2="18"/>
+ </e:cell>
+ </e:column>
+ </e:worksheet>
+</e:workbook>
]]>
</programlisting>
<para>adds numeric validation to a cell specifying that the value must be between 4 and 18.</para>
@@ -1392,9 +1430,15 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
- <e:cell value="#{person.position">
- <e:rangeValidation startColumn="1" startRow="1" endColumn="1" endRow="10"/>
- </e:cell>
+<e:workbook>
+ <e:worksheet>
+ <e:column value="#{personList}" var="person">
+ <e:cell value="#{person.position">
+ <e:rangeValidation startColumn="0" startRow="0" endColumn="0" endRow="10"/>
+ </e:cell>
+ </e:column>
+ </e:worksheet>
+</e:workbook>
]]>
</programlisting>
<para>
@@ -1428,7 +1472,7 @@
<itemizedlist>
<listitem>
<para>
- <literal>Zero or more list validation items. See link for more information.</literal>
+ <literal>Zero or more list validation items.</literal>
</para>
</listitem>
</itemizedlist>
@@ -1498,22 +1542,28 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
- <e:cell value="#{person.position">
- <e:listValidation>
- <e:listValidationItem value="manager"/>
- <e:listValidationItem value="employee"/>
- </e:listValidation>
- </e:cell>
+<e:workbook>
+ <e:worksheet>
+ <e:column value="#{personList}" var="person">
+ <e:cell value="#{person.position">
+ <e:listValidation>
+ <e:listValidationItem value="manager"/>
+ <e:listValidationItem value="employee"/>
+ </e:listValidation>
+ </e:cell>
+ </e:column>
+ </e:worksheet>
+</e:workbook>
]]>
</programlisting>
<para>adds validation to a cell specifying that the value must be "manager" or "employee".</para>
</section>
- <section id="excel.formatmasks">
+ <section id="excel.cells.formatmasks">
<title>Format masks</title>
<para>
Format masks are defined in the mask attribute in cell templates, cells or formulas.
<emphasis>Note that when using templates, the format mask must be placed in the first template</emphasis>
- to be cascaded since the constructor hierarchy in JExcelAPI used for copying cell formats makes it hard to
+ to be cascaded since the constructor hierarchy in <literal>JExcelAPI</literal> used for copying cell formats makes it hard to
change the format mask at a later stage. There are two types of format masks, one for numbers and one for
dates
</para>
@@ -1521,11 +1571,10 @@
<title>Number masks</title>
<para>
When encountering a format mask, first it is checked if it is in internal form, e.g "format1",
- "accounting_float" and so on. See the JExcelAPI JavaDoc for jxl.write.NumberFormats for the complete
- list.
+ "accounting_float" and so on (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/write/NumberFormats.html">jxl.write.NumberFormats</ulink>).
</para>
<para>
- if the mask is not in the list, it is treated as a custom mask as described in java.text.DecimalFormat,
+ if the mask is not in the list, it is treated as a custom mask (see <ulink url="http://java.sun.com/javase/6/docs/api/java/text/DecimalFormat.html">java.text.DecimalFormat</ulink>).
e.g "0.00" and automatically converted to the closest match.
</para>
</section>
@@ -1533,11 +1582,10 @@
<title>Date masks</title>
<para>
When encountering a format mask, first it is checked if it is in internal form, e.g "format1", "format2"
- and so on. See the JExcelAPI JavaDoc for jxl.write.DateFormats for the complete list.
+ and so on (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/write/DecimalFormats.html">jxl.write.DecimalFormats</ulink>).
</para>
<para>
- if the mask is not in the list, it is treated as a custom mask as described in
- java.text.SimpleDateFormat, e.g "dd.MM.yyyy" and automatically converted to the closest match.
+ if the mask is not in the list, it is treated as a custom mask (see <ulink url="http://java.sun.com/javase/6/docs/api/java/text/DateFormat.html">java.text.DateFormat</ulink>)., e.g "dd.MM.yyyy" and automatically converted to the closest match.
</para>
</section>
</section>
@@ -1545,30 +1593,43 @@
<section id="excel.formulas">
<title>Formulas</title>
<para>
- Formulas are defined with the e:formula tag. It is essentially a e:cell tag so refer to the e:cell
- documentation link for available attributes. Note that they can apply templates and have own font definitions
+ Formulas are nested within columns (for iteration) or inside worksheets (for direct placement using the <literal>column</literal> and
+ <literal>row</literal> attributes) and add calculations or functions to ranges of cells. They are essentially cells, see <xref linkend="excel.cells"/>
+ for available attributes. Note that they can apply templates and have own font definitions
etc just as normal cells.
</para>
<para>
- The formula of the cell in placed in the value-attribute as a normal <trademark class="registered">Microsoft</trademark>
+ The formula of the cell in placed in the <literal>value</literal>-attribute as a normal <trademark class="registered">Microsoft</trademark>
<trademark class="registered">Excel</trademark> spreadsheet application notation. Note that when doing
cross-sheet formulas, the worksheets must exist before referencing a formula against them. The value is a
string.
-
</para>
<programlisting role="XML">
<![CDATA[
- <e:formula row="2" column="2" value="FooSheet!A1+BarSheet1!A1" templates="fooTemplate">
- <e:font fontSize="12"/>
- </e:formula>
+<e:workbook>
+ <e:cellTemplate name="fooTemplate">
+ <e:font color="red"/>
+ </e:cellTemplate>
+ <e:worksheet name="fooSheet">
+ <e:cell column="0" row="0" value="1"/>
+ </e:worksheet>
+ <e:worksheet name="barSheet">
+ <e:cell column="0" row="0" value="2"/>
+ <e:formula column="0" row="1"
+ value="fooSheet!A1+barSheet1!A1"
+ templates="fooTemplate">
+ <e:font fontSize="12"/>
+ </e:formula>
+ </e:worksheet>
+</e:workbook>
]]>
</programlisting>
<para>defines an formula in B2 summing cells A1 in worksheets FooSheet and BarSheet</para>
-
</section>
<section id="excel.images">
<title>Images</title>
- <para>Images are defined with the e:image tag.</para>
+ <para>Images are nested within columns (for iteration) or inside worksheets (for direct placement using the
+ <literal>startColumn/startRow</literal> and <literal>endColumn/endRow</literal> attributes)</para>
<informaltable>
<tgroup cols="2">
<colspec colnum="1" colwidth="1*" />
@@ -1589,28 +1650,28 @@
<para>
<literal>startColumn</literal>
—The starting column of the image. The default is the internal counter. The value is
- a number.
+ a number. Note that the value is 0-based.
</para>
</listitem>
<listitem>
<para>
<literal>startRow</literal>
—The starting row of the image. The default is the internal counter. The value is a
- number.
+ number. Note that the value is 0-based.
</para>
</listitem>
<listitem>
<para>
<literal>columnSpan</literal>
—The column span of the image. The default is one resulting in the default width of
- the image. The value is a number.
+ the image. The value is a number. Note that the value is 0-based.
</para>
</listitem>
<listitem>
<para>
<literal>rowSpan</literal>
—The row span of the image. The default is the one resulting in the default height
- of the image. The value is a number.
+ of the image. The value is a number. Note that the value is 0-based.
</para>
</listitem>
<listitem>
@@ -1647,7 +1708,11 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
- <e:image startRow="1" startColumn="1" rowSpan="5" columnSpan="5" URI="http://foo.org/logo.jpg"/>
+<e:workbook>
+ <e:worksheet>
+ <e:image startRow="0" startColumn="0" rowSpan="4" columnSpan="4" URI="http://foo.org/logo.jpg"/>
+ </e:worksheet>
+</e:workbook>
]]>
</programlisting>
<para>defines an image in A1:E5 based on the given data</para>
@@ -1655,7 +1720,8 @@
</section>
<section id="excel.hyperlinks">
<title>Hyperlinks</title>
- <para>Hyperlinks are defined with the e:hyperlink tag.</para>
+ <para>Hyperlinks are nested within columns (for iteration) or inside worksheets (for direct placement using the
+ <literal>startColumn/startRow</literal> and <literal>endColumn/endRow</literal> attributes). They add link navigation to URIs</para>
<informaltable>
<tgroup cols="2">
<colspec colnum="1" colwidth="1*" />
@@ -1676,28 +1742,28 @@
<para>
<literal>startColumn</literal>
—The starting column of the hyperlink. The default is the internal counter. The
- value is a number.
+ value is a number. Note that the value is 0-based.
</para>
</listitem>
<listitem>
<para>
<literal>startRow</literal>
—The starting row of the hyperlink. The default is the internal counter. The value
- is a number.
+ is a number. Note that the value is 0-based.
</para>
</listitem>
<listitem>
<para>
<literal>endColumn</literal>
—The ending column of the hyperlink. The default is the internal counter. The value
- is a number.
+ is a number. Note that the value is 0-based.
</para>
</listitem>
<listitem>
<para>
<literal>endRow</literal>
—The ending row of the hyperlink. The default is the internal counter. The value is
- a number.
+ a number. Note that the value is 0-based.
</para>
</listitem>
<listitem>
@@ -1740,7 +1806,12 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
- <e:hyperLink startRow="1" startColumn="1" endRow="5" endColumn="5" URL="http://seamframework.org" description="The Seam Framework"/>
+<e:workbook>
+ <e:worksheet>
+ <e:hyperLink startRow="0" startColumn="0" endRow="4" endColumn="4"
+ URL="http://seamframework.org" description="The Seam Framework"/>
+ </e:worksheet>
+</e:workbook>
]]>
</programlisting>
<para>defines a described hyperlink pointing to SFWK in the area A1:E5</para>
@@ -1748,8 +1819,8 @@
<section id="excel.headersfooters">
<title>Headers and footers</title>
<para>
- Headers and footers are defined with e:headerFooter, e:headerFooterCommands and e:headerFooterCommand tags
- nested within a e:worksheet or e:worksheetTemplate.
+ Headers and footers are childrens of worksheets and worksheet templates and parents of header and footer commands
+ They add headers and footers to printed worksheets.
</para>
<informaltable>
<tgroup cols="2">
@@ -1814,7 +1885,7 @@
</tgroup>
</informaltable>
<para>
- The e:headerFooterCommands is just a nesting container in order to support multiple e:headerFooterCommand tags.
+ The <literal><e:headerFooterCommands></literal> is just a nesting container in order to support multiple header/footer commands.
</para>
<informaltable>
<tgroup cols="2">
@@ -1844,7 +1915,7 @@
<itemizedlist>
<listitem>
<para>
- <literal>Zero or more header/footer commands. See link for more information.</literal>
+ Zero or more header/footer commands.
</para>
</listitem>
</itemizedlist>
@@ -1863,7 +1934,8 @@
</tbody>
</tgroup>
</informaltable>
- <para>The acutal command that places something a header/footer facet is defined with e:headerFooterCommand</para>
+ <para>Header/footer commands adds actual commands to the header or footer in the location where the
+ containing facet points.</para>
<informaltable>
<tgroup cols="2">
<colspec colnum="1" colwidth="1*" />
@@ -1952,13 +2024,17 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
- <e:headerFooter type="header">
- <f:facet name="left">
- <e:headerFooterCommands>
- <e:headerFooterCommand command="page_number"/>
- </e:headerFooterCommands>
- </f:facet>
- </e:headerFooter>
+<e:workbook>
+ <e:worksheet>
+ <e:headerFooter type="header">
+ <f:facet name="left">
+ <e:headerFooterCommands>
+ <e:headerFooterCommand command="page_number"/>
+ </e:headerFooterCommands>
+ </f:facet>
+ </e:headerFooter>
+ <e:worksheet>
+</e:workbook>
]]>
</programlisting>
<para>Defines a header with the page number in the left corner.</para>
@@ -1966,8 +2042,7 @@
<section id="excel.printareatitles">
<title>Print areas and titles</title>
<para>
- Print areas and titles are defined with e:printArea and e:printTitle tags nested within a e:worksheet or
- e:worksheetTemplate.
+ Print areas and titles childrens of worksheets and worksheet templates and provide... print areas and titles.
</para>
<informaltable>
<tgroup cols="2">
@@ -1988,25 +2063,25 @@
<listitem>
<para>
<literal>firstColumn</literal>
- —The column of the top-left corner of the area. The parameter is a number.
+ —The column of the top-left corner of the area. The parameter is a number. Note that the value is 0-based.
</para>
</listitem>
<listitem>
<para>
<literal>firstRow</literal>
- —The row of the top-left corner of the area. The parameter is a number.
+ —The row of the top-left corner of the area. The parameter is a number. Note that the value is 0-based.
</para>
</listitem>
<listitem>
<para>
<literal>lastColumn</literal>
- —The column of the bottom-right corner of the area. The parameter is a number.
+ —The column of the bottom-right corner of the area. The parameter is a number. Note that the value is 0-based.
</para>
</listitem>
<listitem>
<para>
<literal>lastRow</literal>
- —The row of the bottom-right corner of the area. The parameter is a number.
+ —The row of the bottom-right corner of the area. The parameter is a number. Note that the value is 0-based.
</para>
</listitem>
</itemizedlist>
@@ -2037,18 +2112,23 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
- <e:printTitles firstRow="1" firstColumn="1" lastRow="1" lastColumn="10"/>
- <e:printArea firstRow="2" firstColumn="1" lastRow="10" lastColumn="10"/>
+<e:workbook>
+ <e:worksheet>
+ <e:printTitles firstRow="0" firstColumn="0" lastRow="0" lastColumn="9"/>
+ <e:printArea firstRow="1" firstColumn="0" lastRow="9" lastColumn="9"/>
+ </e:worksheet>
+</e:workbook>
]]>
</programlisting>
<para>defines a print title between A1:A10 and a print area between B2:J10.</para>
</section>
<section id="excel.worksheetcommands">
<title>Worksheet Commands</title>
+ <para>Worksheet commands are children of workbooks and are usually executed only once.</para>
<section id="excel.worksheetcommands.grouping">
<title>Grouping</title>
<para>
- Grouping of rows and columns are done on worksheet level with the e:groupRows and e:groupColumns tags
+ Provides grouping of columns and rows.
</para>
<informaltable>
<tgroup cols="2">
@@ -2069,13 +2149,13 @@
<listitem>
<para>
<literal>startRow</literal>
- —The row to start the grouping at. The value is a number.
+ —The row to start the grouping at. The value is a number. Note that the value is 0-based.
</para>
</listitem>
<listitem>
<para>
<literal>endRow</literal>
- —The row to end the grouping at. The value is a number.
+ —The row to end the grouping at. The value is a number. Note that the value is 0-based.
</para>
</listitem>
<listitem>
@@ -2129,13 +2209,13 @@
<listitem>
<para>
<literal>startColumn</literal>
- —The column to start the grouping at. The value is a number.
+ —The column to start the grouping at. The value is a number. Note that the value is 0-based.
</para>
</listitem>
<listitem>
<para>
<literal>endColumn</literal>
- —The column to end the grouping at. The value is a number.
+ —The column to end the grouping at. The value is a number. Note that the value is 0-based.
</para>
</listitem>
<listitem>
@@ -2173,8 +2253,12 @@
<programlisting role="XML">
<![CDATA[
- <e:groupRows startRow="5" endRow="10" collapse="true"/>
- <e:groupColumns startColumn="5" endColumn="10" collapse="false"/>
+<e:workbook>
+ <e:worksheet>
+ <e:groupRows startRow="4" endRow="9" collapse="true"/>
+ <e:groupColumns startColumn="0" endColumn="9" collapse="false"/>
+ </e:worksheet>
+</e:workbook>
]]>
</programlisting>
<para>
@@ -2185,7 +2269,7 @@
</section>
<section id="excel.worksheetcommands.pagebreaks">
<title>Page breaks</title>
- <para>Page breaks are defined at worksheet level with the e:rowPageBreak tag</para>
+ <para>Provides page breaks</para>
<informaltable>
<tgroup cols="2">
<colspec colnum="1" colwidth="1*" />
@@ -2205,7 +2289,7 @@
<listitem>
<para>
<literal>row</literal>
- —The row to break at. The value is a number.
+ —The row to break at. The value is a number. Note that the value is 0-based.
</para>
</listitem>
</itemizedlist>
@@ -2236,14 +2320,18 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
- <e:rowPageBreak row="5"/>
+<e:workbook>
+ <e:worksheet>
+ <e:rowPageBreak row="4"/>
+ </e:worksheet>
+</e:workbook>
]]>
</programlisting>
<para>breaks page at row 5.</para>
</section>
<section id="excel.worksheetcommands.merging">
<title>Merging</title>
- <para>Merging is done on worksheet level with the e:mergeCells tag</para>
+ <para>Provides cell merging</para>
<informaltable>
<tgroup cols="2">
<colspec colnum="1" colwidth="1*" />
@@ -2263,25 +2351,25 @@
<listitem>
<para>
<literal>startRow</literal>
- —The row to start the merging from. The value is a number.
+ —The row to start the merging from. The value is a number. Note that the value is 0-based.
</para>
</listitem>
<listitem>
<para>
<literal>startColumn</literal>
- —The column to start the merging from. The value is a number.
+ —The column to start the merging from. The value is a number. Note that the value is 0-based.
</para>
</listitem>
<listitem>
<para>
<literal>endRow</literal>
- —The row to end the merging at. The value is a number.
+ —The row to end the merging at. The value is a number. Note that the value is 0-based.
</para>
</listitem>
<listitem>
<para>
<literal>endColumn</literal>
- —The column to end the merging at. The value is a number.
+ —The column to end the merging at. The value is a number. Note that the value is 0-based.
</para>
</listitem>
</itemizedlist>
@@ -2312,10 +2400,14 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
- <e:mergeCells startRow="5" startColumn="5" endRow="10" endColumn="10"/>
+<e:workbook>
+ <e:worksheet>
+ <e:mergeCells startRow="0" startColumn="0" endRow="9" endColumn="9"/>
+ </e:worksheet>
+</e:workbook>
]]>
</programlisting>
- <para>merges the cells in the range (5,5) to (10,10).</para>
+ <para>merges the cells in the range A1:J10</para>
</section>
</section>
<section id="excel.templates">
@@ -2330,39 +2422,53 @@
<para>Cell templates are defined on workbook level using the following notation</para>
<programlisting role="XML">
<![CDATA[
- <e:cellTemplate name="foo"/>
+<e:workbook>
+ <e:cellTemplate name="foo">
+ <font color="red"/>
+ </e:cellTemplate>
+</e:workbook>
]]>
</programlisting>
<para>and are later used by referencing them in the templates attribute of a cell</para>
<programlisting role="XML">
<![CDATA[
- <e:cell templates="foo"/>
+<e:workbook>
+ <e:worksheet>
+ <e:cell templates="foo" column="0" row="0" value="ping"/>
+ </e:worksheet>
+</e:workbook>
]]>
</programlisting>
<para>
- Cell templates have the same attributes as cells so refer to the link to see the available attributes. Note
+ Cell templates have the same attributes as cells (see <xref linkend="excel.cells"/>). Note
that the cellTemplate can also contain tags for font, border and background definitions and they are merged
with the definitions of the cell using the templates so a more complex definition could look like
</para>
<programlisting role="XML">
<![CDATA[
-<e:cellTemplate name="foo" alignment="right">
- <e:font name="Times New Roman"/>
- <e:background color="blue"/>
-</e:cellTemplate>
+<e:workbook>
+ <e:cellTemplate name="foo" alignment="right">
+ <e:font name="Times New Roman"/>
+ <e:background color="blue"/>
+ </e:cellTemplate>
-<e:cellTemplate name="bar" wrap="true">
- <e:font color="red"/>
- <e:border color="yellow" lineStyle="thick"/>
-</e:cellTemplate>
+ <e:cellTemplate name="bar" wrap="true">
+ <e:font color="red"/>
+ <e:border color="yellow" lineStyle="thick"/>
+ </e:cellTemplate>
+</e:workbook>
]]>
</programlisting>
<para>so that a cell that later on applies the templates</para>
<programlisting role="XML">
<![CDATA[
- <e:cell templates="foo,bar">
- <e:border border="left" color="green" lineStyle="thin"/>
- </e:cell>
+<e:workbook>
+ <e:worksheet>
+ <e:cell templates="foo,bar" column="0" row="0" value="ping">
+ <e:border border="left" color="green" lineStyle="thin"/>
+ </e:cell>
+ </e:worksheet>
+</e:workbook>
]]>
</programlisting>
<para>
@@ -2378,20 +2484,24 @@
</para>
<programlisting role="XML">
<![CDATA[
- <e:worksheetTemplate name="foo" horizontalFreeze="5"/>
+<e:workbook>
+ <e:worksheet>
+ <e:worksheetTemplate name="foo" horizontalFreeze="5"/>
+ </e:worksheet>
+</e:workbook>
]]>
</programlisting>
<para>and when you later use it like</para>
<programlisting role="XML">
<![CDATA[
- <e:worksheet templates="foo" verticalFreeze="5">
- ...
- </e:worksheet>
+<e:workbook>
+ <e:worksheet templates="foo" verticalFreeze="5"/>
+</e:workbook>
]]>
</programlisting>
<para>
you end up with a worksheet that is frozen at column 5 and row 5. Note that a worksheetTemplate is
- essentially a named worksheet so refer to the linked documentation for available attributes.
+ essentially a named worksheet (see <xref linkend="excel.worksheet"/>).
</para>
</section>
@@ -2441,8 +2551,7 @@
id="theDataTable"
value="#{personList.personList}"
var="person"
- style="xlsFontName : Times New Roman; xlsBackgroundColor : red"
- >
+ style="xlsFontName : Times New Roman; xlsBackgroundColor : red">
...
</h:dataTable>
</h:form>
@@ -2482,7 +2591,7 @@
<para>xlsFontColor</para>
</entry>
<entry valign="top">
- <para>The color of the font. See link for valid colors</para>
+ <para>The color of the font (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/Colour.html">jxl.format.Colour</ulink>).</para>
</entry>
</row>
<row>
@@ -2506,7 +2615,7 @@
<para>xlsFontScriptStyle</para>
</entry>
<entry valign="top">
- <para>The script style of the font. See link for valid script styles</para>
+ <para>The script style of the font (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/ScriptStyle.html">jxl.format.ScriptStyle</ulink>).</para>
</entry>
</row>
<row>
@@ -2522,7 +2631,7 @@
<para>xlsFontUnderlineStyle</para>
</entry>
<entry valign="top">
- <para>The underline style of the font. See link for valid underline styles</para>
+ <para>The underline style of the font (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/UnderlineStyle.html">jxl.format.UnderlineStyle</ulink>).</para>
</entry>
</row>
<row>
@@ -2530,7 +2639,7 @@
<para>xlsBackgroundColor</para>
</entry>
<entry valign="top">
- <para>The background color of the cell. See link for valid colors</para>
+ <para>The background color of the cell (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/Colour.html">jxl.format.Colour</ulink>).</para>
</entry>
</row>
<row>
@@ -2538,7 +2647,7 @@
<para>xlsBackgroundPattern</para>
</entry>
<entry valign="top">
- <para>The background pattern of the cell. See link for valid patterns</para>
+ <para>The background pattern of the cell (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/Pattern.html">jxl.format.Pattern</ulink>).</para>
</entry>
</row>
<row>
@@ -2546,7 +2655,7 @@
<para>xlsAlignment</para>
</entry>
<entry valign="top">
- <para>The alignment of the cell value. See link for valid alignments</para>
+ <para>The alignment of the cell value (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/Alignment.html">jxl.format.Alignment</ulink>).</para>
</entry>
</row>
<row>
@@ -2581,7 +2690,7 @@
<para>xlsBorderColor</para>
</entry>
<entry valign="top">
- <para>The the border color of the entire cell. See link for valid colors</para>
+ <para>The the border color of the entire cell (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/Colour.html">jxl.format.Colour</ulink>).</para>
</entry>
</row>
<row>
@@ -2589,7 +2698,7 @@
<para>xlsBorderColorLeft</para>
</entry>
<entry valign="top">
- <para>The the border color of the left edge of the cell. See link for valid colors</para>
+ <para>The the border color of the left edge of the cell (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/Colour.html">jxl.format.Colour</ulink>).</para>
</entry>
</row>
<row>
@@ -2597,7 +2706,7 @@
<para>xlsBorderColorTop</para>
</entry>
<entry valign="top">
- <para>The the border color of the top edge of the cell. See link for valid colors</para>
+ <para>The the border color of the top edge of the cell (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/Colour.html">jxl.format.Colour</ulink>).</para>
</entry>
</row>
<row>
@@ -2605,7 +2714,7 @@
<para>xlsBorderColorRight</para>
</entry>
<entry valign="top">
- <para>The the border color of the right edge of the cell. See link for valid colors</para>
+ <para>The the border color of the right edge of the cell (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/Colour.html">jxl.format.Colour</ulink>).</para>
</entry>
</row>
<row>
@@ -2613,7 +2722,7 @@
<para>xlsBorderColorBottom</para>
</entry>
<entry valign="top">
- <para>The the border color of the bottom edge of the cell. See link for valid colors</para>
+ <para>The the border color of the bottom edge of the cell (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/Colour.html">jxl.format.Colour</ulink>).</para>
</entry>
</row>
<row>
@@ -2621,7 +2730,7 @@
<para>xlsBorderLineStyle</para>
</entry>
<entry valign="top">
- <para>The the border line style of the entire cell. See link for valid border line styles</para>
+ <para>The the border line style of the entire cell (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/Colour.html">jxl.format.Colour</ulink>).</para>
</entry>
</row>
<row>
@@ -2630,7 +2739,7 @@
</entry>
<entry valign="top">
<para>
- The the border line style of the left edge of the cell. See link for valid border line styles
+ The the border line style of the left edge of the cell (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/Colour.html">jxl.format.Colour</ulink>).
</para>
</entry>
</row>
@@ -2640,7 +2749,7 @@
</entry>
<entry valign="top">
<para>
- The the border line style of the top edge of the cell. See link for valid border line styles
+ The the border line style of the top edge of the cell (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/Colour.html">jxl.format.Colour</ulink>).
</para>
</entry>
</row>
@@ -2650,7 +2759,7 @@
</entry>
<entry valign="top">
<para>
- The the border line style of the right edge of the cell. See link for valid border line
+ The the border line style of the right edge of the cell (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/Colour.html">jxl.format.Colour</ulink>).
styles
</para>
</entry>
@@ -2661,7 +2770,7 @@
</entry>
<entry valign="top">
<para>
- The the border line style of the bottom edge of the cell. See link for valid border line
+ The the border line style of the bottom edge of the cell (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/Colour.html">jxl.format.Colour</ulink>).
styles
</para>
</entry>
More information about the seam-commits
mailing list