io.keikai.model

Interface SCellStyle

All Known Subinterfaces:

SConditionalStyle, SExtraStyle, SNamedStyle, STableStyleElem

All Known Implementing Classes:

AbstractCellStyleAdv, CellStyleImpl, ConditionalStyleImpl, ExtraStyleImpl, NamedStyleImpl, TableStyleElemImpl

public interface SCellStyle

Represent style information e.g. alignment, border, format pattern, font, color, fill pattern, wrap text, and hidden status. It may associate with a book or cells.

Since:

3.5.0

Author:

dennis

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SCellStyle.Alignment The horizontal alignment
static class	SCellStyle.VerticalAlignment The vertical alignment

Field Summary

Fields

Modifier and Type	Field and Description
static String	FORMAT_GENERAL

Method Summary

Modifier and Type	Method and Description
void	copyFrom(SCellStyle src)
SCellStyle.Alignment	getAlignment() Gets the horizontal alignment
SColor	getBackColor()
SBorder	getBorder() Returns the border
SBorder.BorderType	getBorderBottom()
SColor	getBorderBottomColor()
SBorder.BorderType	getBorderDiagonal()
SColor	getBorderDiagonalColor()
SBorder.BorderType	getBorderHorizontal()
SColor	getBorderHorizontalColor()
SBorder.BorderType	getBorderLeft()
SColor	getBorderLeftColor()
SBorder.BorderType	getBorderRight()
SColor	getBorderRightColor()
SBorder.BorderType	getBorderTop()
SColor	getBorderTopColor()
SBorder.BorderType	getBorderVertical()
SColor	getBorderVerticalColor()
String	getDataFormat()
SFill	getFill() Returns the fill
SColor	getFillColor()
SFill.FillPattern	getFillPattern() Gets the fill/background pattern
SFont	getFont()
int	getIndention()
int	getRotation() get the degree of rotation for the text in the cell
SCellStyle.VerticalAlignment	getVerticalAlignment() Gets vertical alignment
boolean	isDirectDataFormat()
boolean	isHidden()
boolean	isLocked()
boolean	isShowDiagonalDownBorder()
boolean	isShowDiagonalUpBorder()
boolean	isWrapText()
void	setAlignment(SCellStyle.Alignment alignment)
void	setBackColor(SColor backColor)
void	setBackgroundColor(SColor backColor) Deprecated.
void	setBorderBottom(SBorder.BorderType borderBottom)
void	setBorderBottom(SBorder.BorderType borderBottom, SColor color)
void	setBorderBottomColor(SColor borderBottomColor)
void	setBorderDiagonal(SBorder.BorderType borderDiagonal)
void	setBorderDiagonal(SBorder.BorderType borderDiagonal, SColor color)
void	setBorderDiagonalColor(SColor color)
void	setBorderHorizontal(SBorder.BorderType borderHorizontal)
void	setBorderHorizontal(SBorder.BorderType borderHorizontal, SColor color)
void	setBorderHorizontalColor(SColor color)
void	setBorderLeft(SBorder.BorderType borderLeft)
void	setBorderLeft(SBorder.BorderType borderLeft, SColor color)
void	setBorderLeftColor(SColor borderLeftColor)
void	setBorderRight(SBorder.BorderType borderRight)
void	setBorderRight(SBorder.BorderType borderRight, SColor color)
void	setBorderRightColor(SColor borderRightColor)
void	setBorderTop(SBorder.BorderType borderTop)
void	setBorderTop(SBorder.BorderType borderTop, SColor color)
void	setBorderTopColor(SColor borderTopColor)
void	setBorderVertical(SBorder.BorderType borderVertical)
void	setBorderVertical(SBorder.BorderType borderVertical, SColor color)
void	setBorderVerticalColor(SColor color)
void	setDataFormat(String dataFormat)
void	setDirectDataFormat(String dataFormat)
void	setFillColor(SColor fillColor)
void	setFillPattern(SFill.FillPattern fillPattern)
void	setFont(SFont font)
void	setHidden(boolean hidden)
void	setIndention(int indent)
void	setLocked(boolean locked)
void	setRotation(int rotation)
void	setVerticalAlignment(SCellStyle.VerticalAlignment verticalAlignment)
void	setWrapText(boolean wrapText)

Field Detail

FORMAT_GENERAL

static final String FORMAT_GENERAL

See Also:

Constant Field Values

Method Detail

getFillColor

SColor getFillColor()

Returns:

fill foreground-color

getBackColor

SColor getBackColor()

Returns:

fill background-color

Since:

3.6.0

getFillPattern

SFill.FillPattern getFillPattern()

Gets the fill/background pattern

Returns:

the fill pattern

getAlignment

SCellStyle.Alignment getAlignment()

Gets the horizontal alignment

Returns:

the horizontal alignment

getVerticalAlignment

SCellStyle.VerticalAlignment getVerticalAlignment()

Gets vertical alignment

Returns:

isWrapText

boolean isWrapText()

Returns:

true if wrap-text

getBorderLeft

SBorder.BorderType getBorderLeft()

Returns:

left border

getBorderTop

SBorder.BorderType getBorderTop()

Returns:

top border

getBorderRight

SBorder.BorderType getBorderRight()

Returns:

right border

getBorderBottom

SBorder.BorderType getBorderBottom()

Returns:

bottom border

getBorderVertical

SBorder.BorderType getBorderVertical()

Returns:

vertical border

Since:

3.8.0

getBorderHorizontal

SBorder.BorderType getBorderHorizontal()

Returns:

horizontal border

Since:

3.8.0

getBorderDiagonal

SBorder.BorderType getBorderDiagonal()

Returns:

diagonal border

Since:

3.8.0

getBorderTopColor

SColor getBorderTopColor()

Returns:

top border color

getBorderLeftColor

SColor getBorderLeftColor()

Returns:

left border color

getBorderBottomColor

SColor getBorderBottomColor()

Returns:

bottom border color

getBorderRightColor

SColor getBorderRightColor()

Returns:

right border color

getBorderVerticalColor

SColor getBorderVerticalColor()

Returns:

vertical border color

Since:

3.8.0

getBorderHorizontalColor

SColor getBorderHorizontalColor()

Returns:

horizontal border color

Since:

3.8.0

getBorderDiagonalColor

SColor getBorderDiagonalColor()

Returns:

diagonal border color

Since:

3.8.0

getDataFormat

String getDataFormat()

Returns:

data format

isDirectDataFormat

boolean isDirectDataFormat()

Returns:

true if the data format is direct data format, which mean it will not care Locale when formatting

isLocked

boolean isLocked()

Returns:

true if locked

isHidden

boolean isHidden()

Returns:

true if hidden

setFillColor

void setFillColor(SColor fillColor)

setBackgroundColor

@Deprecated
void setBackgroundColor(SColor backColor)

Deprecated.

setBackColor

void setBackColor(SColor backColor)

setFillPattern

void setFillPattern(SFill.FillPattern fillPattern)

setAlignment

void setAlignment(SCellStyle.Alignment alignment)

setVerticalAlignment

void setVerticalAlignment(SCellStyle.VerticalAlignment verticalAlignment)

setWrapText

void setWrapText(boolean wrapText)

setBorderLeft

void setBorderLeft(SBorder.BorderType borderLeft)

setBorderLeft

void setBorderLeft(SBorder.BorderType borderLeft,
                   SColor color)

setBorderTop

void setBorderTop(SBorder.BorderType borderTop)

setBorderTop

void setBorderTop(SBorder.BorderType borderTop,
                  SColor color)

setBorderRight

void setBorderRight(SBorder.BorderType borderRight)

setBorderRight

void setBorderRight(SBorder.BorderType borderRight,
                    SColor color)

setBorderBottom

void setBorderBottom(SBorder.BorderType borderBottom)

setBorderBottom

void setBorderBottom(SBorder.BorderType borderBottom,
                     SColor color)

setBorderVertical

void setBorderVertical(SBorder.BorderType borderVertical)

setBorderVertical

void setBorderVertical(SBorder.BorderType borderVertical,
                       SColor color)

setBorderHorizontal

void setBorderHorizontal(SBorder.BorderType borderHorizontal)

setBorderHorizontal

void setBorderHorizontal(SBorder.BorderType borderHorizontal,
                         SColor color)

setBorderDiagonal

void setBorderDiagonal(SBorder.BorderType borderDiagonal)

setBorderDiagonal

void setBorderDiagonal(SBorder.BorderType borderDiagonal,
                       SColor color)

setBorderTopColor

void setBorderTopColor(SColor borderTopColor)

setBorderLeftColor

void setBorderLeftColor(SColor borderLeftColor)

setBorderBottomColor

void setBorderBottomColor(SColor borderBottomColor)

setBorderRightColor

void setBorderRightColor(SColor borderRightColor)

setBorderVerticalColor

void setBorderVerticalColor(SColor color)

setBorderHorizontalColor

void setBorderHorizontalColor(SColor color)

setBorderDiagonalColor

void setBorderDiagonalColor(SColor color)

setDataFormat

void setDataFormat(String dataFormat)

setDirectDataFormat

void setDirectDataFormat(String dataFormat)

setLocked

void setLocked(boolean locked)

setHidden

void setHidden(boolean hidden)

getFont

SFont getFont()

setFont

void setFont(SFont font)

copyFrom

void copyFrom(SCellStyle src)

getRotation

int getRotation()

get the degree of rotation for the text in the cell

Returns:

rotation degrees (between -90 and 90 degrees); 255 means "vertical text"

Since:

3.8.0

setRotation

void setRotation(int rotation)

getIndention

int getIndention()

setIndention

void setIndention(int indent)

getBorder

SBorder getBorder()

Returns the border

Returns:

Since:

3.8.0

getFill

SFill getFill()

Returns the fill

Returns:

Since:

3.8.0

isShowDiagonalUpBorder

boolean isShowDiagonalUpBorder()

Returns:

Since:

3.8.2

isShowDiagonalDownBorder

boolean isShowDiagonalDownBorder()

Returns:

Since:

3.8.2