io.github.antoniovizuete.pojospreadsheet.core.model

Interface Sheet

All Superinterfaces:

IntegerIndex

All Known Implementing Classes:

SheetImpl

public interface Sheet
extends IntegerIndex

The interface Sheet.

Since:

0.1

Author:

Antonio Vizuete

Method Summary

Modifier and Type	Method and Description
Sheet	addImage(CellAddress address, String resourcePath) Add image sheet.
Sheet	addImage(Image image) Add image sheet.
Sheet	alias(String alias) Deprecated.
Sheet	autoSize(Boolean autoSize) Auto size sheet.
Sheet	createTextBox(CellRegion region, String content) Create text box sheet.
Sheet	createTextBox(TextBox textBox) Create text box sheet.
Sheet	filterRegion(CellRegion region) Filter region sheet.
String	getAlias() Gets alias.
Boolean	getAutoSize() Gets auto size.
CellRegion	getFilterRange() Gets filter range.
List<Image>	getImages() Gets images.
Map<String,CellRegion>	getMergedCells() Gets merged cells.
String	getName() Gets name.
PrintSetup	getPrintSetup() Gets print setup.
List<TextBox>	getTextBoxes() Gets text boxes.
Sheet	mergeCell(int rowIndex, int columnIndex, int numCells) Merge cell sheet.
Sheet	mergeCell(Row row, Cell cell, int numCells) Merge cell sheet.
Sheet	mergeRegion(CellRegion region) Merge region sheet.
Sheet	mergeRegion(String region) Merge region sheet.
Sheet	mergeRow(int rowIndex, int columnIndex, int numRows) Merge row sheet.
Sheet	mergeRow(Row row, Cell cell, int numRows) Merge row sheet.
Sheet	name(String name) Name sheet.
Row	row() Row row.
Row	row(Integer index) Row row.
Set<Row>	rows() Rows set.
void	setAlias(String alias) Sets alias.
void	setAutoSize(Boolean autoSize) Sets auto size.
void	setFilterRange(CellRegion filterRange) Sets filter range.
void	setImages(List<Image> images) Sets images.
void	setIndex(Integer index) Sets index.
void	setMergedCells(Map<String,CellRegion> mergedCells) Sets merged cells.
void	setName(String name) Sets name.
void	setPrintSetup(PrintSetup printSetup) Sets print setup.
void	setTextBoxes(List<TextBox> textBoxes) Sets text boxes.

Methods inherited from interface io.github.antoniovizuete.pojospreadsheet.utils.iterator.IntegerIndex

getIndex

Method Detail

setIndex

void setIndex(Integer index)

Sets index.

Parameters:

index - the index

getAutoSize

Boolean getAutoSize()

Gets auto size.

Returns:

the auto size

setAutoSize

void setAutoSize(Boolean autoSize)

Sets auto size.

Parameters:

autoSize - the auto size

getPrintSetup

PrintSetup getPrintSetup()

Gets print setup.

Returns:

the print setup

setPrintSetup

void setPrintSetup(PrintSetup printSetup)

Sets print setup.

Parameters:

printSetup - the print setup

getFilterRange

CellRegion getFilterRange()

Gets filter range.

Returns:

the filter range

setFilterRange

void setFilterRange(CellRegion filterRange)

Sets filter range.

Parameters:

filterRange - the filter range

getName

String getName()

Gets name.

Returns:

the name

setName

void setName(String name)

Sets name.

Parameters:

name - the name

getAlias

String getAlias()

Gets alias.

Returns:

the alias

setAlias

void setAlias(String alias)

Sets alias.

Parameters:

alias - the alias

getImages

List<Image> getImages()

Gets images.

Returns:

the images

setImages

void setImages(List<Image> images)

Sets images.

Parameters:

images - the images

getTextBoxes

List<TextBox> getTextBoxes()

Gets text boxes.

Returns:

the text boxes

setTextBoxes

void setTextBoxes(List<TextBox> textBoxes)

Sets text boxes.

Parameters:

textBoxes - the text boxes

getMergedCells

Map<String,CellRegion> getMergedCells()

Gets merged cells.

Returns:

the merged cells

setMergedCells

void setMergedCells(Map<String,CellRegion> mergedCells)

Sets merged cells.

Parameters:

mergedCells - the merged cells

rows

Set<Row> rows()

Rows set.

Returns:

the set

row

Row row()

Row row.

Returns:

the row

row

Row row(Integer index)

Row row.

Parameters:

index - the index

Returns:

the row

name

Sheet name(String name)

Name sheet.

Parameters:

name - the name

Returns:

the sheet

alias

@Deprecated
Sheet alias(String alias)

Deprecated.

Alias sheet.

Parameters:

alias - the alias

Returns:

the sheet

autoSize

Sheet autoSize(Boolean autoSize)

Auto size sheet.

Parameters:

autoSize - the auto size

Returns:

the sheet

filterRegion

Sheet filterRegion(CellRegion region)

Filter region sheet.

Parameters:

region - the region

Returns:

the sheet

addImage

Sheet addImage(Image image)

Add image sheet.

Parameters:

image - the image

Returns:

the sheet

addImage

Sheet addImage(CellAddress address,
               String resourcePath)

Add image sheet.

Parameters:

address - the address

resourcePath - the resource path

Returns:

the sheet

createTextBox

Sheet createTextBox(TextBox textBox)

Create text box sheet.

Parameters:

textBox - the text box

Returns:

the sheet

createTextBox

Sheet createTextBox(CellRegion region,
                    String content)

Create text box sheet.

Parameters:

region - the region

content - the content

Returns:

the sheet

mergeCell

Sheet mergeCell(int rowIndex,
                int columnIndex,
                int numCells)

Merge cell sheet.

Parameters:

rowIndex - the row index

columnIndex - the column index

numCells - the num cells

Returns:

the sheet

mergeCell

Sheet mergeCell(Row row,
                Cell cell,
                int numCells)

Merge cell sheet.

Parameters:

row - the row

cell - the cell

numCells - the num cells

Returns:

the sheet

mergeRow

Sheet mergeRow(int rowIndex,
               int columnIndex,
               int numRows)

Merge row sheet.

Parameters:

rowIndex - the row index

columnIndex - the column index

numRows - the num cells

Returns:

the sheet

mergeRow

Sheet mergeRow(Row row,
               Cell cell,
               int numRows)

Merge row sheet.

Parameters:

row - the row

cell - the cell

numRows - the num cells

Returns:

the sheet

mergeRegion

Sheet mergeRegion(String region)

Merge region sheet.

Parameters:

region - the region

Returns:

the sheet

mergeRegion

Sheet mergeRegion(CellRegion region)

Merge region sheet.

Parameters:

region - the region

Returns:

the sheet