Sheet (excel-builder 0.4.1 API)

com.jameskleeh.excel.Sheet

A class used to create a sheet in an excel document
Authors:
James Kleeh
Since:
0.1.0

Constructor Summary

Constructors
Constructor and description
`Sheet (org.apache.poi.xssf.usermodel.XSSFSheet sheet, CellStyleBuilder styleBuilder)`

Methods Summary

Methods
Type	Name and description
`void`	`column(groovy.lang.Closure callable)` Output data by column
`void`	`columns(groovy.lang.Closure callable)` Used to define headers for a sheet
`void`	`columns(java.util.Map options, groovy.lang.Closure callable)` Used to define headers for a sheet
`void`	`defaultStyle(java.util.Map options)` Sets the default styling for the sheet
`org.apache.poi.xssf.usermodel.XSSFRow`	`row()` Creates a row
`org.apache.poi.xssf.usermodel.XSSFRow`	`row(java.lang.Object... cells)` Creates a row
`org.apache.poi.xssf.usermodel.XSSFRow`	`row(groovy.lang.Closure callable)` Creates a row
`org.apache.poi.xssf.usermodel.XSSFRow`	`row(java.util.Map options, groovy.lang.Closure callable)` Creates a row
`void`	`skipColumns(int num)` Skips columns
`void`	`skipRows(int num)` Skips rows
`void`	`skipTo(java.lang.Object id)` Skip to a previously defined column created by column

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Constructor Detail
  - Sheet(org.apache.poi.xssf.usermodel.XSSFSheet sheet, CellStyleBuilder styleBuilder)
- Method Detail
  - void column(@groovy.lang.DelegatesTo(strategy = Closure.DELEGATE_FIRST, value = Column) groovy.lang.Closure callable)
    
    Output data by column
    Parameters:
    callable - To build column data
  - void columns(@groovy.lang.DelegatesTo(strategy = Closure.DELEGATE_FIRST, value = Row) groovy.lang.Closure callable)
    
    Used to define headers for a sheet
    Parameters:
    callable - To build header data
  - void columns(java.util.Map options, @groovy.lang.DelegatesTo(strategy = Closure.DELEGATE_FIRST, value = Row) groovy.lang.Closure callable)
    
    Used to define headers for a sheet
    Parameters:
    options - Default style options for the header
    callable - To build header data
  - void defaultStyle(java.util.Map options)
    
    Sets the default styling for the sheet
    Parameters:
    options - Style options
  - org.apache.poi.xssf.usermodel.XSSFRow row()
    
    Creates a row
    Returns:
    The native row
  - org.apache.poi.xssf.usermodel.XSSFRow row(java.lang.Object... cells)
    
    Creates a row
    Parameters:
    cells - A list of data to output as cells
    Returns:
    The native row
  - org.apache.poi.xssf.usermodel.XSSFRow row(@groovy.lang.DelegatesTo(strategy = Closure.DELEGATE_FIRST, value = Row) groovy.lang.Closure callable)
    
    Creates a row
    Parameters:
    callable - To build row data
    Returns:
    The native row
  - org.apache.poi.xssf.usermodel.XSSFRow row(java.util.Map options, @groovy.lang.DelegatesTo(strategy = Closure.DELEGATE_FIRST, value = Row) groovy.lang.Closure callable)
    
    Creates a row
    Parameters:
    options - Default styling options
    callable - To build row data
    Returns:
    The native row
  - void skipColumns(int num)
    
    Skips columns
    Parameters:
    num - The number of columns to skip
  - void skipRows(int num)
    
    Skips rows
    Parameters:
    num - The number of rows to skip
  - void skipTo(java.lang.Object id)
    
    Skip to a previously defined column created by column
    Parameters:
    id - The column identifier

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class Sheet

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

Sheet(org.apache.poi.xssf.usermodel.XSSFSheet sheet, CellStyleBuilder styleBuilder)

Method Detail

void column(@groovy.lang.DelegatesTo(strategy = Closure.DELEGATE_FIRST, value = Column) groovy.lang.Closure callable)

void columns(@groovy.lang.DelegatesTo(strategy = Closure.DELEGATE_FIRST, value = Row) groovy.lang.Closure callable)

void columns(java.util.Map options, @groovy.lang.DelegatesTo(strategy = Closure.DELEGATE_FIRST, value = Row) groovy.lang.Closure callable)

void defaultStyle(java.util.Map options)

org.apache.poi.xssf.usermodel.XSSFRow row()

org.apache.poi.xssf.usermodel.XSSFRow row(java.lang.Object... cells)

org.apache.poi.xssf.usermodel.XSSFRow row(@groovy.lang.DelegatesTo(strategy = Closure.DELEGATE_FIRST, value = Row) groovy.lang.Closure callable)

org.apache.poi.xssf.usermodel.XSSFRow row(java.util.Map options, @groovy.lang.DelegatesTo(strategy = Closure.DELEGATE_FIRST, value = Row) groovy.lang.Closure callable)

void skipColumns(int num)

void skipRows(int num)

void skipTo(java.lang.Object id)