io.github.antoniovizuete.pojospreadsheet.core

Class SheetImpl

java.lang.Object

io.github.antoniovizuete.pojospreadsheet.utils.iterator.AbstractIntegerSet<Row>

io.github.antoniovizuete.pojospreadsheet.core.SheetImpl

All Implemented Interfaces:

Sheet, IntegerIndex, IntegerSet<Row>

public class SheetImpl
extends AbstractIntegerSet<Row>
implements Sheet

Prototype class that represents a POI Sheet.

Has a collection of RowImpl.

Has a collection of Image.

Has a collection of TextBoxImpl.

Since:

0.1

Author:

Antonio Vizuete

Field Summary

Fields inherited from class io.github.antoniovizuete.pojospreadsheet.utils.iterator.AbstractIntegerSet

set

Constructor Summary

Constructors

Constructor and Description
SheetImpl(Integer index)

Method Summary

Modifier and Type	Method and Description
Sheet	addImage(CellAddress address, String resourcePath) Creates an Image from the resourcePath and places it at the indicated address.
Sheet	addImage(Image image) Adds the passed Image to the sheet.
Sheet	alias(String alias) Deprecated.
Sheet	autoSize(Boolean autoSize) Sets auto-size flag.
Row	createItem(Integer index) Internal purpose method.
Sheet	createTextBox(CellRegion region, String content) Creates an TextBoxImpl places it into the indicated region and sets its value.
Sheet	createTextBox(TextBox textBox) Adds the passed TextBoxImpl to the sheet.
Sheet	filterRegion(CellRegion region) Sets the filter on indicated region.
String	getAlias() Gets alias.
Boolean	getAutoSize() Gets auto size.
CellRegion	getFilterRange() Gets filter range.
List<Image>	getImages() Gets images.
Integer	getIndex() Gets index.
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) Merges the indicated cells.
Sheet	mergeCell(Row row, Cell cell, int numCells) Merges the indicated cells.
Sheet	mergeRegion(CellRegion region) Merges the indicated CellRegionImpl
Sheet	mergeRegion(String region) Merges the indicated CellRegionImpl
Sheet	mergeRow(int rowIndex, int columnIndex, int numRows) Merges the indicated rows.
Sheet	mergeRow(Row row, Cell cell, int numRows) Merges the indicated rows.
Sheet	name(String name) Sets the sheet's name.
Row	row() Returns new RowImpl instance.
Row	row(Integer index) Returns the RowImpl located into indicated index.
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 class io.github.antoniovizuete.pojospreadsheet.utils.iterator.AbstractIntegerSet

add, add, get, getMaxIndex

Methods inherited from class java.lang.Object

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

Constructor Detail

SheetImpl

public SheetImpl(Integer index)

Method Detail

getIndex

public Integer getIndex()

Description copied from interface: IntegerIndex

Gets index.

Specified by:

getIndex in interface IntegerIndex

Returns:

the index

setIndex

public void setIndex(Integer index)

Description copied from interface: Sheet

Sets index.

Specified by:

setIndex in interface Sheet

Parameters:

index - the index

getAutoSize

public Boolean getAutoSize()

Description copied from interface: Sheet

Gets auto size.

Specified by:

getAutoSize in interface Sheet

Returns:

the auto size

setAutoSize

public void setAutoSize(Boolean autoSize)

Description copied from interface: Sheet

Sets auto size.

Specified by:

setAutoSize in interface Sheet

Parameters:

autoSize - the auto size

getPrintSetup

public PrintSetup getPrintSetup()

Description copied from interface: Sheet

Gets print setup.

Specified by:

getPrintSetup in interface Sheet

Returns:

the print setup

setPrintSetup

public void setPrintSetup(PrintSetup printSetup)

Description copied from interface: Sheet

Sets print setup.

Specified by:

setPrintSetup in interface Sheet

Parameters:

printSetup - the print setup

getFilterRange

public CellRegion getFilterRange()

Description copied from interface: Sheet

Gets filter range.

Specified by:

getFilterRange in interface Sheet

Returns:

the filter range

setFilterRange

public void setFilterRange(CellRegion filterRange)

Description copied from interface: Sheet

Sets filter range.

Specified by:

setFilterRange in interface Sheet

Parameters:

filterRange - the filter range

getName

public String getName()

Description copied from interface: Sheet

Gets name.

Specified by:

getName in interface Sheet

Returns:

the name

setName

public void setName(String name)

Description copied from interface: Sheet

Sets name.

Specified by:

setName in interface Sheet

Parameters:

name - the name

getAlias

public String getAlias()

Description copied from interface: Sheet

Gets alias.

Specified by:

getAlias in interface Sheet

Returns:

the alias

setAlias

public void setAlias(String alias)

Description copied from interface: Sheet

Sets alias.

Specified by:

setAlias in interface Sheet

Parameters:

alias - the alias

getImages

public List<Image> getImages()

Description copied from interface: Sheet

Gets images.

Specified by:

getImages in interface Sheet

Returns:

the images

setImages

public void setImages(List<Image> images)

Description copied from interface: Sheet

Sets images.

Specified by:

setImages in interface Sheet

Parameters:

images - the images

getTextBoxes

public List<TextBox> getTextBoxes()

Description copied from interface: Sheet

Gets text boxes.

Specified by:

getTextBoxes in interface Sheet

Returns:

the text boxes

setTextBoxes

public void setTextBoxes(List<TextBox> textBoxes)

Description copied from interface: Sheet

Sets text boxes.

Specified by:

setTextBoxes in interface Sheet

Parameters:

textBoxes - the text boxes

getMergedCells

public Map<String,CellRegion> getMergedCells()

Description copied from interface: Sheet

Gets merged cells.

Specified by:

getMergedCells in interface Sheet

Returns:

the merged cells

setMergedCells

public void setMergedCells(Map<String,CellRegion> mergedCells)

Description copied from interface: Sheet

Sets merged cells.

Specified by:

setMergedCells in interface Sheet

Parameters:

mergedCells - the merged cells

rows

public Set<Row> rows()

Description copied from interface: Sheet

Rows set.

Specified by:

rows in interface Sheet

Returns:

the set

createItem

public Row createItem(Integer index)

Internal purpose method.

Returns a new instance of a RowImpl placed into indicated row index.

Specified by:

createItem in interface IntegerSet<Row>

Parameters:

index - where the new RowImpl will be placed.

Returns:

a new instance of RowImpl.

row

public Row row()

Returns new RowImpl instance.

Specified by:

row in interface Sheet

Returns:

new RowImpl instance.

row

public Row row(Integer index)

Returns the RowImpl located into indicated index.

If not exist the referenced row, the method returns to a new row instance placed there.

Specified by:

row in interface Sheet

Parameters:

index - of row.

Returns:

RowImpl

name

public Sheet name(String name)

Sets the sheet's name.

Specified by:

name in interface Sheet

Parameters:

name - of the sheet.

Returns:

the current instance.

alias

@Deprecated
public Sheet alias(String alias)

Deprecated.

Sets the sheet's alias.

NOTE: Method inherited from older versions.

Specified by:

alias in interface Sheet

Parameters:

alias - of the sheet.

Returns:

the current instance.

autoSize

public Sheet autoSize(Boolean autoSize)

Sets auto-size flag.

If true (default value) the columns auto-fit to the maximum width.

Specified by:

autoSize in interface Sheet

Parameters:

autoSize - flag

Returns:

the current instance.

filterRegion

public Sheet filterRegion(CellRegion region)

Sets the filter on indicated region.

Specified by:

filterRegion in interface Sheet

Parameters:

region - where the filter will be set

Returns:

the current instance.

addImage

public Sheet addImage(Image image)

Adds the passed Image to the sheet.

Specified by:

addImage in interface Sheet

Parameters:

image - the image

Returns:

the current instance.

addImage

public Sheet addImage(CellAddress address,
                      String resourcePath)

Creates an Image from the resourcePath and places it at the indicated address.

Specified by:

addImage in interface Sheet

Parameters:

address - will be placed the image.

resourcePath - where the image file is located.

Returns:

the current instance.

createTextBox

public Sheet createTextBox(TextBox textBox)

Adds the passed TextBoxImpl to the sheet.

Specified by:

createTextBox in interface Sheet

Parameters:

textBox - the text box

Returns:

the current instance.

createTextBox

public Sheet createTextBox(CellRegion region,
                           String content)

Creates an TextBoxImpl places it into the indicated region and sets its value.

Specified by:

createTextBox in interface Sheet

Parameters:

region - will be placed the TextBox.

content - of TextBox.

Returns:

the current instance.

mergeCell

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

Merges the indicated cells.

Specified by:

mergeCell in interface Sheet

Parameters:

rowIndex - the index of row

columnIndex - the index of column

numCells - the number of cells to be merged

Returns:

the current instance.

mergeCell

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

Merges the indicated cells.

Specified by:

mergeCell in interface Sheet

Parameters:

row - the row

cell - the cell

numCells - the number of cells to be merged

Returns:

the current instance.

mergeRow

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

Merges the indicated rows.

Specified by:

mergeRow in interface Sheet

Parameters:

rowIndex - the index of row

columnIndex - the index of column

numRows - the number of rows to be merged

Returns:

the current instance.

mergeRow

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

Merges the indicated rows.

Specified by:

mergeRow in interface Sheet

Parameters:

row - the row

cell - the cell

numRows - the number of rows to be merged

Returns:

the current instance.

mergeRegion

public Sheet mergeRegion(String region)

Merges the indicated CellRegionImpl

Specified by:

mergeRegion in interface Sheet

Parameters:

region - Excel format String.

Returns:

the current instance.

mergeRegion

public Sheet mergeRegion(CellRegion region)

Merges the indicated CellRegionImpl

Specified by:

mergeRegion in interface Sheet

Parameters:

region - the region

Returns:

the current instance.