io.keikai.client.api

Interface CellStyle

public interface CellStyle

The CellStyle object contains all style attributes (font, number format, alignment, and so on) as properties. There are several built-in styles, including Normal, Currency, and Percent. Using the Style object is a fast and efficient way to change several cell-formatting properties on multiple cells at the same time.

To apply the style to a range, you have to invoke Range#applyCellStyle(CellStyle) to trigger the UI client to change the styling. Otherwise, all the changes will be queued in this object only.

Author:

jumperchen

Method Summary

Modifier and Type	Method and Description
Alignment	createAlignment() Creates a alignment.
Border	createBorder() Creates a border
Borders	createBorders() Creates a borders collection with four borders.(Borders.BorderIndex.EdgeLeft, Borders.BorderIndex.EdgeTop, and Borders.BorderIndex.EdgeBottom, Borders.BorderIndex.EdgeRight)
Font	createFont() Creates a font.
NumberFormat	createNumberFormat() Creates a number format
Fill.PatternFill	createPatternFill() Creates a pattern fill.
Protection	createProtection() Creates a protection
Alignment	getAlignment() Returns the alignment
Border	getBorder(Borders.BorderIndex borderIndex) Returns the single border from the given border index.
Borders	getBorders() Returns the borders collection.
Fill	getFill() Returns the fill
Font	getFont() Returns the font
NumberFormat	getNumberFormat() Returns the number format.
Protection	getProtection() Returns the protection.
void	setAlignment(Alignment alignment) Sets the alignment
void	setBorder(Borders.BorderIndex borderIndex, Border border) Sets the single border with the given border index
void	setBorders(Borders borders) Sets the borders collection, this will replace the existing borders, if any.
void	setFill(Fill fill) Sets the fill
void	setFont(Font font) Sets the font
void	setNumberFormat(NumberFormat numberFormat) Sets the number format.
void	setPivotButton(boolean enable) Sets to enable or disable the pivot button
void	setProtection(Protection protection) Sets the protection.
void	setQuotePrefix(boolean enable) Sets to enable or disable the quote prefix.

Method Detail

createFont

Font createFont()

Creates a font.

createPatternFill

Fill.PatternFill createPatternFill()

Creates a pattern fill.

createAlignment

Alignment createAlignment()

Creates a alignment.

createBorder

Border createBorder()

Creates a border

createBorders

Borders createBorders()

Creates a borders collection with four borders.(Borders.BorderIndex.EdgeLeft, Borders.BorderIndex.EdgeTop, and Borders.BorderIndex.EdgeBottom, Borders.BorderIndex.EdgeRight)

createNumberFormat

NumberFormat createNumberFormat()

Creates a number format

createProtection

Protection createProtection()

Creates a protection

setQuotePrefix

void setQuotePrefix(boolean enable)

Sets to enable or disable the quote prefix.

Parameters:

enable -

setPivotButton

void setPivotButton(boolean enable)

Sets to enable or disable the pivot button

Parameters:

enable -

setFont

void setFont(Font font)

Sets the font

Parameters:

font -

setFill

void setFill(Fill fill)

Sets the fill

Parameters:

fill -

setAlignment

void setAlignment(Alignment alignment)

Sets the alignment

Parameters:

alignment -

setBorder

void setBorder(Borders.BorderIndex borderIndex,
               Border border)

Sets the single border with the given border index

Parameters:

borderIndex - either Borders.BorderIndex.EdgeLeft, Borders.BorderIndex.EdgeTop, Borders.BorderIndex.EdgeBottom, Borders.BorderIndex.EdgeRight, Borders.BorderIndex.DiagonalDown, Borders.BorderIndex.DiagonalUp, Borders.BorderIndex.InsideVertical, or Borders.BorderIndex.InsideHorizontal

border -

setBorders

void setBorders(Borders borders)

Sets the borders collection, this will replace the existing borders, if any.

Parameters:

borders -

setNumberFormat

void setNumberFormat(NumberFormat numberFormat)

Sets the number format.

Parameters:

numberFormat -

setProtection

void setProtection(Protection protection)

Sets the protection.

getFont

Font getFont()

Returns the font

Returns:

null if not existing.

getFill

Fill getFill()

Returns the fill

Returns:

null if not existing.

getAlignment

Alignment getAlignment()

Returns the alignment

Returns:

null if not existing

getBorder

Border getBorder(Borders.BorderIndex borderIndex)

Returns the single border from the given border index.

Parameters:

borderIndex - either Borders.BorderIndex.EdgeLeft, Borders.BorderIndex.EdgeTop, Borders.BorderIndex.EdgeBottom, Borders.BorderIndex.EdgeRight, Borders.BorderIndex.DiagonalDown, Borders.BorderIndex.DiagonalUp, Borders.BorderIndex.InsideVertical, or Borders.BorderIndex.InsideHorizontal

Returns:

null if not existing.

getBorders

Borders getBorders()

Returns the borders collection.

Returns:

null if not existing.

getNumberFormat

NumberFormat getNumberFormat()

Returns the number format.

Returns:

null if not existing.

getProtection

Protection getProtection()

Returns the protection.

Returns:

null if not existing.