io.github.antoniovizuete.pojospreadsheet.core

Class CellImpl

java.lang.Object

io.github.antoniovizuete.pojospreadsheet.core.CellImpl

All Implemented Interfaces:

Cell, Styleable<Cell>, IntegerIndex

public class CellImpl
extends Object
implements Cell

Prototype class that represents a POI Cell.

Cell class is a child of RowImpl

In order to customize the cell style of each cell, a cell has the same methods that CellStyle. More formally, Cell inherits from AbstractCellStyle.

Since:

0.1

Author:

Antonio Vizuete

Constructor Summary

Constructors

Constructor and Description
CellImpl(RowImpl row, Integer col)
CellImpl(RowImpl row, String col)

Method Summary

Modifier and Type	Method and Description
T	align(org.apache.poi.ss.usermodel.HorizontalAlignment align) Sets the align and return the current instance.
protected CellStyle	asCellStyle()
T	backgroundColor(ColorKey color) Sets the background color and return the current instance.
T	borderBottom(BorderKey borderBottom) Sets the border bottom and return the current instance.
T	borderLeft(BorderKey borderLeft) Sets the border left and return the current instance.
T	borderRight(BorderKey borderRight) Sets the border right and return the current instance.
T	borders(BorderKey border) Sets the borders and return the current instance.
T	borders(BorderKey border, BorderKey border2) Sets the borders and return the current instance.
T	borders(BorderKey border, BorderKey border2, BorderKey border3) Sets the borders and return the current instance.
T	borders(BorderKey border, BorderKey border2, BorderKey border3, BorderKey border4) Sets the borders and return the current instance.
T	borderTop(BorderKey borderTop) Sets the border top and return the current instance.
Cell	cellStyle(CellStyleKey cellStyle) Sets the style.
boolean	equals(Object o)
T	font(FontKey font) Sets the font and return the current instance.
T	format(FormatKey format) Sets the format and return the current instance.
CellAddress	getAddress() Gets address.
org.apache.poi.ss.usermodel.HorizontalAlignment	getAlign() Gets align.
ColorKey	getBackgroundColor() Gets background color.
BorderKey	getBorderBottom() Gets border bottom.
BorderKey	getBorderLeft() Gets border left.
BorderKey	getBorderRight() Gets border right.
BorderKey	getBorderTop() Gets border top.
CellStyleKey	getCellStyle() Gets cell style.
FontKey	getFont() Gets font.
FormatKey	getFormat() Gets format.
CellAddress	getHyperlink() Gets hyperlink.
Integer	getIndex() Gets index.
org.apache.poi.ss.usermodel.CellType	getType() Gets type.
Object	getValue() Gets value.
org.apache.poi.ss.usermodel.VerticalAlignment	getVerticalAlign() Gets vertical align.
int	hashCode()
Cell	hyperlink(CellAddressImpl hyperlink) Sets an internal link to the indicated cell.
Cell	hyperlink(String hyperlink) Sets an internal link to the indicated cell.
protected boolean	isSpecificStyleNull()
Cell	merge(int numCells) Merges the indicated number of Cells.
Cell	nextCell() Returns the next sibling Cell.
Row	nextRow() Returns the next sibling RowImpl.
Row	parentRow() Returns the RowImpl where the Cell is located.
Sheet	parentSheet() Returns the SheetImpl where the Cell is located.
Cell	prevCell() Returns the previous sibling Cell.
Row	prevRow() Returns the previous sibling RowImpl.
void	setAddress(CellAddress address)
void	setAlign(org.apache.poi.ss.usermodel.HorizontalAlignment align) Sets align.
void	setBackgroundColor(ColorKey backgroundColor) Sets background color.
void	setBorderBottom(BorderKey borderBottom) Sets border bottom.
void	setBorderLeft(BorderKey borderLeft) Sets border left.
void	setBorderRight(BorderKey borderRight) Sets border right.
void	setBorderTop(BorderKey borderTop) Sets border top.
void	setCellStyle(CellStyleKey cellStyle) Sets cell style.
void	setFont(FontKey font) Sets font.
void	setFormat(FormatKey format) Sets format.
void	setHyperlink(CellAddressImpl hyperlink) Sets hyperlink.
void	setIndex(Integer index) Sets index.
void	setInstance(T instance) Sets instance.
void	setType(org.apache.poi.ss.usermodel.CellType type) Sets type.
void	setValue(Object value) Sets value.
void	setVerticalAlign(org.apache.poi.ss.usermodel.VerticalAlignment verticalAlign) Sets vertical align.
String	toString()
Cell	value(Object value) Sets the content of the cell.
T	verticalAlign(org.apache.poi.ss.usermodel.VerticalAlignment verticalAlign) Sets the vertical align and return the current instance.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.github.antoniovizuete.pojospreadsheet.core.model.Styleable

align, backgroundColor, borderBottom, borderLeft, borderRight, borders, borders, borders, borders, borderTop, font, format, getAlign, getBackgroundColor, getBorderBottom, getBorderLeft, getBorderRight, getBorderTop, getFont, getFormat, getVerticalAlign, setAlign, setBackgroundColor, setBorderBottom, setBorderLeft, setBorderRight, setBorderTop, setFont, setFormat, setInstance, setVerticalAlign, verticalAlign

Constructor Detail

CellImpl

public CellImpl(RowImpl row,
                Integer col)

CellImpl

public CellImpl(RowImpl row,
                String col)

Method Detail

getIndex

public Integer getIndex()

Description copied from interface: IntegerIndex

Gets index.

Specified by:

getIndex in interface IntegerIndex

Returns:

the index

getAddress

public CellAddress getAddress()

Description copied from interface: Cell

Gets address.

Specified by:

getAddress in interface Cell

Returns:

the address

getType

public org.apache.poi.ss.usermodel.CellType getType()

Description copied from interface: Cell

Gets type.

Specified by:

getType in interface Cell

Returns:

the type

getCellStyle

public CellStyleKey getCellStyle()

Description copied from interface: Cell

Gets cell style.

Specified by:

getCellStyle in interface Cell

Returns:

the cell style

getValue

public Object getValue()

Description copied from interface: Cell

Gets value.

Specified by:

getValue in interface Cell

Returns:

the value

getHyperlink

public CellAddress getHyperlink()

Description copied from interface: Cell

Gets hyperlink.

Specified by:

getHyperlink in interface Cell

Returns:

the hyperlink

setIndex

public void setIndex(Integer index)

Description copied from interface: Cell

Sets index.

Specified by:

setIndex in interface Cell

Parameters:

index - the index

setType

public void setType(org.apache.poi.ss.usermodel.CellType type)

Description copied from interface: Cell

Sets type.

Specified by:

setType in interface Cell

Parameters:

type - the type

setCellStyle

public void setCellStyle(CellStyleKey cellStyle)

Description copied from interface: Cell

Sets cell style.

Specified by:

setCellStyle in interface Cell

Parameters:

cellStyle - the cell style

setValue

public void setValue(Object value)

Description copied from interface: Cell

Sets value.

Specified by:

setValue in interface Cell

Parameters:

value - the value

setHyperlink

public void setHyperlink(CellAddressImpl hyperlink)

Description copied from interface: Cell

Sets hyperlink.

Specified by:

setHyperlink in interface Cell

Parameters:

hyperlink - the hyperlink

setAddress

public void setAddress(CellAddress address)

cellStyle

public Cell cellStyle(CellStyleKey cellStyle)

Sets the style.

NOTE: Before use this method, you must declare and create the styles through SpreadsheetDecoration class.

Specified by:

cellStyle in interface Cell

Parameters:

cellStyle - to be set to the cell.

Returns:

the current instance.

value

public Cell value(Object value)

Sets the content of the cell.

Has a smart class selector. You can pass a String, Number or Date object and it selects the proper POI value type.

Specified by:

value in interface Cell

Parameters:

value - String, Number or Date

Returns:

the current instance.

hyperlink

public Cell hyperlink(String hyperlink)

Sets an internal link to the indicated cell.

Specified by:

hyperlink in interface Cell

Parameters:

hyperlink - Excel address format string (p.e. "Sheet1!A1").

Returns:

the current instance.

hyperlink

public Cell hyperlink(CellAddressImpl hyperlink)

Sets an internal link to the indicated cell.

Specified by:

hyperlink in interface Cell

Parameters:

hyperlink - to the CellAddressImpl.

Returns:

the current instance.

parentRow

public Row parentRow()

Returns the RowImpl where the Cell is located.

Specified by:

parentRow in interface Cell

Returns:

the RowImpl where the Cell is located.

parentSheet

public Sheet parentSheet()

Returns the SheetImpl where the Cell is located.

Specified by:

parentSheet in interface Cell

Returns:

the SheetImpl where the Cell is located.

nextCell

public Cell nextCell()

Returns the next sibling Cell.

Specified by:

nextCell in interface Cell

Returns:

the next sibling Cell.

prevCell

public Cell prevCell()

Returns the previous sibling Cell.

Specified by:

prevCell in interface Cell

Returns:

the previous sibling Cell.

Throws:

IllegalStateException - (optional) if you try get the previous Cell when you are located at the first Cell of the RowImpl.

nextRow

public Row nextRow()

Returns the next sibling RowImpl.

Specified by:

nextRow in interface Cell

Returns:

the next sibling RowImpl.

prevRow

public Row prevRow()

Returns the previous sibling RowImpl.

Specified by:

prevRow in interface Cell

Returns:

the previous sibling RowImpl.

Throws:

IllegalStateException - (optional) if you try get the previous RowImpl when you are located at the first RowImpl of the SheetImpl.

merge

public Cell merge(int numCells)

Merges the indicated number of Cells.

NOTE: the merged cells are located at the parent row of the current cell instance.

Specified by:

merge in interface Cell

Parameters:

numCells - number of cells to be merged.

Returns:

the current instance.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

hashCode

public int hashCode()

asCellStyle

protected CellStyle asCellStyle()

isSpecificStyleNull

protected boolean isSpecificStyleNull()

backgroundColor

public T backgroundColor(ColorKey color)

Description copied from interface: Styleable

Sets the background color and return the current instance.

Specified by:

backgroundColor in interface Styleable<T extends Styleable>

Parameters:

color - the color

Returns:

the instance

font

public T font(FontKey font)

Description copied from interface: Styleable

Sets the font and return the current instance.

Specified by:

font in interface Styleable<T extends Styleable>

Parameters:

font - the font

Returns:

the instance

align

public T align(org.apache.poi.ss.usermodel.HorizontalAlignment align)

Description copied from interface: Styleable

Sets the align and return the current instance.

Specified by:

align in interface Styleable<T extends Styleable>

Parameters:

align - the align

Returns:

the instance

verticalAlign

public T verticalAlign(org.apache.poi.ss.usermodel.VerticalAlignment verticalAlign)

Description copied from interface: Styleable

Sets the vertical align and return the current instance.

Specified by:

verticalAlign in interface Styleable<T extends Styleable>

Parameters:

verticalAlign - the vertical align

Returns:

the instance

format

public T format(FormatKey format)

Description copied from interface: Styleable

Sets the format and return the current instance.

Specified by:

format in interface Styleable<T extends Styleable>

Parameters:

format - the format

Returns:

the instance

borderTop

public T borderTop(BorderKey borderTop)

Description copied from interface: Styleable

Sets the border top and return the current instance.

Specified by:

borderTop in interface Styleable<T extends Styleable>

Parameters:

borderTop - the border top

Returns:

the instance

borderRight

public T borderRight(BorderKey borderRight)

Description copied from interface: Styleable

Sets the border right and return the current instance.

Specified by:

borderRight in interface Styleable<T extends Styleable>

Parameters:

borderRight - the border right

Returns:

the instance

borderBottom

public T borderBottom(BorderKey borderBottom)

Description copied from interface: Styleable

Sets the border bottom and return the current instance.

Specified by:

borderBottom in interface Styleable<T extends Styleable>

Parameters:

borderBottom - the border bottom

Returns:

the instance

borderLeft

public T borderLeft(BorderKey borderLeft)

Description copied from interface: Styleable

Sets the border left and return the current instance.

Specified by:

borderLeft in interface Styleable<T extends Styleable>

Parameters:

borderLeft - the border left

Returns:

the instance

borders

public T borders(BorderKey border)

Description copied from interface: Styleable

Sets the borders and return the current instance.

Specified by:

borders in interface Styleable<T extends Styleable>

Parameters:

border - the border

Returns:

the instance

borders

public T borders(BorderKey border,
                 BorderKey border2)

Description copied from interface: Styleable

Sets the borders and return the current instance.

Specified by:

borders in interface Styleable<T extends Styleable>

Parameters:

border - the border

border2 - the border 2

Returns:

the instance

borders

public T borders(BorderKey border,
                 BorderKey border2,
                 BorderKey border3)

Description copied from interface: Styleable

Sets the borders and return the current instance.

Specified by:

borders in interface Styleable<T extends Styleable>

Parameters:

border - the border

border2 - the border 2

border3 - the border 3

Returns:

the instance

borders

public T borders(BorderKey border,
                 BorderKey border2,
                 BorderKey border3,
                 BorderKey border4)

Description copied from interface: Styleable

Sets the borders and return the current instance.

Specified by:

borders in interface Styleable<T extends Styleable>

Parameters:

border - the border

border2 - the border 2

border3 - the border 3

border4 - the border 4

Returns:

the instance

getBackgroundColor

public ColorKey getBackgroundColor()

Description copied from interface: Styleable

Gets background color.

Specified by:

getBackgroundColor in interface Styleable<T extends Styleable>

Returns:

the background color

getFont

public FontKey getFont()

Description copied from interface: Styleable

Gets font.

Specified by:

getFont in interface Styleable<T extends Styleable>

Returns:

the font

getAlign

public org.apache.poi.ss.usermodel.HorizontalAlignment getAlign()

Description copied from interface: Styleable

Gets align.

Specified by:

getAlign in interface Styleable<T extends Styleable>

Returns:

the align

getVerticalAlign

public org.apache.poi.ss.usermodel.VerticalAlignment getVerticalAlign()

Description copied from interface: Styleable

Gets vertical align.

Specified by:

getVerticalAlign in interface Styleable<T extends Styleable>

Returns:

the vertical align

getFormat

public FormatKey getFormat()

Description copied from interface: Styleable

Gets format.

Specified by:

getFormat in interface Styleable<T extends Styleable>

Returns:

the format

getBorderTop

public BorderKey getBorderTop()

Description copied from interface: Styleable

Gets border top.

Specified by:

getBorderTop in interface Styleable<T extends Styleable>

Returns:

the border top

getBorderRight

public BorderKey getBorderRight()

Description copied from interface: Styleable

Gets border right.

Specified by:

getBorderRight in interface Styleable<T extends Styleable>

Returns:

the border right

getBorderBottom

public BorderKey getBorderBottom()

Description copied from interface: Styleable

Gets border bottom.

Specified by:

getBorderBottom in interface Styleable<T extends Styleable>

Returns:

the border bottom

getBorderLeft

public BorderKey getBorderLeft()

Description copied from interface: Styleable

Gets border left.

Specified by:

getBorderLeft in interface Styleable<T extends Styleable>

Returns:

the border left

setInstance

public void setInstance(T instance)

Description copied from interface: Styleable

Sets instance.

Specified by:

setInstance in interface Styleable<T extends Styleable>

Parameters:

instance - the instance

setBackgroundColor

public void setBackgroundColor(ColorKey backgroundColor)

Description copied from interface: Styleable

Sets background color.

Specified by:

setBackgroundColor in interface Styleable<T extends Styleable>

Parameters:

backgroundColor - the background color

setFont

public void setFont(FontKey font)

Description copied from interface: Styleable

Sets font.

Specified by:

setFont in interface Styleable<T extends Styleable>

Parameters:

font - the font

setAlign

public void setAlign(org.apache.poi.ss.usermodel.HorizontalAlignment align)

Description copied from interface: Styleable

Sets align.

Specified by:

setAlign in interface Styleable<T extends Styleable>

Parameters:

align - the align

setVerticalAlign

public void setVerticalAlign(org.apache.poi.ss.usermodel.VerticalAlignment verticalAlign)

Description copied from interface: Styleable

Sets vertical align.

Specified by:

setVerticalAlign in interface Styleable<T extends Styleable>

Parameters:

verticalAlign - the vertical align

setFormat

public void setFormat(FormatKey format)

Description copied from interface: Styleable

Sets format.

Specified by:

setFormat in interface Styleable<T extends Styleable>

Parameters:

format - the format

setBorderTop

public void setBorderTop(BorderKey borderTop)

Description copied from interface: Styleable

Sets border top.

Specified by:

setBorderTop in interface Styleable<T extends Styleable>

Parameters:

borderTop - the border top

setBorderRight

public void setBorderRight(BorderKey borderRight)

Description copied from interface: Styleable

Sets border right.

Specified by:

setBorderRight in interface Styleable<T extends Styleable>

Parameters:

borderRight - the border right

setBorderBottom

public void setBorderBottom(BorderKey borderBottom)

Description copied from interface: Styleable

Sets border bottom.

Specified by:

setBorderBottom in interface Styleable<T extends Styleable>

Parameters:

borderBottom - the border bottom

setBorderLeft

public void setBorderLeft(BorderKey borderLeft)

Description copied from interface: Styleable

Sets border left.

Specified by:

setBorderLeft in interface Styleable<T extends Styleable>

Parameters:

borderLeft - the border left