org.jxls.transform

Interface Transformer

All Known Implementing Classes:

AbstractTransformer

public interface Transformer

Defines interface methods for Excel operations

Since:

1/23/12

Author:

Leonid Vysochyn

Method Summary

Modifier and Type	Method and Description
void	addImage(AreaRef areaRef, byte[] imageBytes, ImageType imageType)
void	adjustTableSize(CellRef ref, Size size)
void	clearCell(CellRef cellRef)
boolean	deleteSheet(String sheetName)
void	dispose() Must be called after use.
CellData	getCellData(CellRef cellRef)
List<CellData>	getCommentedCells()
Set<CellData>	getFormulaCells()
List<CellRef>	getTargetCellRef(CellRef cellRef)
TransformationConfig	getTransformationConfig()
void	mergeCells(CellRef ref, int rows, int cols)
void	resetArea(AreaRef areaRef)
void	resetTargetCellRefs()
void	setFormula(CellRef cellRef, String formulaString)
void	setHidden(String sheetName, boolean hidden)
void	setTransformationConfig(TransformationConfig transformationConfig)
void	transform(CellRef srcCellRef, CellRef targetCellRef, Context context, boolean updateRowHeight)
void	updateRowHeight(String srcSheetName, int srcRowNum, String targetSheetName, int targetRowNum)
void	write() Writes Excel workbook to output stream and disposes the workbook.

Method Detail

setTransformationConfig

void setTransformationConfig(TransformationConfig transformationConfig)

getTransformationConfig

TransformationConfig getTransformationConfig()

transform

void transform(CellRef srcCellRef,
               CellRef targetCellRef,
               Context context,
               boolean updateRowHeight)

write

void write()
    throws IOException

Writes Excel workbook to output stream and disposes the workbook.

Throws:

IOException

dispose

void dispose()

Must be called after use. write() calls this method.

setFormula

void setFormula(CellRef cellRef,
                String formulaString)

getFormulaCells

Set<CellData> getFormulaCells()

getCellData

CellData getCellData(CellRef cellRef)

getTargetCellRef

List<CellRef> getTargetCellRef(CellRef cellRef)

Parameters:

cellRef - a source cell reference

Returns:

a list of cell references into which the source cell was transformed

resetTargetCellRefs

void resetTargetCellRefs()

resetArea

void resetArea(AreaRef areaRef)

clearCell

void clearCell(CellRef cellRef)

getCommentedCells

List<CellData> getCommentedCells()

addImage

void addImage(AreaRef areaRef,
              byte[] imageBytes,
              ImageType imageType)

deleteSheet

boolean deleteSheet(String sheetName)

setHidden

void setHidden(String sheetName,
               boolean hidden)

updateRowHeight

void updateRowHeight(String srcSheetName,
                     int srcRowNum,
                     String targetSheetName,
                     int targetRowNum)

adjustTableSize

void adjustTableSize(CellRef ref,
                     Size size)

mergeCells

void mergeCells(CellRef ref,
                int rows,
                int cols)