[seam-commits] Seam SVN: r8632 -
trunk/doc/Seam_Reference_Guide/en-US.
seam-commits at lists.jboss.org
seam-commits at lists.jboss.org
Fri Aug 8 05:21:35 EDT 2008
Author: nickarls
Date: 2008-08-08 05:21:35 -0400 (Fri, 08 Aug 2008)
New Revision: 8632
Modified:
trunk/doc/Seam_Reference_Guide/en-US/Excel.xml
Log:
JBSEAM-3234: Format documentation according to standards
Modified: trunk/doc/Seam_Reference_Guide/en-US/Excel.xml
===================================================================
--- trunk/doc/Seam_Reference_Guide/en-US/Excel.xml 2008-08-08 08:28:15 UTC (rev 8631)
+++ trunk/doc/Seam_Reference_Guide/en-US/Excel.xml 2008-08-08 09:21:35 UTC (rev 8632)
@@ -1,53 +1,50 @@
-<?xml version="1.0" standalone="no"?>
+<?xml version="1.0" standalone="no"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY excel 'the <trademark class="registered">Microsoft</trademark> <trademark class="registered">Excel</trademark> spreadsheet application'>
<!ENTITY Excel 'The <trademark class="registered">Microsoft</trademark> <trademark class="registered">Excel</trademark> spreadsheet application'>
]>
-
-
-<chapter id="excel">
+<chapter id="excel">
<title>&Excel;</title>
<para>
- Seam also supports generation of
- &excel;
- spreadsheets through the excellent
- <ulink url="http://jexcelapi.sourceforge.net/">JExcelAPI</ulink> library.
- The generated document is compatible with &excel;
- 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 refer to the JExcelAPI
- documentation for more information on capabilities and limitations.
+ Seam also supports generation of &excel; spreadsheets through the
+ excellent <ulink url="http://jexcelapi.sourceforge.net/">JExcelAPI
+ </ulink> library. The generated document is compatible with
+ &excel; 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
+ refer to the JExcelAPI documentation for more information on
+ capabilities and limitations.
</para>
<section id="excel.intro">
<title>&Excel; support</title>
<para>
- &Excel; <literal>jboss-seam-excel.jar</literal>. This JAR contains the
- &excel; JSF controls, which are used to construct views that can render
- the document, and the DocumentStore component, which serves the
- rendered document to the user. To include &excel; support in your
- application, included <literal>jboss-seam-excel.jar</literal> in your
- <literal>WEB-INF/lib</literal> directory along with the
- <literal>jxl.jar</literal> JAR file. Furthermore, you need to configure
- the DocumentStore servlet in your web.xml
+ &Excel; <literal>jboss-seam-excel.jar</literal>. This JAR contains
+ the &excel; JSF controls, which are used to construct views that can
+ render the document, and the DocumentStore component, which serves
+ the rendered document to the user. To include &excel; support in
+ your application, included <literal>jboss-seam-excel.jar</literal>
+ in your <literal>WEB-INF/lib</literal> directory along with the
+ <literal>jxl.jar</literal> JAR file. Furthermore, you need to
+ configure the DocumentStore servlet in your web.xml
</para>
<para>
- &Excel; Seam module requires the use of Facelets as the view
+ &Excel; Seam module requires the use of Facelets as the view
technology. Additionally, it requires the use of the seam-ui package.
</para>
<para>
- The <literal>examples/excel</literal> project contains an example of
- &excel; support in action. It demonstrates proper deployment packaging,
- and it shows the exposed functionality.
+ The <literal>examples/excel</literal> project contains an example of
+ &excel; support in action. It demonstrates proper deployment
+ packaging, and it shows the exposed functionality.
</para>
<para>
- Customizing the module to support other kinds of &excel; spreadsheet
- API's has been made very easy. Implement the
- <literal>ExcelWorkbook</literal> interface, set the component name to
- <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
+ Customizing the module to support other kinds of &excel; spreadsheet
+ API's has been made very easy. Implement the <literal>ExcelWorkbook
+ </literal> interface, set the component name to
+ <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 "csv".
</para>
@@ -55,44 +52,55 @@
<section id="excel.usage">
<title>Creating a simple workbook</title>
<para>
- Basic usage of the worksheet support is simple; it is used like a familiar
- <literal><h:dataTable></literal>
- and you can bind to a <literal>List</literal>, <literal>Set</literal>,
- <literal>Map</literal>, <literal>Array</literal> or
+ Basic usage of the worksheet support is simple; it is used like a
+ familiar <literal><h:dataTable></literal> and you can bind to a
+ <literal>List</literal>, <literal>Set</literal>,
+ <literal>Map</literal>, <literal>Array</literal> or
<literal>DataModel</literal>.
</para>
<programlisting role="XML">
<![CDATA[
-<e:workbook xmlns:e="http://jboss.com/products/seam/excel">
- <e:worksheet>
- <e:cell column="0" row="0" value="Hello world!"/>
- </e:worksheet>
-</e:workbook>
+ <e:workbook xmlns:e="http://jboss.com/products/seam/excel">
+ <e:worksheet>
+ <e:cell column="0" row="0" value="Hello world!"/>
+ </e:worksheet>
+ </e:workbook>
]]>
</programlisting>
- <para>That's not terribly useful, so lets have a look at a more common case:</para>
+ <para>
+ That's not terribly useful, so lets have a look at a more common case:
+ </para>
<programlisting role="XML">
<![CDATA[
-<e:workbook xmlns:e="http://jboss.com/products/seam/excel">
- <e:worksheet value="#{data}" var="item">
- <e:column>
- <e:cell value="#{item.value}"/>
- </e:worksheet>
-</e:workbook>
-]]>
+ <e:workbook xmlns:e="http://jboss.com/products/seam/excel">
+ <e:worksheet value="#{data}" var="item">
+ <e:column>
+ <e:cell value="#{item.value}"/>
+ </e:column>
+ </e:worksheet>
+ </e:workbook>
+ ]]>
</programlisting>
<para>
- First we have the top-level workbook element which serves as the container and it doesn't have any attributes.
- The child-element worksheet has two attributes; value="#{data}" is the EL-binding to the data and
- var="item" is the name of the current item. Nested inside the worksheet is a single column and within
- it you see the cell which is the final bind to the data within the currently iterated item
+ First we have the top-level workbook element which serves as the
+ container and it doesn't have any attributes. The child-element
+ worksheet has two attributes; value="#{data}" is the
+ EL-binding to the data and var="item" is the name of the
+ current item. Nested inside the worksheet is a single column and within
+ it you see the cell which is the final bind to the data within the
+ currently iterated item
</para>
- <para>This is all you know to get started dumping your data to worksheets!</para>
+ <para>
+ This is all you know to get started dumping your data to worksheets!
+ </para>
</section>
<section id="excel.workbook">
<title>Workbooks</title>
- <para>Workbooks are the top-level parents 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*" />
@@ -112,154 +120,189 @@
<listitem>
<para>
<literal>type</literal>
- —Defines which export module to be used. The value is a string and can be either
- "jxl" or "csv". The default is "jxl".
+ —Defines which export module to be used. The
+ value is a string and can be either "jxl" or
+ "csv". The default is "jxl".
</para>
</listitem>
<listitem>
<para>
<literal>templateURI</literal>
- —A template that should be used as a basis for the workbook. The value is a string
- (URI).
+ —A template that should be used as a basis
+ for the workbook. The value is a string (URI).
</para>
</listitem>
<listitem>
<para>
<literal>arrayGrowSize</literal>
- —The amount of memory by which to increase the amount of memory allocated to storing
- the workbook data. For processeses reading many small workbooks inside a WAS it might be
- necessary to reduce the default size Default value is 1 megabyte. The value is a number
- (bytes).
+ —The amount of memory by which to increase
+ the amount of memory allocated to storing the
+ workbook data. For processeses reading many small
+ workbooks inside a WAS it might be necessary to
+ reduce the default size Default value is 1
+ megabyte. The value is a number (bytes).
</para>
</listitem>
<listitem>
<para>
<literal>autoFilterDisabled</literal>
- —Should autofiltering be disabled?. The value is a boolean.
+ —Should autofiltering be disabled?. The
+ value is a boolean.
</para>
</listitem>
<listitem>
<para>
<literal>cellValidationDisabled</literal>
- —Shoule cell validation be ignored? The value is a boolean.
+ —Shoule cell validation be ignored? The
+ value is a boolean.
</para>
</listitem>
<listitem>
<para>
<literal>characterSet</literal>
- —The character set. This is only used when the spreadsheet is read, and has no
- effect when the spreadsheet is written. The value is a string (character set encoding).
+ —The character set. This is only used when
+ the spreadsheet is read, and has no effect when
+ the spreadsheet is written. The value is a string
+ (character set encoding).
</para>
</listitem>
<listitem>
<para>
<literal>drawingsDisabled</literal>
- —Should drawings be disabled? The value is a boolean.
+ —Should drawings be disabled? The value is a
+ boolean.
</para>
</listitem>
<listitem>
<para>
<literal>excelDisplayLanguage</literal>
- —The language in which the generated file will display. The value is a string (two
- character ISO 3166 country code).
+ —The language in which the generated file
+ will display. The value is a string (two character
+ ISO 3166 country code).
</para>
</listitem>
<listitem>
<para>
<literal>excelRegionalSettings</literal>
- —The regional settings for the generated excel file. The value is a string (two
- character ISO 3166 country code).
+ —The regional settings for the generated
+ excel file. The value is a string (two character
+ ISO 3166 country code).
</para>
</listitem>
<listitem>
<para>
<literal>formulaAdjust</literal>
- —Should formulas be adjusted? The value is a boolean.
+ —Should formulas be adjusted? The value is a
+ boolean.
</para>
</listitem>
<listitem>
<para>
<literal>gcDisabled</literal>
- —Should garbage collection be disabled? The value is a boolean.
+ —Should garbage collection be disabled? The
+ value is a boolean.
</para>
</listitem>
<listitem>
<para>
<literal>ignoreBlanks</literal>
- —Should blanks be ignored? The value is a boolean.
+ —Should blanks be ignored? The value is a
+ boolean.
</para>
</listitem>
<listitem>
<para>
<literal>initialFileSize</literal>
- —The initial amount of memory allocated to store the workbook data when reading a
- worksheet. For processeses reading many small workbooks inside a WAS it might be necessary
- to reduce the default size Default value is 5 megabytes. The value is a number (bytes).
+ —The initial amount of memory allocated to
+ store the workbook data when reading a worksheet.
+ For processeses reading many small workbooks
+ inside a WAS it might be necessary to reduce the
+ default size Default value is 5 megabytes. The
+ value is a number (bytes).
</para>
</listitem>
<listitem>
<para>
<literal>locale</literal>
- —The locale used by JExcelApi to generate the spreadsheet. Setting this value has no
- effect on the language or region of the generated excel file. The value is a string.
+ —The locale used by JExcelApi to generate
+ the spreadsheet. Setting this value has no effect
+ on the language or region of the generated excel
+ file. The value is a string.
</para>
</listitem>
<listitem>
<para>
<literal>mergedCellCheckingDisabled</literal>
- —Should merged cell checking be disabled? The value is a boolean.
+ —Should merged cell checking be disabled?
+ The value is a boolean.
</para>
</listitem>
<listitem>
<para>
<literal>namesDisabled</literal>
- —Should handling of names be disabled? The value is a boolean.
+ —Should handling of names be disabled? The
+ value is a boolean.
</para>
</listitem>
<listitem>
<para>
<literal>propertySets</literal>
- —Should any property sets be enabled (such as macros) to be copied along with the
- workbook? Leaving this feature enabled will result in the JXL process using more memory.
- The value is a boolean.
+ —Should any property sets be enabled (such
+ as macros) to be copied along with the workbook?
+ Leaving this feature enabled will result in the
+ JXL process using more memory. The value is a
+ boolean.
</para>
</listitem>
<listitem>
<para>
<literal>rationalization</literal>
- —Should the cell formats be rationalized before writing out the sheet? The value is
- a boolean. Default is true.
+ —Should the cell formats be rationalized
+ before writing out the sheet? The value is a
+ boolean. Default is true.
</para>
</listitem>
<listitem>
<para>
<literal>supressWarnings</literal>
- —Should warnings be suppressed?. Due to the change in logging in version 2.4, this
- will now set the warning behaviour across the JVM (depending on the type of logger used).
- The value is a boolean.
+ —Should warnings be suppressed?. Due to the
+ change in logging in version 2.4, this will now
+ set the warning behaviour across the JVM
+ (depending on the type of logger used). The value
+ is a boolean.
</para>
</listitem>
<listitem>
<para>
- <literal>temporaryFileDuringWriteDirectory</literal>
- —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).
+ <literal>
+ temporaryFileDuringWriteDirectory
+ </literal>
+ —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).
</para>
</listitem>
<listitem>
<para>
<literal>useTemporaryFileDuringWrite</literal>
- —Should a temporary file is used during the generation of the workbook. If not set,
- the workbook will take place entirely in memory. Setting this flag involves an assessment
- of the trade-offs between memory usage and performance. The value is a boolean.
+ —Should a temporary file is used during the
+ generation of the workbook. If not set, the
+ workbook will take place entirely in memory.
+ Setting this flag involves an assessment of the
+ trade-offs between memory usage and performance.
+ The value is a boolean.
</para>
</listitem>
<listitem>
<para>
<literal>workbookProtected</literal>
- —Should the workbook be protected? The value is a boolean.
+ —Should the workbook be protected? The value
+ is a boolean.
</para>
</listitem>
</itemizedlist>
@@ -270,19 +313,25 @@
<listitem>
<para>
<literal><e:cellTemplate/></literal>
- —Zero or more cell templates (see <xref linkend="excel.templates.cell"/>).
+ —Zero or more cell templates (see
+ <xref linkend="excel.templates.cell" />
+ ).
</para>
</listitem>
<listitem>
<para>
<literal><e:worksheetTemplate/></literal>
- —Zero or more worksheet templates (see <xref linkend="excel.templates.worksheetsettings"/>).
+ —Zero or more worksheet templates (see
+ <xref linkend="excel.templates.worksheetsettings" />
+ ).
</para>
</listitem>
<listitem>
<para>
<literal><e:worksheet/></literal>
- —Zero or more worksheets (see <xref linkend="excel.worksheet"/>).
+ —Zero or more worksheets (see
+ <xref linkend="excel.worksheet" />
+ ).
</para>
</listitem>
</itemizedlist>
@@ -303,11 +352,11 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
-<e:workbook>
- <e:worksheet>
- <e:cell value="Hello World" row="0" column="0"/>
- </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>
@@ -316,9 +365,10 @@
<section id="excel.worksheet">
<title>Worksheets</title>
<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.
+ 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">
@@ -336,252 +386,303 @@
<listitem>
<para>
<literal>value</literal>
- —An EL-expression to the backing data. The value is a string.
+ —An EL-expression to the backing data. The
+ value is a string.
</para>
</listitem>
<listitem>
<para>
<literal>var</literal>
- —The current row iterator variable name that can later be referenced in cell value
- attributes. The value is a string
+ —The current row iterator variable name that
+ can later be referenced in cell value attributes.
+ The value is a string
</para>
</listitem>
<listitem>
<para>
<literal>name</literal>
- —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 <literal>startRow</literal> and <literal>startCol</literal> to make sure that they don't occupy the same space).
+ —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
+ <literal>startRow</literal>
+ and
+ <literal>startCol</literal>
+ to make sure that they don't occupy the same
+ space).
</para>
</listitem>
<listitem>
<para>
<literal>startRow</literal>
- —Defines the starting row for the data. The value is a number. Used for placing the
- data in other places than the upper-left corner (especially useful if having multiple data
- sets for a single worksheet). The defaults is 0.
+ —Defines the starting row for the data. The
+ value is a number. Used for placing the data in
+ other places than the upper-left corner
+ (especially useful if having multiple data sets
+ for a single worksheet). The defaults is 0.
</para>
</listitem>
<listitem>
<para>
<literal>startColumn</literal>
- —Defines the starting column for the data. The value is a number. Used for placing
- the data in other places than the upper-left corner (especially useful if having multiple
- data sets for a single worksheet). The default is 0.
+ —Defines the starting column for the data.
+ The value is a number. Used for placing the data
+ in other places than the upper-left corner
+ (especially useful if having multiple data sets
+ for a single worksheet). The default is 0.
</para>
</listitem>
<listitem>
<para>
<literal>templates</literal>
- —The comma-separated list of <literal>worksheetTemplates</literal> to cascade on. The value is a
- string (see <xref linkend="excel.templates.cell"/>).
+ —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>
<para>
<literal>automaticFormulaCalculation</literal>
- —Should formulas be automatically calculated? The value is a boolean.
+ —Should formulas be automatically
+ calculated? The value is a boolean.
</para>
</listitem>
<listitem>
<para>
<literal>bottomMargin</literal>
- —The bottom margin. The value is a number (inches)
+ —The bottom margin. The value is a number
+ (inches)
</para>
</listitem>
<listitem>
<para>
<literal>copies</literal>
- —The number of copies. The value is a number.
+ —The number of copies. The value is a
+ number.
</para>
</listitem>
<listitem>
<para>
<literal>defaultColumnWidth</literal>
- —The default column width. The value is a number (characters * 256).
+ —The default column width. The value is a
+ number (characters * 256).
</para>
</listitem>
<listitem>
<para>
<literal>defaultRowHeight</literal>
- —The default row height. The value is a number (1/20ths of a point).
+ —The default row height. The value is a
+ number (1/20ths of a point).
</para>
</listitem>
<listitem>
<para>
<literal>displayZeroValues</literal>
- —Should zero-values be displayed? The value is a boolean.
+ —Should zero-values be displayed? The value
+ is a boolean.
</para>
</listitem>
<listitem>
<para>
<literal>fitHeight</literal>
- —The number of pages vertically that this sheet will be printed into. The value is a
- number.
+ —The number of pages vertically that this
+ sheet will be printed into. The value is a number.
</para>
</listitem>
<listitem>
<para>
<literal>fitToPages</literal>
- —Should printing be fit to pages? The value is a boolean.
+ —Should printing be fit to pages? The value
+ is a boolean.
</para>
</listitem>
<listitem>
<para>
<literal>fitWidth</literal>
- —The number of pages widthwise which this sheet should be printed into. The value is
- a number.
+ —The number of pages widthwise which this
+ sheet should be printed into. The value is a
+ number.
</para>
</listitem>
<listitem>
<para>
<literal>footerMargin</literal>
- —The margin for any page footer. The value is a number (inches).
+ —The margin for any page footer. The value
+ is a number (inches).
</para>
</listitem>
<listitem>
<para>
<literal>headerMargin</literal>
- —The margin for any page headers. The value is a number (inches).
+ —The margin for any page headers. The value
+ is a number (inches).
</para>
</listitem>
<listitem>
<para>
<literal>hidden</literal>
- —Should the worksheet be hidden? The value is a boolean.
+ —Should the worksheet be hidden? The value
+ is a boolean.
</para>
</listitem>
<listitem>
<para>
<literal>horizontalCentre</literal>
- —Should the worksheet be centered horizontally? The value is a boolean.
+ —Should the worksheet be centered
+ horizontally? The value is a boolean.
</para>
</listitem>
<listitem>
<para>
<literal>horizontalFreeze</literal>
- —The row at which the pane is frozen vertically. The value is a number.
+ —The row at which the pane is frozen
+ vertically. The value is a number.
</para>
</listitem>
<listitem>
<para>
<literal>horizontalPrintResolution</literal>
- —The horizontal print resolution. The value is a number.
+ —The horizontal print resolution. The value
+ is a number.
</para>
</listitem>
<listitem>
<para>
<literal>leftMargin</literal>
- —The left margin. The value is a number (inches).
+ —The left margin. The value is a number
+ (inches).
</para>
</listitem>
<listitem>
<para>
<literal>normalMagnification</literal>
- —The normal magnificaton factor (not zoom or scale factor). The value is a number
- (percentage).
+ —The normal magnificaton factor (not zoom or
+ scale factor). The value is a number (percentage).
</para>
</listitem>
<listitem>
<para>
<literal>orientation</literal>
- —The paper orientation for printing this sheet. The value is a string that can be
- either "landscape" or "portrait".
+ —The paper orientation for printing this
+ sheet. The value is a string that can be either
+ "landscape" or "portrait".
</para>
</listitem>
<listitem>
<para>
<literal>pageBreakPreviewMagnification</literal>
- —The page break preview magnificaton factor (not zoom or scale factors). the value
- is a number (percentage).
+ —The page break preview magnificaton factor
+ (not zoom or scale factors). the value is a number
+ (percentage).
</para>
</listitem>
<listitem>
<para>
<literal>pageBreakPreviewMode</literal>
- —Show page in preview mode? The value is a boolean.
+ —Show page in preview mode? The value is a
+ boolean.
</para>
</listitem>
<listitem>
<para>
<literal>pageStart</literal>
- —The page number at which to commence printing. The value is a number.
+ —The page number at which to commence
+ printing. The value is a number.
</para>
</listitem>
<listitem>
<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 <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/PaperSize.html">jxl.format.PaperSize</ulink>).
+ —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
+ <ulink
+ url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/PaperSize.html">
+ jxl.format.PaperSize
+ </ulink>
+ ).
</para>
</listitem>
<listitem>
<para>
<literal>password</literal>
- —The password for this sheet. The value is a string.
+ —The password for this sheet. The value is a
+ string.
</para>
</listitem>
<listitem>
<para>
<literal>passwordHash</literal>
- —The password hash - used only when copying sheets. The value is a string.
+ —The password hash - used only when copying
+ sheets. The value is a string.
</para>
</listitem>
<listitem>
<para>
<literal>printGridLines</literal>
- —Should grid lines be printed? The value is a boolean.
+ —Should grid lines be printed? The value is
+ a boolean.
</para>
</listitem>
<listitem>
<para>
<literal>printHeaders</literal>
- —Should headers be printed? The value is a boolean.
+ —Should headers be printed? The value is a
+ boolean.
</para>
</listitem>
<listitem>
<para>
<literal>sheetProtected</literal>
- —Should the sheet be protected (read-only)? The value is a boolean.
+ —Should the sheet be protected (read-only)?
+ The value is a boolean.
</para>
</listitem>
<listitem>
<para>
<literal>recalculateFormulasBeforeSave</literal>
- —Should the formulas be re-calculated when the sheet is saved? The value is a
- boolean. false
+ —Should the formulas be re-calculated when
+ the sheet is saved? The value is a boolean. false
</para>
</listitem>
<listitem>
<para>
<literal>rightMargin</literal>
- —The right margin. The value is a number (inches).
+ —The right margin. The value is a number
+ (inches).
</para>
</listitem>
<listitem>
<para>
<literal>scaleFactor</literal>
- —The scale factor for this sheet to be used when printing. The value is a number
- (percent).
+ —The scale factor for this sheet to be used
+ when printing. The value is a number (percent).
</para>
</listitem>
<listitem>
<para>
<literal>selected</literal>
- —Should the sheet be selected when the workbook opens? The value is a boolean.
+ —Should the sheet be selected when the
+ workbook opens? The value is a boolean.
</para>
</listitem>
<listitem>
<para>
<literal>showGridLines</literal>
- —Should gridlines be shown? The value is a boolean.
+ —Should gridlines be shown? The value is a
+ boolean.
</para>
</listitem>
<listitem>
<para>
<literal>topMargin</literal>
- —The top margin. The value is a number (inches).
+ —The top margin. The value is a number
+ (inches).
</para>
</listitem>
<listitem>
@@ -593,21 +694,24 @@
<listitem>
<para>
<literal>verticalFreeze</literal>
- —The row at which the pane is frozen vertically. The value is a number.
+ —The row at which the pane is frozen
+ vertically. The value is a number.
</para>
</listitem>
<listitem>
<para>
<literal>verticalPrintResolution</literal>
- —The vertical print resolution. The value is a number.
+ —The vertical print resolution. The value is
+ a number.
</para>
</listitem>
<listitem>
<para>
<literal>zoomFactor</literal>
- —T zoom factor. Do not confuse zoom factor (which relates to the on screen view)
- with scale factor (which refers to the scale factor when printing). The value is a number
- (percentage.
+ —T zoom factor. Do not confuse zoom factor
+ (which relates to the on screen view) with scale
+ factor (which refers to the scale factor when
+ printing). The value is a number (percentage.
</para>
</listitem>
</itemizedlist>
@@ -618,24 +722,33 @@
<listitem>
<para>
<literal><e:printArea/></literal>
- —Zero or more print area definitions (see <xref linkend="excel.printareatitles"/>).
+ —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 <xref linkend="excel.printareatitles"/>).
+ —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 <xref linkend="excel.headersfooters"/>)).
+ —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"/> ).
+ Zero or more worksheet commands (see
+ <xref linkend="excel.worksheetcommands" />
+ ).
</para>
</listitem>
</itemizedlist>
@@ -656,16 +769,16 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
-<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>
+ <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>
@@ -673,8 +786,9 @@
<section id="excel.columns">
<title>Columns</title>
<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.
+ 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">
@@ -695,19 +809,22 @@
<listitem>
<para>
<literal>autoSize</literal>
- —Should the column be autosized? The value is a boolean.
+ —Should the column be autosized? The value
+ is a boolean.
</para>
</listitem>
<listitem>
<para>
<literal>hidden</literal>
- —Should the column be hidden? The value is a boolean.
+ —Should the column be hidden? The value is a
+ boolean.
</para>
</listitem>
<listitem>
<para>
<literal>width</literal>
- —The width of the column. The valus ia number (characters multiplied by 256)
+ —The width of the column. The valus ia
+ number (characters multiplied by 256)
</para>
</listitem>
</itemizedlist>
@@ -718,25 +835,33 @@
<listitem>
<para>
<literal><e:cell/></literal>
- —Zero or more cells (see <xref linkend="excel.cells"/>).
+ —Zero or more cells (see
+ <xref linkend="excel.cells" />
+ ).
</para>
</listitem>
<listitem>
<para>
<literal><e:formula/></literal>
- —Zero or more formulas (see <xref linkend="excel.formulas"/>).
+ —Zero or more formulas (see
+ <xref linkend="excel.formulas" />
+ ).
</para>
</listitem>
<listitem>
<para>
<literal><e:image/></literal>
- —Zero or more images (see <xref linkend="excel.images"/>).
+ —Zero or more images (see
+ <xref linkend="excel.images" />
+ ).
</para>
</listitem>
<listitem>
<para>
<literal><e:hyperLink/></literal>
- —Zero or more hyperlinks (see <xref linkend="excel.hyperlinks"/>).
+ —Zero or more hyperlinks (see
+ <xref linkend="excel.hyperlinks" />
+ ).
</para>
</listitem>
</itemizedlist>
@@ -766,16 +891,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>
@@ -784,10 +909,12 @@
<section id="excel.cells">
<title>Cells</title>
<para>
- 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.
+ 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 contain
+ fonts and other formattings and can also use pre-defined templates.
</para>
<informaltable>
<tgroup cols="2">
@@ -808,108 +935,130 @@
<listitem>
<para>
<literal>column</literal>
- —The column where to place the cell. The default is the internal counter. The value
- is a number. Note that the value is 0-based.
+ —The column where to place the cell. The
+ default is the internal counter. The value 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
+ —The row where to place the cell. The
+ default is the internal counter. The value is
number. Note that the value is 0-based.
</para>
</listitem>
<listitem>
<para>
<literal>value</literal>
- —The value to display. Usually an EL-expression referencing the var-attribute of the
+ —The value to display. Usually an
+ EL-expression referencing the var-attribute of the
containing datatable. The value is a string.
</para>
</listitem>
<listitem>
<para>
<literal>templates</literal>
- —A comma-separated list of cascading, predefined templates to apply before the own
- formattings (see <xref linkend="excel.templates.cell"/>).
+ —A comma-separated list of cascading,
+ predefined templates to apply before the own
+ formattings (see
+ <xref linkend="excel.templates.cell" />
+ ).
</para>
</listitem>
<listitem>
<para>
<literal>forceType</literal>
- —The forced type of the cell data. The value is a string that can be one of
- "general", "number", "text", "date", "formula" or "bool". The type is automatically
- detected so there is rarely any use for this attribute.
+ —The forced type of the cell data. The value
+ is a string that can be one of "general",
+ "number", "text", "date", "formula" or "bool". The
+ type is automatically detected so there is rarely
+ any use for this attribute.
</para>
</listitem>
<listitem>
<para>
<literal>alignment</literal>
- —The alignment of the cell data. The value is a string that can be one of "centre",
- "fill", "general", "justify", "left" or "right".
+ —The alignment of the cell data. The value
+ is a string that can be one of "centre", "fill",
+ "general", "justify", "left" or "right".
</para>
</listitem>
<listitem>
<para>
<literal>comment</literal>
- —A comment to add to the cell. The value is a string.
+ —A comment to add to the cell. The value is
+ a string.
</para>
</listitem>
<listitem>
<para>
<literal>commentHeight</literal>
- —The height of the comment. The value is a number (in pixels).
+ —The height of the comment. The value is a
+ number (in pixels).
</para>
</listitem>
<listitem>
<para>
<literal>commentWidth</literal>
- —A width of the comment. The value is a number (in pixels).
+ —A width of the comment. The value is a
+ number (in pixels).
</para>
</listitem>
<listitem>
<para>
<literal>indentation</literal>
- —The indentation of the cell. The value is a number (in pixels)
+ —The indentation of the cell. The value is a
+ number (in pixels)
</para>
</listitem>
<listitem>
<para>
<literal>locked</literal>
- —Should the cell be locked? For this to have any effect, the sheet containing cells
- with this format must also be locked. The value is a boolean.
+ —Should the cell be locked? For this to have
+ any effect, the sheet containing cells with this
+ format must also be locked. The value is a
+ boolean.
</para>
</listitem>
<listitem>
<para>
<literal>mask</literal>
- —A format mask (see <xref linkend="excel.cells.formatmasks"/>).
+ —A format mask (see
+ <xref linkend="excel.cells.formatmasks" />
+ ).
</para>
</listitem>
<listitem>
<para>
<literal>orientation</literal>
- —The orientation of the cell data. The value is a string that can be one of
- "horizontal", "minus_45", "minus_90", "plus_45", "plus_90", "stacked" or "vertical".
+ —The orientation of the cell data. The value
+ is a string that can be one of "horizontal",
+ "minus_45", "minus_90", "plus_45", "plus_90",
+ "stacked" or "vertical".
</para>
</listitem>
<listitem>
<para>
<literal>shrinkToFit</literal>
- —Should the cell data be shrunk to fit? The value is a boolean.
+ —Should the cell data be shrunk to fit? The
+ value is a boolean.
</para>
</listitem>
<listitem>
<para>
<literal>verticalAlignment</literal>
- —The vertical aligment of the cell data. The value is a string that can be one of
- "bottom", "centre", "justify" or "top").
+ —The vertical aligment of the cell data. The
+ value is a string that can be one of "bottom",
+ "centre", "justify" or "top").
</para>
</listitem>
<listitem>
<para>
<literal>wrap</literal>
- —Should the data be wrapped so that it fits within the cell boundaries? The value is
- a boolean.
+ —Should the data be wrapped so that it fits
+ within the cell boundaries? The value is a
+ boolean.
</para>
</listitem>
</itemizedlist>
@@ -921,24 +1070,32 @@
<listitem>
<para>
<literal><e:font/></literal>
- —Zero or more font definitions (see <xref linkend="excel.cells.fonts"/>).
+ —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 <xref linkend="excel.cells.borders"/>).
+ —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 <xref linkend="excel.cells.backgrounds"/>).
+ —Zero or more background definitions (see
+ <xref linkend="excel.cells.backgrounds" />
+ ).
</para>
</listitem>
<listitem>
<para>
- Zero or more validation conditions (see <xref linkend="excel.cells.validation"/>).
+ Zero or more validation conditions (see
+ <xref linkend="excel.cells.validation" />
+ ).
</para>
</listitem>
@@ -960,23 +1117,24 @@
</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>
<section id="excel.cells.fonts">
<title>Fonts</title>
<para>
- Fonts are nested inside cells, formulas, hyperlinks or cell templates. They determine the typeface of the cell data
+ Fonts are nested inside cells, formulas, hyperlinks or cell
+ templates. They determine the typeface of the cell data
</para>
<informaltable>
<tgroup cols="2">
@@ -997,54 +1155,72 @@
<listitem>
<para>
<literal>fontName</literal>
- —The font name. The value is a string. Should be used with care, since the used
- font must be recognized by the <trademark class="registered">Microsoft</trademark>
- <trademark class="registered">Excel</trademark> spreadsheet application
+ —The font name. The value is a string.
+ Should be used with care, since the used font
+ must be recognized by the
+ <trademark class="registered">
+ Microsoft
+ </trademark>
+ <trademark class="registered">Excel</trademark>
+ spreadsheet application
</para>
</listitem>
<listitem>
<para>
<literal>color</literal>
- —The color of the background. The value is a string that can be one of "blue",
- "red" etc (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/Colour.html">jxl.format.Colour</ulink>).
+ —The color of the background. The value
+ is a string that can be one of "blue", "red"
+ etc (see
+ <ulink
+ url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/Colour.html">
+ jxl.format.Colour
+ </ulink>
+ ).
</para>
</listitem>
<listitem>
<para>
<literal>pointSize</literal>
- —The point size of the font. The value is a number.
+ —The point size of the font. The value is
+ a number.
</para>
</listitem>
<listitem>
<para>
<literal>bold</literal>
- —Should the font be bold? The value is a boolean.
+ —Should the font be bold? The value is a
+ boolean.
</para>
</listitem>
<listitem>
<para>
<literal>italic</literal>
- —Should the font be italic? The value is a boolean.
+ —Should the font be italic? The value is
+ a boolean.
</para>
</listitem>
<listitem>
<para>
<literal>struckOut</literal>
- —Should the font be struck out? The value is a boolean.
+ —Should the font be struck out? The value
+ is a boolean.
</para>
</listitem>
<listitem>
<para>
<literal>scriptStyle</literal>
- —The script style of the font. The value is a string that can be one of
- "normal_script", "subscript" or "superscript".
+ —The script style of the font. The value
+ is a string that can be one of "normal_script",
+ "subscript" or "superscript".
</para>
</listitem>
<listitem>
<para>
<literal>underlineStyle</literal>
- —The underline style of the font. The value is a string that can be one of
- "double", "double_accounting", "no_underline", "single" or "single_accounting".
+ —The underline style of the font. The
+ value is a string that can be one of "double",
+ "double_accounting", "no_underline", "single"
+ or "single_accounting".
</para>
</listitem>
</itemizedlist>
@@ -1075,15 +1251,15 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
-<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>
+ <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>
@@ -1091,8 +1267,8 @@
<section id="excel.cells.backgrounds">
<title>Backgrounds</title>
<para>
- Backgrounds are nested inside cells, formulas, hyperlinks or cell templates. They determine
- the color and pattern of the cell.
+ Backgrounds are nested inside cells, formulas, hyperlinks or cell
+ templates. They determine the color and pattern of the cell.
</para>
<informaltable>
<tgroup cols="2">
@@ -1113,16 +1289,22 @@
<listitem>
<para>
<literal>pattern</literal>
- —The pattern of the background. The value is a string that can be one of "solid",
- "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".
+ —The pattern of the background. The value
+ is a string that can be one of "solid",
+ "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>
<listitem>
<para>
<literal>color</literal>
- —The color of the background. The value is a string that can be one of "blue",
- "red" etc
+ —The color of the background. The value
+ is a string that can be one of "blue", "red"
+ etc
</para>
</listitem>
</itemizedlist>
@@ -1153,15 +1335,15 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
-<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>
+ <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>
@@ -1169,8 +1351,9 @@
<section id="excel.cells.borders">
<title>Borders</title>
<para>
- Borders are nested inside cells, formulas, hyperlinks and cell templates.
- They determine the color and line style of the cell borders.
+ 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">
@@ -1191,22 +1374,36 @@
<listitem>
<para>
<literal>border</literal>
- —The border to apply the settings to. The value is a string that can be one of
- "all", "bottom", "left", "none", "right" or "top". The default is "all".
+ —The border to apply the settings to. The
+ value is a string that can be one of "all",
+ "bottom", "left", "none", "right" or "top". The
+ default is "all".
</para>
</listitem>
<listitem>
<para>
<literal>lineStyle</literal>
- —The border line style. The value is a string that can be one of "medium", "thin"
- etc (see <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/BorderLineStyler.html">jxl.format.BorderLineStyle</ulink>).
+ —The border line style. The value is a
+ string that can be one of "medium", "thin" 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 <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/Colour.html">jxl.format.Colour</ulink>).
+ —The color of the border. The value is a
+ string that can be one of "blue", "red" etc
+ (see
+ <ulink
+ url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/format/Colour.html">
+ jxl.format.Colour
+ </ulink>
+ ).
</para>
</listitem>
</itemizedlist>
@@ -1237,23 +1434,23 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
-<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>
- ]]>
+ <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.cells.validation">
<title>Validation</title>
<para>
- Validations are nested inside cells, formulas or cell templates.
+ Validations are nested inside cells, formulas or cell templates.
They add constrains for the cell data.
</para>
<informaltable>
@@ -1275,46 +1472,57 @@
<listitem>
<para>
<literal>value</literal>
- —The limit (or lower limit where applicable) of the validation. The value is a
+ —The limit (or lower limit where
+ applicable) of the validation. The value is a
number.
</para>
</listitem>
<listitem>
<para>
<literal>value2</literal>
- —The upper limit (where applicable) of the validation. The value is a number.
+ —The upper limit (where applicable) of
+ the validation. The value is a number.
</para>
</listitem>
<listitem>
<para>
<literal>condition</literal>
- —The validation condition. The value is a string.
+ —The validation condition. The value is a
+ string.
<itemizedlist>
<listitem>
- "equal" - requires the cell value to match the one defined in the value-attribute
+ "equal" - requires the cell value to
+ match the one defined in the
+ value-attribute
</listitem>
<listitem>
- "greater_equal" - requires the cell value to be greater than or equal to the
- value defined in the value-attribute
+ "greater_equal" - requires the cell value
+ to be greater than or equal to the value
+ defined in the value-attribute
</listitem>
<listitem>
- "less_equal" - requires the cell value to be less than or equal to the value
+ "less_equal" - requires the cell value to
+ be less than or equal to the value
defined in the value-attribute
</listitem>
<listitem>
- "less_than" - requires the cell value to be less than the value defined in the
+ "less_than" - requires the cell value to
+ be less than the value defined in the
value-attribute
</listitem>
<listitem>
- "not_equal" - requires the cell value to not match the one defined in the
+ "not_equal" - requires the cell value to
+ not match the one defined in the
value-attribute
</listitem>
<listitem>
- "between" - requires the cell value to be between the values defined in the
- value- and value2 attributes
+ "between" - requires the cell value to be
+ between the values defined in the value-
+ and value2 attributes
</listitem>
<listitem>
- "not_between" - requires the cell value not to be between the values defined in
+ "not_between" - requires the cell value
+ not to be between the values defined in
the value- and value2 attributes
</listitem>
</itemizedlist>
@@ -1348,18 +1556,22 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
-<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>
- ]]>
+ <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>
+ <para>
+ adds numeric validation to a cell specifying that the value must be
+ between 4 and 18.
+ </para>
<informaltable>
<tgroup cols="2">
<colspec colnum="1" colwidth="1*" />
@@ -1379,29 +1591,30 @@
<listitem>
<para>
<literal>startColumn</literal>
- —The starting column of the range of values to validate against. The value is a
+ —The starting column of the range of
+ values to validate against. The value is a
number.
</para>
</listitem>
<listitem>
<para>
<literal>startRow</literal>
- —The starting row of the range of values to validate against. The value is a
- number.
+ —The starting row of the range of values
+ to validate against. The value is a number.
</para>
</listitem>
<listitem>
<para>
<literal>endColumn</literal>
- —The ending column of the range of values to validate against. The value is a
- number.
+ —The ending column of the range of values
+ to validate against. The value is a number.
</para>
</listitem>
<listitem>
<para>
<literal>endRow</literal>
- —The ending row of the range of values to validate against. The value is a
- number.
+ —The ending row of the range of values to
+ validate against. The value is a number.
</para>
</listitem>
</itemizedlist>
@@ -1432,19 +1645,21 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
-<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>
- ]]>
+ <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>
- adds validation to a cell specifying that the value must be in the values specified in range A1:A10.
+ adds validation to a cell specifying that the value must be in the
+ values specified in range A1:A10.
</para>
<informaltable>
<tgroup cols="2">
@@ -1474,7 +1689,9 @@
<itemizedlist>
<listitem>
<para>
- <literal>Zero or more list validation items.</literal>
+ <literal>
+ Zero or more list validation items.
+ </literal>
</para>
</listitem>
</itemizedlist>
@@ -1493,7 +1710,10 @@
</tbody>
</tgroup>
</informaltable>
- <para>e:listValidation is a just a container for holding multiple e:listValidationItem tags.</para>
+ <para>
+ e:listValidation is a just a container for holding multiple
+ e:listValidationItem tags.
+ </para>
<informaltable>
<tgroup cols="2">
<colspec colnum="1" colwidth="1*" />
@@ -1544,50 +1764,77 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
-<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>
- ]]>
+ <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>
+ <para>
+ adds validation to a cell specifying that the value must be
+ "manager" or "employee".
+ </para>
</section>
<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 <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
+ 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
+ <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>
<section id="excel.formatmasks.numbers">
<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 <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/write/NumberFormats.html">jxl.write.NumberFormats</ulink>).
+ When encountering a format mask, first it is checked if it is in
+ internal form, e.g "format1", "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 (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.
+ 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>
<section id="excel.formatmasks.dates">
<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 <ulink url="http://jexcelapi.sourceforge.net/resources/javadocs/current/docs/jxl/write/DecimalFormats.html">jxl.write.DecimalFormats</ulink>).
+ When encountering a format mask, first it is checked if it is in
+ internal form, e.g "format1", "format2" 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 (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.
+ 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>
@@ -1595,43 +1842,53 @@
<section id="excel.formulas">
<title>Formulas</title>
<para>
- 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.
+ 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 <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.
+ The formula of the cell in placed in the <literal>value</literal>
+ -attribute as a normal &excel; 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: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>
- ]]>
+ <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>
+ <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 nested within columns (for iteration) or inside worksheets (for direct placement using the
- <literal>startColumn/startRow</literal> and <literal>endColumn/endRow</literal> attributes)</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*" />
@@ -1651,35 +1908,42 @@
<listitem>
<para>
<literal>startColumn</literal>
- —The starting column of the image. The default is the internal counter. The value is
- a number. Note that the value is 0-based.
+ —The starting column of the image. The
+ default is the internal counter. The value is 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. Note that the value is 0-based.
+ —The starting row of the image. The default
+ is the internal counter. The value is a 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. Note that the value is 0-based.
+ —The column span of the image. The default
+ is one resulting in the default width of 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. Note that the value is 0-based.
+ —The row span of the image. The default is
+ the one resulting in the default height of the
+ image. The value is a number. Note that the value
+ is 0-based.
</para>
</listitem>
<listitem>
<para>
<literal>URI</literal>
- —The URI to the image. The value is a string.
+ —The URI to the image. The value is a
+ string.
</para>
</listitem>
</itemizedlist>
@@ -1710,20 +1974,26 @@
</informaltable>
<programlisting role="XML">
<![CDATA[
-<e:workbook>
- <e:worksheet>
- <e:image startRow="0" startColumn="0" rowSpan="4" columnSpan="4" URI="http://foo.org/logo.jpg"/>
- </e:worksheet>
-</e:workbook>
- ]]>
+ <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>
</section>
<section id="excel.hyperlinks">
<title>Hyperlinks</title>
- <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>
+ <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*" />
@@ -1743,29 +2013,33 @@
<listitem>
<para>
<literal>startColumn</literal>
- —The starting column of the hyperlink. The default is the internal counter. The
- value is a number. Note that the value is 0-based.
+ —The starting column of the hyperlink. The
+ default is the internal counter. The 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. Note that the value is 0-based.
+ —The starting row of the hyperlink. The
+ default is the internal counter. The value 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. Note that the value is 0-based.
+ —The ending column of the hyperlink. The
+ default is the internal counter. The value 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. Note that the value is 0-based.
+ —The ending row of the hyperlink. The
+ default is the internal counter. The value is a
+ number. Note that the value is 0-based.
</para>
</listitem>
<listitem>
@@ -1777,7 +2051,8 @@
<listitem>
<para>
<literal>description</lite