tecgraf.javautils.excel.v1
Interface ExcelStructureTool

All Superinterfaces:

ExcelTool

All Known Implementing Classes:

PoiExcelStructureTool

public interface ExcelStructureTool
extends ExcelTool

Interface responsável pelos Merges das celulas

Author:

Tecgraf

Method Summary

int	getColumnBegin() Retorna a coluna inicial corrente
int	getColumnEnd() Retorna a coluna final corrente
int	getColumnWidth(int column) Retorna o comprimento da coluna
ExcelSheet	getHelper() Retorna o facilitador que constroi sheet.
int	getRowBegin() Retorna a linha inicial corrente
int	getRowEnd() Retorna a linha final corrente
ExcelMerge	hasMerge(int column, int row) Indica a ocorrencia de um merge na celula.
ExcelStructureTool	merge(int columnBegin, int columnEnd, int rowBegin, int rowEnd) Realiza um merge entre celulas delimitado por um intervalo de linhas e colunas.
ExcelStructureTool	mergeColumn(int columnBegin, int columnEnd, int row) Realiza um merge entre celulas delimitado por um intervalo de colunas e uma linha.
ExcelStructureTool	mergeRow(int column, int rowBegin, int rowEnd) Realiza um merge entre celulas delimitado por um intervalo de linhas e uma coluna.
ExcelStructureTool	repeatColumnMerge(int... rows) Realiza um merge entre celulas delimitado pelas colunas utilizadas anteriormente e um conjunto de linhas.
ExcelStructureTool	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 width) Atribui uma altura de uma linha

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

getSheet

Method Detail

merge

ExcelStructureTool merge(int columnBegin,
                         int columnEnd,
                         int rowBegin,
                         int rowEnd)

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

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

mergeRow

ExcelStructureTool mergeRow(int column,
                            int rowBegin,
                            int rowEnd)

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

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

ExcelStructureTool mergeColumn(int columnBegin,
                               int columnEnd,
                               int row)

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

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

ExcelStructureTool 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.

Parameters:

columns - colunas (1..Short.MAX_VALUE)

Returns:

própria estrutura

repeatColumnMerge

ExcelStructureTool 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.

Parameters:

rows - linha (1..Short.MAX_VALUE)

Returns:

própria estrutura this.helper = helper;

setColumnWidth

ExcelStructureTool setColumnWidth(int column,
                                  int width)

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

Parameters:

column - coluna (1..Short.MAX_VALUE)

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

Returns:

própria estrutura

getColumnWidth

int getColumnWidth(int column)

Retorna o comprimento da coluna

Parameters:

column - coluna (1..Short.MAX_VALUE)

Returns:

comprimento da coluna

setRowHeight

ExcelStructureTool setRowHeight(int row,
                                int width)

Atribui uma altura de uma linha

Parameters:

row - linha (1..Short.MAX_VALUE)

width - altura a ser atribuída

Returns:

própria estrutura

hasMerge

ExcelMerge hasMerge(int column,
                    int row)

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

Parameters:

column - coluna (1..Short.MAX_VALUE)

row - linha (1..Short.MAX_VALUE)

Returns:

estrutura de merge se existir ou nulo

getHelper

ExcelSheet getHelper()

Retorna o facilitador que constroi sheet.

Returns:

facilitador de sheet

setColumn

void setColumn(int columnBegin,
               int columnEnd)

Atribui um intervalo de colunas corrente

Parameters:

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

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

setRow

void setRow(int rowBegin,
            int rowEnd)

Atribui um intervalo de linhas corrente

Parameters:

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

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

getColumnBegin

int getColumnBegin()

Retorna a coluna inicial corrente

Returns:

coluna inicial corrente

setColumnBegin

void setColumnBegin(int columnBegin)

Atribui uma coluna inicial corrente

Parameters:

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

getColumnEnd

int getColumnEnd()

Retorna a coluna final corrente

Returns:

coluna final corrente

setColumnEnd

void setColumnEnd(int columnEnd)

Atribui uma coluna final corrente

Parameters:

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

getRowBegin

int getRowBegin()

Retorna a linha inicial corrente

Returns:

linha inicial corrente

setRowBegin

void setRowBegin(int rowBegin)

Atribui uma linha inicial corrente

Parameters:

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

getRowEnd

int getRowEnd()

Retorna a linha final corrente

Returns:

linha final corrente

setRowEnd

void setRowEnd(int rowEnd)

Atribui uma linha final corrente

Parameters:

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