net.sf.jxls.controller
Interface SheetTransformationController

All Known Implementing Classes:

SheetTransformationControllerImpl

public interface SheetTransformationController

Interface for controlling all excel sheet transformations

Author:

Leonid Vysochyn

Method Summary

int	duplicateDown(Block block, int n) This method duplicates given block down
int	duplicateRight(Block block, int n) This method duplicates given block to the right
void	duplicateRow(RowCollection rowCollection) Duplicates given row cells according to passed RowCollection object
Sheet	getSheet()
java.util.List	getTransformations()
void	removeBodyRows(Block block) Deletes the body of the block
void	removeBorders(Block block) This method removes borders around given block shifting all other rows
void	removeLeftRightBorders(Block block) This method removes left and right borders for the block
void	removeRowCells(org.apache.poi.ss.usermodel.Row row, int startCellNum, int endCellNum) Clears row cells in a given range

Method Detail

getSheet

Sheet getSheet()

Returns:

Sheet corresponding worksheet object

duplicateRight

int duplicateRight(Block block,
                   int n)

This method duplicates given block to the right

Parameters:

block - - Block to process

n - - number of times to duplicate given block

Returns:

shift number based on number of affected rows

duplicateDown

int duplicateDown(Block block,
                  int n)

This method duplicates given block down

Parameters:

block - - Block to process

n - - number of times to duplicate given block

Returns:

shift number based on number of affected rows

removeBorders

void removeBorders(Block block)

This method removes borders around given block shifting all other rows

Parameters:

block - - Block to process

removeLeftRightBorders

void removeLeftRightBorders(Block block)

This method removes left and right borders for the block

Parameters:

block - - Block to process

removeRowCells

void removeRowCells(org.apache.poi.ss.usermodel.Row row,
                    int startCellNum,
                    int endCellNum)

Clears row cells in a given range

Parameters:

row - Row to process

startCellNum - - start cell number to clear

endCellNum - - end cell number to clear

removeBodyRows

void removeBodyRows(Block block)

Deletes the body of the block

Parameters:

block - Block to process

duplicateRow

void duplicateRow(RowCollection rowCollection)

Duplicates given row cells according to passed RowCollection object

Parameters:

rowCollection - - RowCollection object defining duplicate numbers and cell ranges

getTransformations

java.util.List getTransformations()

Returns:

list of all transformation applied by this controller