ExcelBuilder (grails-export-root 8.0.0-SNAPSHOT API)

grails.plugins.export.builder.ExcelBuilder

```
class ExcelBuilder
extends groovy.util.BuilderSupport
```
Authors:
Andreas Schmitt This class implements a Groovy builder for creating Excel files. It uses JExcelApi under the hood to build the actual Excel files. The builder supports basic formatting and multiple sheets. Formulas and more advanced features are not supported yet. The following code snippet shows how to create Excel files using this builder: def builder = new ExcelBuilder() builder { workbook(outputStream: outputStream){ sheet(name: "Sheet1"){ format(name: "format1"){ font(name: "Arial", size: 10, bold: true, underline: "single", italic: true) } cell(row: 0, column: 0, value: "Hello1") cell(row: 0, column: 1, value: "Hello2") } sheet(name: "Sheet2"){ } } } builder.write()

Properties Summary

Properties
Type	Name and description
`boolean`	`autoSizeColumns`
`org.apache.poi.ss.usermodel.CellStyle`	`dateCellStyle`
`org.apache.poi.ss.usermodel.CellStyle`	`defaultHyperlinkStyle`
`java.lang.String`	`format`
`java.util.Map<java.lang.String, org.apache.poi.ss.usermodel.CellStyle>`	`formats`
`org.apache.poi.ss.usermodel.Sheet`	`sheet`
`org.apache.poi.ss.usermodel.Workbook`	`workbook`

Constructor Summary

Constructors
Constructor and description
`ExcelBuilder()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected java.lang.Object`	`createNode(java.lang.Object name)` This method is invoked when you invoke a method without arguments on the builder e.g. builder.write().
	`protected java.lang.Object`	`createNode(java.lang.Object name, java.lang.Object value)` This method isn't implemented.
	`protected java.lang.Object`	`createNode(java.lang.Object name, java.util.Map attributes)` This method is invoked when you invoke a method with a map of attributes e.g.
	`protected java.lang.Object`	`createNode(java.lang.Object name, java.util.Map attributes, java.lang.Object value)` This method isn't implemented.
	`protected void`	`setParent(java.lang.Object parent, java.lang.Object child)` This method isn't implemented.
	`void`	`write(java.io.OutputStream targetStream)` Finish writing the document.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class groovy.util.BuilderSupport`	groovy.util.BuilderSupport#equals(java.lang.Object), groovy.util.BuilderSupport#getClass(), groovy.util.BuilderSupport#getMetaClass(), groovy.util.BuilderSupport#getProperty(java.lang.String), groovy.util.BuilderSupport#hashCode(), groovy.util.BuilderSupport#invokeMethod(java.lang.String), groovy.util.BuilderSupport#invokeMethod(java.lang.String, java.lang.Object), groovy.util.BuilderSupport#notify(), groovy.util.BuilderSupport#notifyAll(), groovy.util.BuilderSupport#setMetaClass(groovy.lang.MetaClass), groovy.util.BuilderSupport#setProperty(java.lang.String, java.lang.Object), groovy.util.BuilderSupport#toString(), groovy.util.BuilderSupport#wait(), groovy.util.BuilderSupport#wait(long), groovy.util.BuilderSupport#wait(long, int)

- Property Detail
  - boolean autoSizeColumns
  - org.apache.poi.ss.usermodel.CellStyle dateCellStyle
  - org.apache.poi.ss.usermodel.CellStyle defaultHyperlinkStyle
  - java.lang.String format
  - java.util.Map<java.lang.String, org.apache.poi.ss.usermodel.CellStyle> formats
  - org.apache.poi.ss.usermodel.Sheet sheet
  - org.apache.poi.ss.usermodel.Workbook workbook
- Constructor Detail
  - ExcelBuilder()
- Method Detail
  - protected java.lang.Object createNode(java.lang.Object name)
    
    This method is invoked when you invoke a method without arguments on the builder e.g. builder.write().
    Parameters:
    name - The name of the method which should be invoked e.g. write.
  - protected java.lang.Object createNode(java.lang.Object name, java.lang.Object value)
    
    This method isn't implemented.
  - protected java.lang.Object createNode(java.lang.Object name, java.util.Map attributes)
    
    This method is invoked when you invoke a method with a map of attributes e.g. cell(row: 0, column: 0, value: "Hello1"). It switches between different build actions such as creating the workbook, sheet, cells etc.
    Parameters:
    name - The name of the method which should be invoked e.g. cell
    attributes - The map of attributes which have been supplied e.g. [row: 0, column: 0, value: "Hello1"]
  - protected java.lang.Object createNode(java.lang.Object name, java.util.Map attributes, java.lang.Object value)
    
    This method isn't implemented.
  - protected void setParent(java.lang.Object parent, java.lang.Object child)
    
    This method isn't implemented.
  - void write(java.io.OutputStream targetStream)
    
    Finish writing the document.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class ExcelBuilder

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

boolean autoSizeColumns

org.apache.poi.ss.usermodel.CellStyle dateCellStyle

org.apache.poi.ss.usermodel.CellStyle defaultHyperlinkStyle

java.lang.String format

java.util.Map<java.lang.String, org.apache.poi.ss.usermodel.CellStyle> formats

org.apache.poi.ss.usermodel.Sheet sheet

org.apache.poi.ss.usermodel.Workbook workbook

Constructor Detail

ExcelBuilder()

Method Detail

protected java.lang.Object createNode(java.lang.Object name)

protected java.lang.Object createNode(java.lang.Object name, java.lang.Object value)

protected java.lang.Object createNode(java.lang.Object name, java.util.Map attributes)

protected java.lang.Object createNode(java.lang.Object name, java.util.Map attributes, java.lang.Object value)

protected void setParent(java.lang.Object parent, java.lang.Object child)

void write(java.io.OutputStream targetStream)