io.keikai.client.api

Interface Borders

public interface Borders

A collection of borders that represent the four borders of a Range or CellStyle Object. If the border index is null, the four borders is assumed with (Borders.BorderIndex.EdgeLeft, Borders.BorderIndex.EdgeTop, and Borders.BorderIndex.EdgeBottom, Borders.BorderIndex.EdgeRight)

Author:

jumperchen

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Borders.BorderIndex BorderIndex attributes that can be applied.

Method Summary

Modifier and Type	Method and Description
Border	getBorder(Borders.BorderIndex borderIndex) Returns the border from the given border index.
List<Borders.BorderIndex>	getBorderIndices() Returns the specified border indices.
String	getColor()
int	getColorIndex()
int	getSize() Returns the size of the specified borders.
Border.Style	getStyle()
Border.ThemeColor	getThemeColor()
void	setBorder(Borders.BorderIndex borderIndex, Border border) Sets the border to the given border index.
void	setColor(int index) Sets the border color index.
void	setColor(String color) Sets the border color.
void	setStyle(Border.Style style) Sets the border style.
void	setThemeColor(Border.ThemeColor themeColor) Sets the border theme color.

Method Detail

setColor

void setColor(String color)

Sets the border color.

setColor

void setColor(int index)

Sets the border color index.

setStyle

void setStyle(Border.Style style)

Sets the border style.

Parameters:

style - either Border.Style.None, Border.Style.Thin, Border.Style.Medium, Border.Style.Dashed, Border.Style.Dotted, Border.Style.Thick, Border.Style.Double, Border.Style.Hair, Border.Style.MediumDashed, Border.Style.DashDot, Border.Style.MediumDashDot,Border.Style.DashDotDot, Border.Style.MediumDashDotDot, or Border.Style.SlantDashDot

setThemeColor

void setThemeColor(Border.ThemeColor themeColor)

Sets the border theme color.

Parameters:

themeColor - either Border.ThemeColor.Dark1, Border.ThemeColor.Light1, Border.ThemeColor.Dark2, Border.ThemeColor.Light2, Border.ThemeColor.Accent1, Border.ThemeColor.Accent2, Border.ThemeColor.Accent3, Border.ThemeColor.Accent4, Border.ThemeColor.Accent5, Border.ThemeColor.Accent6, Border.ThemeColor.Hyperlink, or Border.ThemeColor.FollowedHyperlink

getColor

String getColor()

getColorIndex

int getColorIndex()

getStyle

Border.Style getStyle()

getThemeColor

Border.ThemeColor getThemeColor()

setBorder

void setBorder(Borders.BorderIndex borderIndex,
               Border border)

Sets the border to 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 -

getBorder

Border getBorder(Borders.BorderIndex borderIndex)

Returns the 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

getBorderIndices

List<Borders.BorderIndex> getBorderIndices()

Returns the specified border indices.

getSize

int getSize()

Returns the size of the specified borders.