From seam-commits at lists.jboss.org Fri Aug 8 05:21:39 2008 Content-Type: multipart/mixed; boundary="===============1878072615206047767==" MIME-Version: 1.0 From: seam-commits at lists.jboss.org To: seam-commits at lists.jboss.org Subject: [seam-commits] Seam SVN: r8632 - trunk/doc/Seam_Reference_Guide/en-US. Date: Fri, 08 Aug 2008 05:21:35 -0400 Message-ID: --===============1878072615206047767== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable 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 =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-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 @@ - + Microsoft = Excel spreadsheet application'> Microsoft = Excel spreadsheet application'> ]> = - - - + &Excel; - Seam also supports generation of = - &excel; - spreadsheets through the excellent = - JExcelAPI l= ibrary. = - The generated document is compatible with &excel; = - 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 refer to the JExcelAPI = - documentation for more information on capabilities and limitations. + Seam also supports generation of &excel; spreadsheets through the = + excellent JExcelAPI + 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. =
&Excel; support - &Excel; jboss-seam-excel.jar. This JAR contain= s 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 jboss-seam-excel.jar in = your - WEB-INF/lib directory along with the = - jxl.jar JAR file. Furthermore, you need to con= figure - the DocumentStore servlet in your web.xml + &Excel; jboss-seam-excel.jar. This JAR contain= s = + the &excel; JSF controls, which are used to construct views that = can = + render the document, and the DocumentStore component, which serve= s = + the rendered document to the user. To include &excel; support in = + your application, included 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 web.xml - &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 pack= age. - The examples/excel project contains an example= of = - &excel; support in action. It demonstrates proper deployment pack= aging, - and it shows the exposed functionality. + The examples/excel project contains an example= of + &excel; support in action. It demonstrates proper deployment = + packaging, and it shows the exposed functionality. - Customizing the module to support other kinds of &excel; spreadsh= eet = - API's has been made very easy. Implement the = - ExcelWorkbook interface, set the component nam= e to - org.jboss.seam.excel.<myModule> and set = the = - UIWorkbook type to myModule and your own expor= ter = - will be used. Default is "jxl", but support for CSV has also been = + Customizing the module to support other kinds of &excel; spreadsh= eet + API's has been made very easy. Implement the ExcelWorkbo= ok + interface, set the component name to = + org.jboss.seam.excel.<myModule> and set = the = + UIWorkbook type to myModule and your own expor= ter + will be used. Default is "jxl", but support for CSV has also been = added, using the type "csv". = @@ -55,44 +52,55 @@
Creating a simple workbook - Basic usage of the worksheet support is simple; it is used like a= familiar - <h:dataTable> - and you can bind to a List, Set, - Map, Array or = + Basic usage of the worksheet support is simple; it is used like a + familiar <h:dataTable> and you can bind = to a + List, Set, = + Map, Array or DataModel. - - - - + + + + + ]]> - That's not terribly useful, so lets have a look at a more comm= on case: + + That's not terribly useful, so lets have a look at a more common = case: + - - - - - -]]> + + + + + + + + ]]> - 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=3D"#{d= ata}" is the EL-binding to the data and - var=3D"item" is the name of the current item. Nested in= side the worksheet is a single column and within - it you see the cell which is the final bind to the data within th= e 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=3D"#{data}" is the + EL-binding to the data and var=3D"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 - This is all you know to get started dumping your data to works= heets! + + This is all you know to get started dumping your data to workshee= ts! + =
Workbooks - Workbooks are the top-level parents of worksheets, cell templa= tes and worksheet templates. + + Workbooks are the top-level parents of worksheets, cell templates= and + worksheet templates. + @@ -112,154 +120,189 @@ type - —Defines which export module to be use= d. The value is a string and can be either - "jxl" or "csv". The default is "jxl". + —Defines which export module to be use= d. The + value is a string and can be either "jxl" or + "csv". The default is "jxl". templateURI - —A template that should be used as a b= asis for the workbook. The value is a string - (URI). + —A template that should be used as a b= asis + for the workbook. The value is a string (URI= ). arrayGrowSize - —The amount of memory by which to incr= ease the amount of memory allocated to storing - the workbook data. For processeses reading m= any 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 incr= ease + 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). autoFilterDisabled - —Should autofiltering be disabled?. Th= e value is a boolean. + —Should autofiltering be disabled?. The + value is a boolean. cellValidationDisabled - —Shoule cell validation be ignored? Th= e value is a boolean. + —Shoule cell validation be ignored? The + value is a boolean. characterSet - —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 w= hen + the spreadsheet is written. The value is a s= tring + (character set encoding). drawingsDisabled - —Should drawings be disabled? The valu= e is a boolean. + —Should drawings be disabled? The valu= e is a + boolean. excelDisplayLanguage - —The language in which the generated f= ile will display. The value is a string (two - character ISO 3166 country code). + —The language in which the generated f= ile + will display. The value is a string (two cha= racter + ISO 3166 country code). excelRegionalSettings - —The regional settings for the generat= ed excel file. The value is a string (two - character ISO 3166 country code). + —The regional settings for the generat= ed + excel file. The value is a string (two chara= cter + ISO 3166 country code). formulaAdjust - —Should formulas be adjusted? The valu= e is a boolean. + —Should formulas be adjusted? The valu= e is a + boolean. gcDisabled - —Should garbage collection be disabled= ? The value is a boolean. + —Should garbage collection be disabled= ? The + value is a boolean. ignoreBlanks - —Should blanks be ignored? The value i= s a boolean. + —Should blanks be ignored? The value i= s a + boolean. initialFileSize - —The initial amount of memory allocate= d to store the workbook data when reading a - worksheet. For processeses reading many smal= l 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 allocate= d to + store the workbook data when reading a works= heet. + For processeses reading many small workbooks + inside a WAS it might be necessary to reduce= the + default size Default value is 5 megabytes. T= he + value is a number (bytes). locale - —The locale used by JExcelApi to gener= ate the spreadsheet. Setting this value has no - effect on the language or region of the gene= rated excel file. The value is a string. + —The locale used by JExcelApi to gener= ate + the spreadsheet. Setting this value has no e= ffect + on the language or region of the generated e= xcel + file. The value is a string. mergedCellCheckingDisabled - —Should merged cell checking be disabl= ed? The value is a boolean. + —Should merged cell checking be disabl= ed? + The value is a boolean. namesDisabled - —Should handling of names be disabled?= The value is a boolean. + —Should handling of names be disabled?= The + value is a boolean. propertySets - —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 workb= ook? + Leaving this feature enabled will result in = the + JXL process using more memory. The value is a + boolean. rationalization - —Should the cell formats be rationaliz= ed before writing out the sheet? The value is - a boolean. Default is true. + —Should the cell formats be rationaliz= ed + before writing out the sheet? The value is a + boolean. Default is true. supressWarnings - —Should warnings be suppressed?. Due t= o the change in logging in version 2.4, this - will now set the warning behaviour across th= e JVM (depending on the type of logger used). - The value is a boolean. + —Should warnings be suppressed?. Due t= o 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. - temporaryFileDuringWriteDirectory - —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). + + temporaryFileDuringWriteDirectory + + —Used in conjunction with the + useTemporaryFileDuringWrite + setting to set the target directory for the + temporary files. This value can be NULL, in = which + case the normal system default temporary dir= ectory + is used instead. The value is a string (the + directory to which temporary files should be + written). useTemporaryFileDuringWrite - —Should a temporary file is used durin= g the generation of the workbook. If not set, - the workbook will take place entirely in mem= ory. Setting this flag involves an assessment - of the trade-offs between memory usage and p= erformance. The value is a boolean. + —Should a temporary file is used durin= g 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 performa= nce. + The value is a boolean. workbookProtected - —Should the workbook be protected? The= value is a boolean. + —Should the workbook be protected? The= value + is a boolean. @@ -270,19 +313,25 @@ <e:cellTemplate/> - —Zero or more cell templates (see ). + —Zero or more cell templates (see + + ). <e:worksheetTemplate/> - —Zero or more worksheet templates (see= ). + —Zero or more worksheet templates (see + + ). <e:worksheet/> - —Zero or more worksheets (see ). + —Zero or more worksheets (see + + ). @@ -303,11 +352,11 @@ - - - - + + + + + ]]> defines a workbook with a worksheet and a greeting at A1 @@ -316,9 +365,10 @@
Worksheets - 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. + Worksheets are the children of workbooks and the parent of column= s and + worksheet commands They can also contain explicitly placed cells, + formulas, images and hyperlinks. They are the pages that make up = the + workbook. @@ -336,252 +386,303 @@ value - —An EL-expression to the backing data.= The value is a string. + —An EL-expression to the backing data.= The + value is a string. var - —The current row iterator variable nam= e that can later be referenced in cell value - attributes. The value is a string + —The current row iterator variable nam= e that + can later be referenced in cell value attrib= utes. + The value is a string name - —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 sure that they don't occupy the same sp= ace). + —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). startRow - —Defines the starting row for the data= . The value is a number. Used for placing the - data in other places than the upper-left cor= ner (especially useful if having multiple data - sets for a single worksheet). The defaults i= s 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 s= ets + for a single worksheet). The defaults is 0. startColumn - —Defines the starting column for the d= ata. 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 defau= lt is 0. + —Defines the starting column for the d= ata. + The value is a number. Used for placing the = data + in other places than the upper-left corner + (especially useful if having multiple data s= ets + for a single worksheet). The default is 0. templates - —The comma-separated list of = worksheetTemplates to cascade on. The value is a - string (see ). + —The comma-separated list of + worksheetTemplates + to cascade on. The value is a string (see + + ). automaticFormulaCalculation - —Should formulas be automatically calc= ulated? The value is a boolean. + —Should formulas be automatically + calculated? The value is a boolean. bottomMargin - —The bottom margin. The value is a num= ber (inches) + —The bottom margin. The value is a num= ber + (inches) copies - —The number of copies. The value is a = number. + —The number of copies. The value is a + number. defaultColumnWidth - —The default column width. The value i= s a number (characters * 256). + —The default column width. The value i= s a + number (characters * 256). defaultRowHeight - —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). displayZeroValues - —Should zero-values be displayed? The = value is a boolean. + —Should zero-values be displayed? The = value + is a boolean. fitHeight - —The number of pages vertically that t= his sheet will be printed into. The value is a - number. + —The number of pages vertically that t= his + sheet will be printed into. The value is a n= umber. fitToPages - —Should printing be fit to pages? The = value is a boolean. + —Should printing be fit to pages? The = value + is a boolean. fitWidth - —The number of pages widthwise which t= his sheet should be printed into. The value is - a number. + —The number of pages widthwise which t= his + sheet should be printed into. The value is a + number. footerMargin - —The margin for any page footer. The v= alue is a number (inches). + —The margin for any page footer. The v= alue + is a number (inches). headerMargin - —The margin for any page headers. The = value is a number (inches). + —The margin for any page headers. The = value + is a number (inches). hidden - —Should the worksheet be hidden? The v= alue is a boolean. + —Should the worksheet be hidden? The v= alue + is a boolean. horizontalCentre - —Should the worksheet be centered hori= zontally? The value is a boolean. + —Should the worksheet be centered + horizontally? The value is a boolean. horizontalFreeze - —The row at which the pane is frozen v= ertically. The value is a number. + —The row at which the pane is frozen + vertically. The value is a number. horizontalPrintResolution - —The horizontal print resolution. The = value is a number. + —The horizontal print resolution. The = value + is a number. leftMargin - —The left margin. The value is a numbe= r (inches). + —The left margin. The value is a number + (inches). normalMagnification - —The normal magnificaton factor (not z= oom or scale factor). The value is a number - (percentage). + —The normal magnificaton factor (not z= oom or + scale factor). The value is a number (percen= tage). orientation - —The paper orientation for printing th= is sheet. The value is a string that can be - either "landscape" or "portrait". + —The paper orientation for printing th= is + sheet. The value is a string that can be eit= her + "landscape" or "portrait". pageBreakPreviewMagnification - —The page break preview magnificaton f= actor (not zoom or scale factors). the value - is a number (percentage). + —The page break preview magnificaton f= actor + (not zoom or scale factors). the value is a = number + (percentage). pageBreakPreviewMode - —Show page in preview mode? The value = is a boolean. + —Show page in preview mode? The value = is a + boolean. pageStart - —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. 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 jxl.format.PaperSize). + —The paper size to be used when printi= ng + this sheet. The value is a string that can b= e one + of "a4", "a3", "letter", "legal" etc (see + + jxl.format.PaperSize + + ). password - —The password for this sheet. The valu= e is a string. + —The password for this sheet. The valu= e is a + string. passwordHash - —The password hash - used only when co= pying sheets. The value is a string. + —The password hash - used only when co= pying + sheets. The value is a string. printGridLines - —Should grid lines be printed? The val= ue is a boolean. + —Should grid lines be printed? The val= ue is + a boolean. printHeaders - —Should headers be printed? The value = is a boolean. + —Should headers be printed? The value = is a + boolean. sheetProtected - —Should the sheet be protected (read-o= nly)? The value is a boolean. + —Should the sheet be protected (read-o= nly)? + The value is a boolean. recalculateFormulasBeforeSave - —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 rightMargin - —The right margin. The value is a numb= er (inches). + —The right margin. The value is a numb= er + (inches). scaleFactor - —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 (percen= t). selected - —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. showGridLines - —Should gridlines be shown? The value = is a boolean. + —Should gridlines be shown? The value = is a + boolean. topMargin - —The top margin. The value is a number= (inches). + —The top margin. The value is a number + (inches). @@ -593,21 +694,24 @@ verticalFreeze - —The row at which the pane is frozen v= ertically. The value is a number. + —The row at which the pane is frozen + vertically. The value is a number. verticalPrintResolution - —The vertical print resolution. The va= lue is a number. + —The vertical print resolution. The va= lue is + a number. zoomFactor - —T zoom factor. Do not confuse zoom fa= ctor (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 fa= ctor + (which relates to the on screen view) with s= cale + factor (which refers to the scale factor when + printing). The value is a number (percentage. @@ -618,24 +722,33 @@ <e:printArea/> - —Zero or more print area definitions (= see ). + —Zero or more print area definitions (= see + + ). <e:printTitle/> - —Zero or more print title definitions = (see ). + —Zero or more print title definitions = (see + + ). <e:headerFooter/> - —Zero or more header/footer definition= s ((see )). + —Zero or more header/footer definitions + ((see + + )). - Zero or more worksheet commands (see ). + Zero or more worksheet commands (see + + ). @@ -656,16 +769,16 @@ - - - - - - - - - + + + + + + + + + + ]]> defines a worksheet with the name "foo", starting at B2. @@ -673,8 +786,9 @@
Columns - 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. + Columns are the children of worksheets and the parents of cells, + images, formulas and hyperlinks. They are the structure that cont= rol + the iteration of the worksheet data. @@ -695,19 +809,22 @@ autoSize - —Should the column be autosized? The v= alue is a boolean. + —Should the column be autosized? The v= alue + is a boolean. hidden - —Should the column be hidden? The valu= e is a boolean. + —Should the column be hidden? The valu= e is a + boolean. width - —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) @@ -718,25 +835,33 @@ <e:cell/> - —Zero or more cells (see ). + —Zero or more cells (see + + ). <e:formula/> - —Zero or more formulas (see ). + —Zero or more formulas (see + + ). <e:image/> - —Zero or more images (see ). + —Zero or more images (see + + ). <e:hyperLink/> - —Zero or more hyperlinks (see ). + —Zero or more hyperlinks (see + + ). @@ -766,16 +891,16 @@ - - - - - - - - - + + + + + + + + + + ]]> defines a column with a header and an iterated output @@ -784,10 +909,12 @@
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 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. + 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= in = + fonts and other formattings and can also use pre-defined template= s. @@ -808,108 +935,130 @@ column - —The column where to place the cell. T= he default is the internal counter. The value - is a number. Note that the value is 0-based. + —The column where to place the cell. T= he + default is the internal counter. The value i= s 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 + —The row where to place the cell. The + default is the internal counter. The value is number. Note that the value is 0-based. value - —The value to display. Usually an EL-e= xpression 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. templates - —A comma-separated list of cascading, = predefined templates to apply before the own - formattings (see ). + —A comma-separated list of cascading, + predefined templates to apply before the own + formattings (see + + ). forceType - —The forced type of the cell data. The= value is a string that can be one of - "general", "number", "text", "date", "formul= a" 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 r= arely + any use for this attribute. alignment - —The alignment of the cell data. The v= alue is a string that can be one of "centre", - "fill", "general", "justify", "left" or "rig= ht". + —The alignment of the cell data. The v= alue + is a string that can be one of "centre", "fi= ll", + "general", "justify", "left" or "right". comment - —A comment to add to the cell. The val= ue is a string. + —A comment to add to the cell. The val= ue is + a string. commentHeight - —The height of the comment. The value = is a number (in pixels). + —The height of the comment. The value = is a + number (in pixels). commentWidth - —A width of the comment. The value is = a number (in pixels). + —A width of the comment. The value is a + number (in pixels). indentation - —The indentation of the cell. The valu= e is a number (in pixels) + —The indentation of the cell. The valu= e is a + number (in pixels) locked - —Should the cell be locked? For this t= o have any effect, the sheet containing cells - with this format must also be locked. The va= lue is a boolean. + —Should the cell be locked? For this t= o have + any effect, the sheet containing cells with = this + format must also be locked. The value is a + boolean. mask - —A format mask (see ). + —A format mask (see + + ). orientation - —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". shrinkToFit - —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. verticalAlignment - —The vertical aligment of the cell dat= a. The value is a string that can be one of - "bottom", "centre", "justify" or "top"). + —The vertical aligment of the cell dat= a. The + value is a string that can be one of "bottom= ", + "centre", "justify" or "top"). wrap - —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. @@ -921,24 +1070,32 @@ <e:font/> - —Zero or more font definitions (see ). + —Zero or more font definitions (see + + ). <e:border/> - —Zero or more border definitions (see = ). + —Zero or more border definitions (see + + ). <e:background/> - —Zero or more background definitions (= see ). + —Zero or more background definitions (= see + + ). - Zero or more validation conditions (see ). + Zero or more validation conditions (see + + ). = @@ -960,23 +1117,24 @@ - = - - - - - - - - = + + = + + + + + + + + = ]]> defines a column with a header and an iterated output
Fonts - Fonts are nested inside cells, formulas, hyperlinks or cell te= mplates. 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 @@ -997,54 +1155,72 @@ fontName - —The font name. The value is a stri= ng. Should be used with care, since the used - font must be recognized by the Microsoft = - Excel spreadsheet application + —The font name. The value is a stri= ng. + Should be used with care, since the used = font + must be recognized by the + + Microsoft + + Excel + spreadsheet application color - —The color of the background. The v= alue is a string that can be one of "blue", - "red" etc (see + jxl.format.Colour + + ). pointSize - —The point size of the font. The va= lue is a number. + —The point size of the font. The va= lue is + a number. bold - —Should the font be bold? The value= is a boolean. + —Should the font be bold? The value= is a + boolean. italic - —Should the font be italic? The val= ue is a boolean. + —Should the font be italic? The val= ue is + a boolean. struckOut - —Should the font be struck out? The= value is a boolean. + —Should the font be struck out? The= value + is a boolean. scriptStyle - —The script style of the font. The = value is a string that can be one of - "normal_script", "subscript" or "superscr= ipt". + —The script style of the font. The = value + is a string that can be one of "normal_sc= ript", + "subscript" or "superscript". underlineStyle - —The underline style of the font. T= he value is a string that can be one of - "double", "double_accounting", "no_underl= ine", "single" or "single_accounting". + —The underline style of the font. T= he + value is a string that can be one of "dou= ble", + "double_accounting", "no_underline", "sin= gle" + or "single_accounting". @@ -1075,15 +1251,15 @@ - - = - - - - - - = + + + = = + + + + + + = ]]> defines a cell with a red, bold, Times New Roman font. @@ -1091,8 +1267,8 @@
Backgrounds - Backgrounds are nested inside cells, formulas, hyperlinks or c= ell templates. They determine - the color and pattern of the cell. + Backgrounds are nested inside cells, formulas, hyperlinks or c= ell + templates. They determine the color and pattern of the cell. @@ -1113,16 +1289,22 @@ pattern - —The pattern of the background. The= value is a string that can be one of "solid", - "grey_25" etc (see jxl.format.Pattern). The - default is "solid". + —The pattern of the background. The= value + is a string that can be one of "solid", + "grey_25" etc (see + + jxl.format.Pattern + + ). The default is "solid". color - —The color of the background. The v= alue is a string that can be one of "blue", - "red" etc = + —The color of the background. The v= alue + is a string that can be one of "blue", "r= ed" + etc @@ -1153,15 +1335,15 @@ - - = - - - - - - = + + + = = + + + + + + = ]]> defined a green cell background with a 25% grey mask. @@ -1169,8 +1351,9 @@
Borders - 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. @@ -1191,22 +1374,36 @@ border - —The border to apply the settings t= o. 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 t= o. The + value is a string that can be one of "all= ", + "bottom", "left", "none", "right" or "top= ". The + default is "all". lineStyle - —The border line style. The value i= s a string that can be one of "medium", "thin" - etc (see jxl.format.BorderLineStyle). + —The border line style. The value i= s a + string that can be one of "medium", "thin= " 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 jxl.= format.Colour). + —The color of the border. The value= is a + string that can be one of "blue", "red" e= tc + (see + + jxl.format.Colour + + ). @@ -1237,23 +1434,23 @@ - - = - - - - - - - ]]> + + + = = + + + + + + + ]]> defined a thin green border on the left edge of the cell.
Validation - Validations are nested inside cells, formulas or cell template= s. = + Validations are nested inside cells, formulas or cell template= s. They add constrains for the cell data. @@ -1275,46 +1472,57 @@ value - —The limit (or lower limit where ap= plicable) of the validation. The value is a + —The limit (or lower limit where + applicable) of the validation. The value = is a number. value2 - —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. condition - —The validation condition. The valu= e is a string. + —The validation condition. The valu= e is a + string. - "equal" - requires the cell value t= o match the one defined in the value-attribute + "equal" - requires the cell value to + match the one 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 + "greater_equal" - requires the cell= value + to be greater than or equal to the = value + defined in the value-attribute - "less_equal" - requires the cell va= lue to be less than or equal to the value + "less_equal" - requires the cell va= lue to + be less than or equal to the value defined in the value-attribute - "less_than" - requires the cell val= ue to be less than the value defined in the + "less_than" - requires the cell val= ue to + be less than the value defined in t= he value-attribute - "not_equal" - requires the cell val= ue to not match the one defined in the + "not_equal" - requires the cell val= ue to + not match the one defined in the value-attribute - "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 v= alue- + and value2 attributes - "not_between" - requires the cell v= alue not to be between the values defined in + "not_between" - requires the cell v= alue + not to be between the values define= d in the value- and value2 attributes @@ -1348,18 +1556,22 @@ - - = - - - - - - = - ]]> + + + = = + + + + + + = + ]]> - adds numeric validation to a cell specifying that the value= must be between 4 and 18. + + adds numeric validation to a cell specifying that the value mu= st be + between 4 and 18. + @@ -1379,29 +1591,30 @@ startColumn - —The starting column of the range o= f values to validate against. The value is a + —The starting column of the range of + values to validate against. The value is a number. startRow - —The starting row of the range of v= alues to validate against. The value is a - number. + —The starting row of the range of v= alues + to validate against. The value is a numbe= r. endColumn - —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 numbe= r. endRow - —The ending row of the range of val= ues to validate against. The value is a - number. + —The ending row of the range of val= ues to + validate against. The value is a number. @@ -1432,19 +1645,21 @@ - - = - - - - - - = - ]]> + + + = = + + + + + + = + ]]> - 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. @@ -1474,7 +1689,9 @@ - Zero or more list validation ite= ms. + + Zero or more list validation items. + @@ -1493,7 +1710,10 @@ - e:listValidation is a just a container for holding multiple= e:listValidationItem tags. + + e:listValidation is a just a container for holding multiple + e:listValidationItem tags. + @@ -1544,50 +1764,77 @@ - - = - - - - - - - - - = - ]]> + + + = = + + + + + + + + + = + ]]> - adds validation to a cell specifying that the value must be= "manager" or "employee". + + 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 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 + Format masks are defined in the mask attribute in cell templat= es, + cells or formulas. Note that when using templates, t= he = + format mask must be placed in the first template + to be cascaded since the constructor hierarchy in + JExcelAPI used for copying cell formats mak= es = + 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
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 jxl.write.NumberFormats). + When encountering a format mask, first it is checked if it = is in + internal form, e.g "format1", "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 (see java.text.DecimalFormat). - 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 m= ask + (see + + java.text.DecimalFormat + + ). e.g "0.00" and automatically converted to the closest ma= tch.
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 jxl.write= .DecimalFormats). + When encountering a format mask, first it is checked if it = is in + internal form, e.g "format1", "format2" and so on (see + + jxl.write.DecimalFormats + + ). - 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. + 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 automatically converted to the clo= sest + match.
@@ -1595,43 +1842,53 @@
Formulas - 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. + 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 t= hat they = + can apply templates and have own font definitions etc just as nor= mal = + cells. - 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. + The formula of the cell in placed in the value + -attribute as a normal &excel; 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 + + defines an formula in B2 summing cells A1 in worksheets FooSheet = and + BarSheet +
Images - Images are nested within columns (for iteration) or inside wor= ksheets (for direct placement using the = - startColumn/startRow and endColumn/endRo= w attributes) + + Images are nested within columns (for iteration) or inside worksh= eets + (for direct placement using the startColumn/startRow + and endColumn/endRow + attributes) + @@ -1651,35 +1908,42 @@ startColumn - —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 i= s 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. Note that the value is 0-based. + —The starting row of the image. The de= fault + is the internal counter. The value is a numb= er. + 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. Note that = the value is 0-based. + —The column span of the image. The def= ault + is one resulting in the default width of 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. Note th= at the value is 0-based. + —The row span of the image. The defaul= t is + the one resulting in the default height of t= he + image. The value is a number. Note that the = value + is 0-based. URI - —The URI to the image. The value is a = string. + —The URI to the image. The value is a + string. @@ -1710,20 +1974,26 @@ - - - - = - ]]> + + + + + = + ]]> defines an image in A1:E5 based on the given data =
Hyperlinks - 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 + + Hyperlinks are nested within columns (for iteration) or inside + worksheets (for direct placement using the = + startColumn/startRow and + endColumn/endRow attributes). They add link = + navigation to URIs + @@ -1743,29 +2013,33 @@ startColumn - —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 i= s 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. Note that the value is 0-based. + —The starting row of the hyperlink. The + default is the internal counter. The value i= s 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. Note that the value is 0-based. + —The ending column of the hyperlink. T= he + default is the internal counter. The value i= s 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. Note that the value is 0-based. + —The ending row of the hyperlink. The + default is the internal counter. The value i= s a + number. Note that the value is 0-based. @@ -1777,7 +2051,8 @@ description - —The description of the link. The valu= e is a string. + —The description of the link. The valu= e is a + string. @@ -1808,21 +2083,25 @@ - - - - = - ]]> + + + + + = + ]]> - defines a described hyperlink pointing to SFWK in the area A1:= E5 + + defines a described hyperlink pointing to SFWK in the area A1:E5 +
Headers and footers - 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. = + Headers and footers are childrens of worksheets and worksheet tem= plates + and parents of header and footer commands They add headers and fo= oters + to printed worksheets. @@ -1843,8 +2122,8 @@ type - —The type of the header or footer. The= value is string that can be either "header" - or "footer". + —The type of the header or footer. The= value + is string that can be either "header" or "fo= oter". @@ -1865,19 +2144,22 @@ left - —The contents of the left header/foote= r part. + —The contents of the left header/footer + part. center - —The contents of the center header/foo= ter part. + —The contents of the center header/foo= ter + part. right - —The contents of the right header/foot= er part. + —The contents of the right header/foot= er + part. @@ -1887,7 +2169,9 @@ - The <e:headerFooterCommands> is just a n= esting container in order to support multiple header/footer commands. + The <e:headerFooterCommands> + is just a nesting container in order to support multiple header/f= ooter + commands. @@ -1916,9 +2200,7 @@ - - Zero or more header/footer commands. - + Zero or more header/footer commands. @@ -1936,8 +2218,10 @@ - Header/footer commands adds actual commands to the header or f= ooter in the location where the = - containing facet points. + + Header/footer commands adds actual commands to the header or foot= er in + the location where the containing facet points. + @@ -1957,33 +2241,67 @@ command - —The command to execute. The value is = a string + —The command to execute. The value is a + string "append" - appends the text in the parameter - "date" - appends the current da= te - "page_number" - appends the pag= e number + + "date" - appends the current date + + + "page_number" - appends the page number + "time" - appends the time - "total_pages" - appends the tot= al page count - "workbook_name" - appends the w= orkbook name - "worksheet_name" - appends the = worksheet name - "toggle_bold" - toggles bold fo= nt - "toggle_italics" - toggles ital= ics - "toggle_double_underline" - tog= gles double underlining - "toggle_outline" - toggles outl= ine - "toggle_shadow" - toggles shado= w - "toggle_strikethrough" - toggle= s strikethrough - "toggle_subscript" - toggles su= bscript - "toggle_superscript" - toggles = superscript - "toggle_underline" - toggles un= derline - "font_name" - sets the font name given= in the + "total_pages" - appends the total page= count + + + "workbook_name" - appends the workbook= name + + + "worksheet_name" - appends the workshe= et + name + + + "toggle_bold" - toggles bold font + + + "toggle_italics" - toggles italics + + + "toggle_double_underline" - toggles do= uble + underlining + + + "toggle_outline" - toggles outline + + + "toggle_shadow" - toggles shadow + + + "toggle_strikethrough" - toggles + strikethrough + + + "toggle_subscript" - toggles subscript + + + "toggle_superscript" - toggles supersc= ript + + + "toggle_underline" - toggles underline + + + "font_name" - sets the font name given= in + the parameter - "font_size" - sets the font size given= in the + "font_size" - sets the font size given= in + the parameter @@ -1992,10 +2310,13 @@ parameter - —The parameter for some commands. Used= by the font_name, font_size and append - commands. The font_name parameter is a strin= g that represents the requested font name, the - font_size parameter is a number that represe= nts the requested font size and the append - parameter is a string of text to be appended= to the header/footer. + —The parameter for some commands. Used= by + the font_name, font_size and append commands= . The + font_name parameter is a string that represe= nts + the requested font name, the font_size param= eter + is a number that represents the requested fo= nt + size and the append parameter is a string of= text + to be appended to the header/footer. @@ -2026,17 +2347,17 @@ - = - - - - - - - - - + + = + + + + + + + + + ]]> Defines a header with the page number in the left corner. @@ -2044,7 +2365,8 @@
Print areas and titles - Print areas and titles childrens of worksheets and worksheet temp= lates and provide... print areas and titles. = + Print areas and titles childrens of worksheets and worksheet temp= lates + and provide... print areas and titles. @@ -2065,25 +2387,33 @@ firstColumn - —The column of the top-left corner of = the area. The parameter is a number. Note that the value is 0-based. + —The column of the top-left corner of = the + area. The parameter is a number. Note that t= he + value is 0-based. firstRow - —The row of the top-left corner of the= area. The parameter is a number. Note that the value is 0-based. + —The row of the top-left corner of the= area. + The parameter is a number. Note that the val= ue is + 0-based. lastColumn - —The column of the bottom-right corner= of the area. The parameter is a number. Note that the value is 0-based. + —The column of the bottom-right corner= of + the area. The parameter is a number. Note th= at the + value is 0-based. lastRow - —The row of the bottom-right corner of= the area. The parameter is a number. Note that the value is 0-based. + —The row of the bottom-right corner of= the + area. The parameter is a number. Note that t= he + value is 0-based. @@ -2114,24 +2444,29 @@ - = - - - - - ]]> + + = + + + + + ]]> - defines a print title between A1:A10 and a print area between = B2:J10. + + 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. + + Worksheet commands are children of workbooks and are usually exec= uted + only once. +
Grouping - - Provides grouping of columns and rows. - + Provides grouping of columns and rows. @@ -2151,19 +2486,24 @@ startRow - —The row to start the grouping at. = The value is a number. Note that the value is 0-based. + —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. Note that the value is 0-based. + —The row to end the grouping at. The + value is a number. Note that the value is + 0-based. collapse - —Should the grouping be collapsed i= nitially? The value is a boolean. + —Should the grouping be collapsed + initially? The value is a boolean. @@ -2211,19 +2551,24 @@ startColumn - —The column to start the grouping a= t. The value is a number. Note that the value is 0-based. + —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. Note that the value is 0-based. + —The column to end the grouping at.= The + value is a number. Note that the value is + 0-based. collapse - —Should the grouping be collapsed i= nitially? The value is a boolean. + —Should the grouping be collapsed + initially? The value is a boolean. @@ -2255,17 +2600,17 @@ = - = - - - - + + = + + + + ]]> - groups rows 5 trough 10 and columns 5 through 10 so that the r= ows are initially collapsed (but not the - columns). + groups rows 5 trough 10 and columns 5 through 10 so that the r= ows + are initially collapsed (but not the columns). =
@@ -2291,7 +2636,8 @@ row - —The row to break at. The value is = a number. Note that the value is 0-based. + —The row to break at. The value is a + number. Note that the value is 0-based. @@ -2322,11 +2668,11 @@ - = - - - = + + = + + + = ]]> breaks page at row 5. @@ -2353,25 +2699,32 @@ startRow - —The row to start the merging from.= The value is a number. Note that the value is 0-based. + —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. Note that the value is 0-based. + —The column to start the merging fr= om. + The value is a number. Note that the valu= e is + 0-based. endRow - —The row to end the merging at. The= value is a number. Note that the value is 0-based. + —The row to end the merging at. The= value + is a number. Note that the value is 0-bas= ed. endColumn - —The column to end the merging at. = The value is a number. Note that the value is 0-based. + —The column to end the merging at. = The + value is a number. Note that the value is + 0-based. @@ -2402,11 +2755,11 @@ - - - - = + + + + + = ]]> merges the cells in the range A1:J10 @@ -2415,95 +2768,106 @@
Templates - Templates are a way of grouping common formatting under a name to= be used later. They come in two flavors, cell - level and worksheet settings level and they can be cascaded so th= at the end result is a union of the applied - templates (overriden where applicable) + Templates are a way of grouping common formatting under a name to= be + used later. They come in two flavors, cell level and worksheet se= ttings + level and they can be cascaded so that the end result is a union = of the + applied templates (overriden where applicable)
Cell templates - Cell templates are defined on workbook level using the foll= owing notation + + Cell templates are defined on workbook level using the followi= ng + notation + - - - - = + + + + + = ]]> - and are later used by referencing them in the templates att= ribute of a cell + + and are later used by referencing them in the templates attrib= ute of + a cell + - = - - - = + + = + + + = ]]> - 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 + Cell templates have the same attributes as cells (see + + ). Note that the cellTemplate can also contain tags for font, = border + and background definitions and they are merged with the defini= tions + of the cell using the templates so a more complex definition c= ould + look like - - - - = + + + + + = = - - - - - = + + + + + = ]]> so that a cell that later on applies the templates - = - - - - - = + + = + + + + + = ]]> - end up with a red Times New Roman font in a right-aligned, wra= pping cell that has a solid blue background - and thick yellow borders, with exception of the left border, w= hich is thin and green. + end up with a red Times New Roman font in a right-aligned, wra= pping + cell that has a solid blue background and thick yellow borders= , with + exception of the left border, which is thin and green.
Worksheet setting templates - Worksheet settings are defined and used in the same way as cel= l templates. On workbook level, you can place - a + Worksheet settings are defined and used in the same way as cell + templates. On workbook level, you can place a - = - - - = + + + = ]]> 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 (see ). + you end up with a worksheet that is frozen at column 5 and row= 5. + Note that a worksheetTemplate is essentially a named worksheet= (see + + ). =
@@ -2511,61 +2875,68 @@
Datatable exporter - If you prefer to export an existing JSF datatable instead of writ= ing a dedicated XHTML document, this can also - be achieved easily by executing the - org.jboss.seam.excel.excelExporter.export - component, passing in the id of the datatable as an Seam EL param= eter. Consider you have a data table + If you prefer to export an existing JSF datatable instead of writ= ing a + dedicated XHTML document, this can also be achieved easily by exe= cuting + the org.jboss.seam.excel.excelExporter.export + component, passing in the id of the datatable as an Seam EL param= eter. + Consider you have a data table - - ... - - + + + ... + + ]]> - that you want to view as an Mi= crosoft Excel = - spreadsheet. Place a + + that you want to view as an + Microsoft + Excel + spreadsheet. Place a + - ]]> + + ]]> - in the form and you're done. You can of course execute the export= er with a button, s:link or other preferred - method. There are also plans for a dedicated export tag that can = be placed inside the datatable tag so you - won't have to refer to the datatable by ID. + in the form and you're done. You can of course execute the export= er + with a button, s:link or other preferred method. There are also p= lans + for a dedicated export tag that can be placed inside the datatabl= e tag + so you won't have to refer to the datatable by ID.
CSS - In order to provide formatting for the spreadsheet, you can ut= ilize a number of xls-prefixed CSS:ish - attributes that are placed in the style-attribute of the datat= able to be exported: + In order to provide formatting for the spreadsheet, you can ut= ilize + a number of xls-prefixed CSS:ish attributes that are placed in= the + style-attribute of the datatable to be exported: - - ... - - + + + ... + + ]]> - which sets Times New Roman as the font and red as the cell bac= kground. Just as in CSS, separate name and - value with a - : - and multiple attributes with a - ; - . Below is a list of the supported style-attributes: + which sets Times New Roman as the font and red as the cell + background. Just as in CSS, separate name and value with a + : and multiple attributes with a + ;. Below is a list of the supported = + style-attributes: @@ -2593,7 +2964,14 @@ xlsFontColor - The color of the font (see jxl.format.Colour). + + The color of the font (see + + jxl.format.Colour + + ). + @@ -2601,7 +2979,10 @@ xlsFontBold - Should the font be bold? Valid values are "t= rue" and "false" + + Should the font be bold? Valid values are "true= " and + "false" + @@ -2609,7 +2990,10 @@ xlsFontItalic - Should the font be italic? Valid values are = "true" and "false" + + Should the font be italic? Valid values are "tr= ue" + and "false" + @@ -2617,7 +3001,14 @@ xlsFontScriptStyle - The script style of the font (see jxl.format.ScriptStyle). + + The script style of the font (see + + jxl.format.ScriptStyle + + ). + @@ -2625,7 +3016,10 @@ xlsFontStruckOut - Should the font be struck out? Valid values = are "true" and "false" + + Should the font be struck out? Valid values are + "true" and "false" + @@ -2633,7 +3027,14 @@ xlsFontUnderlineStyle - The underline style of the font (see jxl.format.UnderlineStyle). + + The underline style of the font (see + + jxl.format.UnderlineStyle + + ). + @@ -2641,7 +3042,14 @@ xlsBackgroundColor - The background color of the cell (see jxl.format.Colour). + + The background color of the cell (see + + jxl.format.Colour + + ). + @@ -2649,7 +3057,14 @@ xlsBackgroundPattern - The background pattern of the cell (see jxl.format.Pattern). + + The background pattern of the cell (see + + jxl.format.Pattern + + ). + @@ -2657,7 +3072,14 @@ xlsAlignment - The alignment of the cell value (see jxl.format.Alignment). + + The alignment of the cell value (see + + jxl.format.Alignment + + ). + @@ -2666,24 +3088,22 @@ - The column widths. Note that the unit is intern= al to the Microsoft = - Excel spreadsheet file format, be prepared to use largeish numbers. = - Separate columns with a - , - and use - * - for not setting a value. + The column widths. Note that the unit is intern= al to + &excel;, be prepared to use largeish numbers. = + Separate columns with a , + and use * for not setting a = value. - ... - -]]> + + ... + + ]]> - leaves the width on column 1 as default, sets t= he width of column 2 to 800 and leaves the - rest of the columns (if any) as default. + leaves the width on column 1 as default, sets t= he + width of column 2 to 800 and leaves the rest of= the + columns (if any) as default. @@ -2692,7 +3112,14 @@ xlsBorderColor - The the border color of the entire cell (see= jxl.format.Colour). + + The the border color of the entire cell (see + + jxl.format.Colour + + ). + @@ -2700,7 +3127,15 @@ xlsBorderColorLeft - The the border color of the left edge of the= cell (see jxl.format.Colour). + + The the border color of the left edge of the ce= ll + (see + + jxl.format.Colour + + ). + @@ -2708,7 +3143,14 @@ xlsBorderColorTop - The the border color of the top edge of the = cell (see jxl.format.Colour). + + The the border color of the top edge of the cel= l (see + + jxl.format.Colour + + ). + @@ -2716,7 +3158,15 @@ xlsBorderColorRight - The the border color of the right edge of th= e cell (see jxl.format.Colour). + + The the border color of the right edge of the c= ell + (see + + jxl.format.Colour + + ). + @@ -2724,7 +3174,15 @@ xlsBorderColorBottom - The the border color of the bottom edge of t= he cell (see jxl.format.Colour). + + The the border color of the bottom edge of the = cell + (see + + jxl.format.Colour + + ). + @@ -2732,7 +3190,14 @@ xlsBorderLineStyle - The the border line style of the entire cell= (see jxl.format.Colour). + + The the border line style of the entire cell (s= ee + + jxl.format.Colour + + ). + @@ -2741,7 +3206,13 @@ - The the border line style of the left edge of t= he cell (see jxl.format.Colour). + The the border line style of the left edge of t= he + cell (see + + jxl.format.Colour + + ). @@ -2751,7 +3222,13 @@ - The the border line style of the top edge of th= e cell (see jxl.format.Colour). + The the border line style of the top edge of th= e cell + (see + + jxl.format.Colour + + ). @@ -2761,8 +3238,13 @@ - The the border line style of the right edge of = the cell (see jxl.format.Colour). - styles + The the border line style of the right edge of = the + cell (see + + jxl.format.Colour + + ). styles @@ -2772,8 +3254,13 @@ - The the border line style of the bottom edge of= the cell (see jxl.format.Colour). - styles + The the border line style of the bottom edge of= the + cell (see + + jxl.format.Colour + + ). styles @@ -2784,46 +3271,50 @@
Templates - In order to provide different formatting for different kind of= cells you can use templates. Templates are - defined in the datatable style attribute as seen in the exampl= es in the previous section by using a - dot-notation on the xls-attribute names. Attributes without te= mplate names are considered global and are - applied to all cells. + In order to provide different formatting for different kind of= cells + you can use templates. Templates are defined in the datatable = style + attribute as seen in the examples in the previous section by u= sing a + dot-notation on the xls-attribute names. Attributes without te= mplate + names are considered global and are applied to all cells. - Templates are used by referring to them in the style attribute= of the UIOutput using the xlsTemplates - attribute. If you wish to cascade several templates, separate = them with a + Templates are used by referring to them in the style attribute= of + the UIOutput using the xlsTemplates attribute. If you wish to + cascade several templates, separate them with a , . - - - - - - - -]]> + + + + + + + + + ]]> - results in the first column being Times New Roman, blue and th= e second column being Times New Roman red - bold. + results in the first column being Times New Roman, blue and the + second column being Times New Roman red bold.
Links and further documentation - The core of the Microsoft Excel spreadsheet = - functionality is based on the excellent JExcelAPI library which c= an be found on - http://jexcelapi.sourceforge.net/ and most features and possible = limitations are inherited from here. + The core of the &excel; functionality is based on the excellent = + JExcelAPI library which can be found on = + http://jexcelapi.sourceforge.net/ and most features and possible = + limitations are inherited from here. - If you use the forum or mailing list, please remember that they d= on't know anything about Seam and the usage of - their library, any issues are best reported in the JBoss Seam JIR= A under the "excel" module. + If you use the forum or mailing list, please remember that they d= on't + know anything about Seam and the usage of their library, any issu= es are + best reported in the JBoss Seam JIRA under the "excel" module.
--===============1878072615206047767==--