From seam-commits at lists.jboss.org Tue Aug 5 04:27:57 2008 Content-Type: multipart/mixed; boundary="===============0096168237999349440==" MIME-Version: 1.0 From: seam-commits at lists.jboss.org To: seam-commits at lists.jboss.org Subject: [seam-commits] Seam SVN: r8573 - trunk/doc/Seam_Reference_Guide/en-US. Date: Tue, 05 Aug 2008 04:27:56 -0400 Message-ID: --===============0096168237999349440== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable 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 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- 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 @@ Seam also supports generation of Mic= rosoft Excel = - spreadsheets through the excellent JExcelAPI library. The generated = document is compatible with = + spreadsheets through the excellent JExcelAPI library. The generated= document is compatible with = Microsoft Excel spreadsheet applications = versions 95, 97, 2000, XP and 2003. Currently a limited subset of th= e 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. = @@ -24,7 +24,7 @@ jboss-seam-excel.jar in your WEB-INF/lib - directory along with the jxl.jar JAR file. Furthermore, you need = to configure the DocumentStore servlet in your + directory along with the jxl.jar JAR file. Fur= thermore, you need to configure the DocumentStore servlet in your web.xml @@ -45,7 +45,7 @@ org.jboss.seam.excel.<myModule> and set the UIWorkbook type to myModule - 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". = @@ -90,7 +90,7 @@
Workbooks - Workbooks are the top-level containers of worksheets, cell tem= plates and worksheet templates + Workbooks are the top-level parents of worksheets, cell templa= tes and worksheet templates. @@ -240,7 +240,7 @@ temporaryFileDuringWriteDirectory - —Used in conjunction with the useTempo= raryFileDuringWrite setting to set the target + —Used in conjunction with the useTemporaryFileDuringWrite setting to set the target directory for the temporary files. This valu= e 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 @@ <e:cellTemplate/> - —A cell template. See link for more in= formation. + —Zero or more cell templates (see ). <e:worksheetTemplate/> - —A worksheet template. See link for mo= re information. + —Zero or more worksheet templates (see= ). <e:worksheet/> - —A worksheet. See link for more inform= ation. + —Zero or more worksheets (see ). @@ -301,11 +301,11 @@ - - - - + + + + + ]]> defines a workbook with a worksheet and a greeting at A1 @@ -313,7 +313,11 @@
Worksheets - Worksheets are the children of workbooks and the parent of col= umns + + Worksheets are the children of workbooks and the parent of column= s and worksheet commands + They can also contain explicitly placed cells, formulas, images a= nd hyperlinks. They are the = + pages that make up the workbook. + @@ -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 si= ngle worksheet, just define the same name for - them (using startRow and startCol to make su= re that they don't occupy the same space). + them (using startRow and = startCol to make sure that they don't occupy the same sp= ace). @@ -368,8 +372,8 @@ templates - —The comma-separated list of worksheet= Templates to cascade on. The value is a - string. See link for more information on cas= cading worksheet settings + —The comma-separated list of = worksheetTemplates to cascade on. The value is a + string (see ). @@ -507,8 +511,7 @@ paperSize —The paper size to be used when printi= ng 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 jxl.format.PaperSize). @@ -613,21 +616,26 @@ <e:printArea/> - —Zero or more print area definitions. = See link. + —Zero or more print area definitions (= see ). <e:printTitle/> - —Zero or more print title definitions.= See link. + —Zero or more print title definitions = (see ). <e:headerFooter/> - —Zero or more header/footer definition= s. See link. + —Zero or more header/footer definition= s ((see )). + + + Zero or more worksheet commands (see ). + + Facets @@ -646,24 +654,26 @@ - - - - - - - - - + + + + + + + + + + ]]> defines a worksheet with the name "foo", starting at B2. - See also link e:worksheetTemplate
Columns - Columns are the children of worksheets and the parents of cell= s + + 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 workshee= t data. + @@ -706,25 +716,25 @@ <e:cell/> - —A cell that contains bindings to the = actual value. See link for more information. + —Zero or more cells (see ). <e:formula/> - —A formula. See link for more informat= ion. + —Zero or more formulas (see ). <e:image/> - —An image. See link for more informati= on. + —Zero or more images (see ). <e:hyperLink/> - —A hyperlink. See link for more inform= ation. + —Zero or more hyperlinks (see ). @@ -754,16 +764,16 @@ - - - - - - - - - + + + + + + + + + + ]]> defines a column with a header and an iterated output @@ -772,9 +782,9 @@
Cells - Cells are nested within columns (for iteration) or inside workshe= ets (for direct placement using the column and - row attributes) and are responsible for outputting the value (usu= ally 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 workshe= ets (for direct placement using the column and + row attributes) and are responsible for output= ting the value (usually though en EL-expression involving the + var-attribute of the datatable. They can conta= ins fonts and other formattings and can also use pre-defined templates. @@ -797,14 +807,14 @@ column —The column where to place the cell. T= he default is the internal counter. The value - is a number. + is a number. Note that the value is 0-based. row —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. @@ -818,7 +828,7 @@ templates —A comma-separated list of cascading, = predefined templates to apply before the own - formattings. + formattings (see ). @@ -870,7 +880,7 @@ mask - —See link for information on format ma= sks. + —A format mask (see ). @@ -909,24 +919,24 @@ <e:font/> - —Zero or more font definitions. See li= nk. + —Zero or more font definitions (see ). <e:border/> - —Zero or more border definitions. See = link. + —Zero or more border definitions (see = ). <e:background/> - —Zero or more background definitions. = See link. + —Zero or more background definitions (= see ). - Zero or more validation conditions.= See link for more information + Zero or more validation conditions (see ). = @@ -948,20 +958,23 @@ - - - - - + + = + + + + + + + + = ]]> defines a column with a header and an iterated output - See also e:cellTemplate -
+
Fonts - Fonts are nested inside e:cell, e:formula and e:cellTemplate t= ags and are defined through the e:font tag. + Fonts are nested inside cells, formulas, hyperlinks or cell te= mplates. They determine the typeface of the cell data @@ -991,7 +1004,7 @@ color —The color of the background. The v= alue 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 - - + + + = + + + + + + = ]]> defines a cell with a red, bold, Times New Roman font.
-
+
Backgrounds - Backgrounds are nested inside e:cell, e:formula and e:cellTemp= late tags and are defined through the - e:background tag. + Backgrounds are nested inside cells, formulas, hyperlinks or c= ell templates. They determine + the color and pattern of the cell. @@ -1093,7 +1112,7 @@ pattern —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 jxl.format.Pattern). The default is "solid". @@ -1101,7 +1120,7 @@ color —The color of the background. The v= alue 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 = @@ -1132,17 +1151,24 @@ - - + + + = + + + + + + = ]]> defined a green cell background with a 25% grey mask.
-
+
Borders - 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. @@ -1171,14 +1197,14 @@ lineStyle —The border line style. The value i= s a string that can be one of "medium", "thin" - etc. See the JExcelAPI Javadoc for jxl.fo= rmat.BorderLineStyle for the full list. + etc (see jxl.format.BorderLineStyle). color —The color of the border. The value= is a string that can be one of "blue", "red" - etc. See the JExcelAPI Javadoc for jxl.fo= rmat.Colour for the full list. + etc (see jxl.= format.Colour). @@ -1209,18 +1235,24 @@ - - + + + = + + + + + + ]]> defined a thin green border on the left edge of the cell.
-
+
Validation - Validations are nested inside e:cell, e:formula and e:cellTemp= late tags and are defined trough - e:numericValidation, e:rangeValidation and e:listValidation / = e:listValidationItem tags. + Validations are nested inside cells, formulas or cell template= s. = + They add constrains for the cell data. @@ -1314,9 +1346,15 @@ - - + + + = + + + + + + = ]]> adds numeric validation to a cell specifying that the value= must be between 4 and 18. @@ -1392,9 +1430,15 @@ - - + + + = + + + + + + = ]]> @@ -1428,7 +1472,7 @@ - Zero or more list validation ite= ms. See link for more information. + Zero or more list validation ite= ms. @@ -1498,22 +1542,28 @@ - - - - - + + + = + + + + + + + + + = ]]> adds validation to a cell specifying that the value must be= "manager" or "employee".
-
+
Format masks Format masks are defined in the mask attribute in cell templat= es, cells or formulas. Note that when using templates, the format mask must= be placed in the first template - to be cascaded since the constructor hierarchy in JExcelAPI us= ed for copying cell formats makes it hard to + to be cascaded since the constructor hierarchy in JEx= celAPI used for copying cell formats makes it hard to change the format mask at a later stage. There are two types o= f format masks, one for numbers and one for dates @@ -1521,11 +1571,10 @@ Number masks 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 jxl.write.NumberFormats). - if the mask is not in the list, it is treated as a custom m= ask as described in java.text.DecimalFormat, + if the mask is not in the list, it is treated as a custom m= ask (see java.text.DecimalFormat). e.g "0.00" and automatically converted to the closest match.
@@ -1533,11 +1582,10 @@ Date masks 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.DateForm= ats for the complete list. + and so on (see jxl.write= .DecimalFormats). - if the mask is not in the list, it is treated as a custom m= ask as described in - java.text.SimpleDateFormat, e.g "dd.MM.yyyy" and automatica= lly converted to the closest match. + if the mask is not in the list, it is treated as a custom m= ask (see java.text.DateFormat)., e.g "dd.MM.yyyy" and automatic= ally converted to the closest match.
@@ -1545,30 +1593,43 @@
Formulas - 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 a= pply templates and have own font definitions + Formulas are nested within columns (for iteration) or inside work= sheets (for direct placement using the column and + row attributes) and add calculations or functi= ons to ranges of cells. They are essentially cells, see = + for available attributes. Note that they can apply templates and = have own font definitions etc just as normal cells. - The formula of the cell in placed in the value-attribute as a nor= mal Microsoft = + The formula of the cell in placed in the value= -attribute as a normal Microsoft = Excel spreadsheet app= lication notation. Note that when doing cross-sheet formulas, the worksheets must exist before referencin= g a formula against them. The value is a string. - - - + + + + + + + + + + + + + + = ]]> defines an formula in B2 summing cells A1 in worksheets FooShe= et and BarSheet -
Images - Images are defined with the e:image tag. + Images are nested within columns (for iteration) or inside wor= ksheets (for direct placement using the = + startColumn/startRow and endColumn/endRo= w attributes) @@ -1589,28 +1650,28 @@ startColumn —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. startRow —The starting row of the image. The de= fault is the internal counter. The value is a - number. + number. Note that the value is 0-based. columnSpan —The column span of the image. The def= ault 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. rowSpan —The row span of the image. The defaul= t 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 th= at the value is 0-based. @@ -1647,7 +1708,11 @@ + + + + + = ]]> defines an image in A1:E5 based on the given data @@ -1655,7 +1720,8 @@
Hyperlinks - Hyperlinks are defined with the e:hyperlink tag. + Hyperlinks are nested within columns (for iteration) or inside= worksheets (for direct placement using the = + startColumn/startRow and endColumn/endRo= w attributes). They add link navigation to URIs @@ -1676,28 +1742,28 @@ startColumn —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. startRow —The starting row of the hyperlink. Th= e default is the internal counter. The value - is a number. + is a number. Note that the value is 0-based. endColumn —The ending column of the hyperlink. T= he default is the internal counter. The value - is a number. + is a number. Note that the value is 0-based. endRow —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. @@ -1740,7 +1806,12 @@ + + + + + = ]]> defines a described hyperlink pointing to SFWK in the area A1:= E5 @@ -1748,8 +1819,8 @@
Headers and footers - Headers and footers are defined with e:headerFooter, e:headerFoot= erCommands and e:headerFooterCommand tags - nested within a e:worksheet or e:worksheetTemplate. + Headers and footers are childrens of worksheets and worksheet tem= plates and parents of header and footer commands + They add headers and footers to printed worksheets. = @@ -1814,7 +1885,7 @@ - The e:headerFooterCommands is just a nesting container in order t= o support multiple e:headerFooterCommand tags. + The <e:headerFooterCommands> is just a n= esting container in order to support multiple header/footer commands. @@ -1844,7 +1915,7 @@ - Zero or more header/footer commands= . See link for more information. + Zero or more header/footer commands. @@ -1863,7 +1934,8 @@ - The acutal command that places something a header/footer facet= is defined with e:headerFooterCommand + Header/footer commands adds actual commands to the header or f= ooter in the location where the = + containing facet points. @@ -1952,13 +2024,17 @@ - - - - - - + + = + + + + + + + + + ]]> Defines a header with the page number in the left corner. @@ -1966,8 +2042,7 @@
Print areas and titles - Print areas and titles are defined with e:printArea and e:printTi= tle tags nested within a e:worksheet or - e:worksheetTemplate. + Print areas and titles childrens of worksheets and worksheet temp= lates and provide... print areas and titles. = @@ -1988,25 +2063,25 @@ firstColumn - —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. firstRow - —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. lastColumn - —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. lastRow - —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. @@ -2037,18 +2112,23 @@ - + + = + + + + ]]> defines a print title between A1:A10 and a print area between = B2:J10.
Worksheet Commands + Worksheet commands are children of workbooks and are usually e= xecuted only once.
Grouping - Grouping of rows and columns are done on worksheet level with = the e:groupRows and e:groupColumns tags + Provides grouping of columns and rows. @@ -2069,13 +2149,13 @@ startRow - —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. endRow - —The row to end the grouping at. Th= e value is a number. + —The row to end the grouping at. Th= e value is a number. Note that the value is 0-based. @@ -2129,13 +2209,13 @@ startColumn - —The column to start the grouping a= t. The value is a number. + —The column to start the grouping a= t. The value is a number. Note that the value is 0-based. endColumn - —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. @@ -2173,8 +2253,12 @@ = - + + = + + + + ]]> @@ -2185,7 +2269,7 @@
Page breaks - Page breaks are defined at worksheet level with the e:rowPa= geBreak tag + Provides page breaks @@ -2205,7 +2289,7 @@ row - —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. @@ -2236,14 +2320,18 @@ + + = + + + = ]]> breaks page at row 5.
Merging - Merging is done on worksheet level with the e:mergeCells ta= g + Provides cell merging @@ -2263,25 +2351,25 @@ startRow - —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. startColumn - —The column to start the merging fr= om. The value is a number. + —The column to start the merging fr= om. The value is a number. Note that the value is 0-based. endRow - —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. endColumn - —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. @@ -2312,10 +2400,14 @@ + + + + + = ]]> - merges the cells in the range (5,5) to (10,10). + merges the cells in the range A1:J10
@@ -2330,39 +2422,53 @@ Cell templates are defined on workbook level using the foll= owing notation + + + + + = ]]> and are later used by referencing them in the templates att= ribute of a cell + + = + + + = ]]> - Cell templates have the same attributes as cells so refer to t= he link to see the available attributes. Note + Cell templates have the same attributes as cells (see ). Note that the cellTemplate can also contain tags for font, border a= nd background definitions and they are merged with the definitions of the cell using the templates so a more= complex definition could look like - - - = + + + + + = = - - - - = + + + + + = ]]> so that a cell that later on applies the templates - - + + = + + + + + = ]]> @@ -2378,20 +2484,24 @@ + + = + + + = ]]> and when you later use it like - ... - + = + + = ]]> 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 documenta= tion for available attributes. + essentially a named worksheet (see ). =
@@ -2441,8 +2551,7 @@ id=3D"theDataTable" = value=3D"#{personList.personList}" = var=3D"person" - style=3D"xlsFontName : Times New Roman; xlsBackgroundColor : red" - > + style=3D"xlsFontName : Times New Roman; xlsBackgroundColor : red"> ... @@ -2482,7 +2591,7 @@ xlsFontColor - The color of the font. See link for valid co= lors + The color of the font (see jxl.format.Colour). @@ -2506,7 +2615,7 @@ xlsFontScriptStyle - The script style of the font. See link for v= alid script styles + The script style of the font (see jxl.format.ScriptStyle). @@ -2522,7 +2631,7 @@ xlsFontUnderlineStyle - The underline style of the font. See link fo= r valid underline styles + The underline style of the font (see jxl.format.UnderlineStyle). @@ -2530,7 +2639,7 @@ xlsBackgroundColor - The background color of the cell. See link f= or valid colors + The background color of the cell (see jxl.format.Colour). @@ -2538,7 +2647,7 @@ xlsBackgroundPattern - The background pattern of the cell. See link= for valid patterns + The background pattern of the cell (see jxl.format.Pattern). @@ -2546,7 +2655,7 @@ xlsAlignment - The alignment of the cell value. See link fo= r valid alignments + The alignment of the cell value (see jxl.format.Alignment). @@ -2581,7 +2690,7 @@ xlsBorderColor - The the border color of the entire cell. See= link for valid colors + The the border color of the entire cell (see= jxl.format.Colour). @@ -2589,7 +2698,7 @@ xlsBorderColorLeft - The the border color of the left edge of the= cell. See link for valid colors + The the border color of the left edge of the= cell (see jxl.format.Colour). @@ -2597,7 +2706,7 @@ xlsBorderColorTop - The the border color of the top edge of the = cell. See link for valid colors + The the border color of the top edge of the = cell (see jxl.format.Colour). @@ -2605,7 +2714,7 @@ xlsBorderColorRight - The the border color of the right edge of th= e cell. See link for valid colors + The the border color of the right edge of th= e cell (see jxl.format.Colour). @@ -2613,7 +2722,7 @@ xlsBorderColorBottom - The the border color of the bottom edge of t= he cell. See link for valid colors + The the border color of the bottom edge of t= he cell (see jxl.format.Colour). @@ -2621,7 +2730,7 @@ xlsBorderLineStyle - The the border line style of the entire cell= . See link for valid border line styles + The the border line style of the entire cell= (see jxl.format.Colour). @@ -2630,7 +2739,7 @@ - The the border line style of the left edge of t= he cell. See link for valid border line styles + The the border line style of the left edge of t= he cell (see jxl.format.Colour). @@ -2640,7 +2749,7 @@ - The the border line style of the top edge of th= e cell. See link for valid border line styles + The the border line style of the top edge of th= e cell (see jxl.format.Colour). @@ -2650,7 +2759,7 @@ - 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 jxl.format.Colour). styles @@ -2661,7 +2770,7 @@ - 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 jxl.format.Colour). styles --===============0096168237999349440==--