tecgraf.javautils.excel.v1.poi

Class PoiExcelStructureTool

java.lang.Object

tecgraf.javautils.excel.v1.poi.PoiExcelTool

tecgraf.javautils.excel.v1.poi.PoiExcelStructureTool

All Implemented Interfaces:

ExcelStructureTool, ExcelTool

public class PoiExcelStructureTool
extends PoiExcelTool
implements ExcelStructureTool

Classe responsável por realizar operações de merges.

Author:

bbreder

Constructor Summary

Constructors

Constructor and Description
PoiExcelStructureTool(PoiExcelSheet helper) Construtor padrão

Method Summary

Modifier and Type	Method and Description
int	getColumnBegin() Retorna a coluna inicial corrente
int	getColumnEnd() Retorna a coluna final corrente
int	getColumnWidth(int column) Retorna o comprimento da coluna
PoiExcelSheet	getHelper() Retorna o facilitador que constroi sheet.
int	getRowBegin() Retorna a linha inicial corrente
int	getRowEnd() Retorna a linha final corrente
ExcelMerge	hasMerge(int columnIndex, int rowIndex) Indica a ocorrencia de um merge na celula.
PoiExcelStructureTool	merge(int columnBegin, int columnEnd, int rowBegin, int rowEnd) Realiza um merge entre celulas delimitado por um intervalo de linhas e colunas.
PoiExcelStructureTool	mergeColumn(int columnBegin, int columnEnd, int row) Realiza um merge entre celulas delimitado por um intervalo de colunas e uma linha.
PoiExcelStructureTool	mergeRow(int column, int rowBegin, int rowEnd) Realiza um merge entre celulas delimitado por um intervalo de linhas e uma coluna.
PoiExcelStructureTool	repeatColumnMerge(int... rows) Realiza um merge entre celulas delimitado pelas colunas utilizadas anteriormente e um conjunto de linhas.
PoiExcelStructureTool	repeatLineMerge(int... columns) Realiza um merge entre celulas delimitado pelas linhas utilizadas anteriormente e um conjunto de colunas.
void	setColumn(int columnBegin, int columnEnd) Atribui um intervalo de colunas corrente
void	setColumnBegin(int columnBegin) Atribui uma coluna inicial corrente
void	setColumnEnd(int columnEnd) Atribui uma coluna final corrente
ExcelStructureTool	setColumnWidth(int column, int width) Atribui uma espessura para a coluna na unidade Excel (in units of 1/256th of a character width)
void	setRow(int rowBegin, int rowEnd) Atribui um intervalo de linhas corrente
void	setRowBegin(int rowBegin) Atribui uma linha inicial corrente
void	setRowEnd(int rowEnd) Atribui uma linha final corrente
ExcelStructureTool	setRowHeight(int row, int height) Atribui uma altura de uma linha
String	toString()

Methods inherited from class tecgraf.javautils.excel.v1.poi.PoiExcelTool

getPoiSheet, getSheet, getWorkbook, setSheet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface tecgraf.javautils.excel.v1.ExcelTool

getSheet

Constructor Detail

PoiExcelStructureTool

public PoiExcelStructureTool(PoiExcelSheet helper)

Construtor padrão

Parameters:

helper -

Method Detail

merge

public PoiExcelStructureTool merge(int columnBegin,
                                   int columnEnd,
                                   int rowBegin,
                                   int rowEnd)

Realiza um merge entre celulas delimitado por um intervalo de linhas e colunas.

Specified by:

merge in interface ExcelStructureTool

Parameters:

columnBegin - inicio da coluna (1..Short.MAX_VALUE) inclusive

columnEnd - fim da coluna (1..Short.MAX_VALUE) inclusive

rowBegin - inicio da linha (1..Short.MAX_VALUE) inclusive

rowEnd - fim da linha (1..Short.MAX_VALUE) inclusive

Returns:

própria estrutura

hasMerge

public ExcelMerge hasMerge(int columnIndex,
                           int rowIndex)

Indica a ocorrencia de um merge na celula. Caso não haja, será retornado nulo.

Specified by:

hasMerge in interface ExcelStructureTool

Parameters:

columnIndex - coluna (1..Short.MAX_VALUE)

rowIndex - linha (1..Short.MAX_VALUE)

Returns:

estrutura de merge se existir ou nulo

mergeRow

public PoiExcelStructureTool mergeRow(int column,
                                      int rowBegin,
                                      int rowEnd)

Realiza um merge entre celulas delimitado por um intervalo de linhas e uma coluna.

Specified by:

mergeRow in interface ExcelStructureTool

Parameters:

column - coluna (1..Short.MAX_VALUE)

rowBegin - inicio da linha (1..Short.MAX_VALUE) inclusive

rowEnd - fim da linha (1..Short.MAX_VALUE) inclusive

Returns:

própria estrutura

mergeColumn

public PoiExcelStructureTool mergeColumn(int columnBegin,
                                         int columnEnd,
                                         int row)

Realiza um merge entre celulas delimitado por um intervalo de colunas e uma linha.

Specified by:

mergeColumn in interface ExcelStructureTool

Parameters:

columnBegin - inicio da coluna (1..Short.MAX_VALUE) inclusive

columnEnd - fim da coluna (1..Short.MAX_VALUE) inclusive

row - linha (1..Short.MAX_VALUE)

Returns:

própria estrutura

repeatLineMerge

public PoiExcelStructureTool repeatLineMerge(int... columns)

Realiza um merge entre celulas delimitado pelas linhas utilizadas anteriormente e um conjunto de colunas. Para cada coluna passada como parâmetro, será aplicado um merge com as linhas utilizadas anteriormente com a coluna corrente.

Specified by:

repeatLineMerge in interface ExcelStructureTool

Parameters:

columns - colunas (1..Short.MAX_VALUE)

Returns:

própria estrutura

repeatColumnMerge

public PoiExcelStructureTool repeatColumnMerge(int... rows)

Realiza um merge entre celulas delimitado pelas colunas utilizadas anteriormente e um conjunto de linhas. Para cada linha passada como parâmetro, será aplicado um merge com as colunas utilizadas anteriormente com a linha corrente.

Specified by:

repeatColumnMerge in interface ExcelStructureTool

Parameters:

rows - linha (1..Short.MAX_VALUE)

Returns:

própria estrutura this.helper = helper;

setColumnWidth

public ExcelStructureTool setColumnWidth(int column,
                                         int width)

Atribui uma espessura para a coluna na unidade Excel (in units of 1/256th of a character width)

Specified by:

setColumnWidth in interface ExcelStructureTool

Parameters:

column - coluna (1..Short.MAX_VALUE)

width - "in units of 1/256th of a character width"

Returns:

própria estrutura

getColumnWidth

public int getColumnWidth(int column)

Retorna o comprimento da coluna

Specified by:

getColumnWidth in interface ExcelStructureTool

Parameters:

column - coluna (1..Short.MAX_VALUE)

Returns:

comprimento da coluna

setRowHeight

public ExcelStructureTool setRowHeight(int row,
                                       int height)

Atribui uma altura de uma linha

Specified by:

setRowHeight in interface ExcelStructureTool

Parameters:

row - linha (1..Short.MAX_VALUE)

height - altura a ser atribuída

Returns:

própria estrutura

getHelper

public PoiExcelSheet getHelper()

Retorna o facilitador que constroi sheet.

Specified by:

getHelper in interface ExcelStructureTool

Returns:

facilitador de sheet

setColumn

public void setColumn(int columnBegin,
                      int columnEnd)

Atribui um intervalo de colunas corrente

Specified by:

setColumn in interface ExcelStructureTool

Parameters:

columnBegin - inicio da coluna (1..Short.MAX_VALUE)

columnEnd - fim da coluna (1..Short.MAX_VALUE)

setRow

public void setRow(int rowBegin,
                   int rowEnd)

Atribui um intervalo de linhas corrente

Specified by:

setRow in interface ExcelStructureTool

Parameters:

rowBegin - inicio da linha (1..Short.MAX_VALUE)

rowEnd - fim da linha (1..Short.MAX_VALUE)

getColumnBegin

public int getColumnBegin()

Retorna a coluna inicial corrente

Specified by:

getColumnBegin in interface ExcelStructureTool

Returns:

coluna inicial corrente

setColumnBegin

public void setColumnBegin(int columnBegin)

Atribui uma coluna inicial corrente

Specified by:

setColumnBegin in interface ExcelStructureTool

Parameters:

columnBegin - inicio da coluna (1..Short.MAX_VALUE)

getColumnEnd

public int getColumnEnd()

Retorna a coluna final corrente

Specified by:

getColumnEnd in interface ExcelStructureTool

Returns:

coluna final corrente

setColumnEnd

public void setColumnEnd(int columnEnd)

Atribui uma coluna final corrente

Specified by:

setColumnEnd in interface ExcelStructureTool

Parameters:

columnEnd - fim da coluna (1..Short.MAX_VALUE)

getRowBegin

public int getRowBegin()

Retorna a linha inicial corrente

Specified by:

getRowBegin in interface ExcelStructureTool

Returns:

linha inicial corrente

setRowBegin

public void setRowBegin(int rowBegin)

Atribui uma linha inicial corrente

Specified by:

setRowBegin in interface ExcelStructureTool

Parameters:

rowBegin - inicio da linha (1..Short.MAX_VALUE)

getRowEnd

public int getRowEnd()

Retorna a linha final corrente

Specified by:

getRowEnd in interface ExcelStructureTool

Returns:

linha final corrente

setRowEnd

public void setRowEnd(int rowEnd)

Atribui uma linha final corrente

Specified by:

setRowEnd in interface ExcelStructureTool

Parameters:

rowEnd - fim da linha (1..Short.MAX_VALUE)

toString

public String toString()

Overrides:

toString in class Object