com.spire.xls
Class OColor

java.lang.Object
  com.spire.xls.OColor

public class OColor
extends java.lang.Object

This object used to store, convert colors.

Constructor Summary

OColor()

OColor(java.awt.Color rgb)

Method Summary

boolean	equals(java.lang.Object obj) Determines whether the specified object is equal to the current object.
ColorType	getColorType() Returns type of the stored color.
ExcelColors	getKnownColor(Workbook book)
double	getTint() Gets tint.
int	getValue() Returns color value (it can be index, rgb color, etc.)
void	setKnownColor(ExcelColors value) Sets known color.
void	setRGB(com.spire.ms.System.Drawing.Color rgb, IWorkbook book, double dTintValue) Sets rgb color.
void	setTheme(int themeIndex, IWorkbook book) Sets theme color.
void	setTheme(int themeIndex, IWorkbook book, double dTintValue) Sets theme color
void	setTint(double value) Sets tint.

Constructor Detail

OColor

public OColor()

OColor

public OColor(java.awt.Color rgb)

Method Detail

getValue

public int getValue()

Returns color value (it can be index, rgb color, etc.)

getTint

public double getTint()

Gets tint.

setTint

public void setTint(double value)

Sets tint.

getColorType

public ColorType getColorType()

Returns type of the stored color.

setTheme

public void setTheme(int themeIndex,
                     IWorkbook book)

Sets theme color.

Parameters:

themeIndex - Theme color index.

book - Parent workbook.

setTheme

public void setTheme(int themeIndex,
                     IWorkbook book,
                     double dTintValue)

Sets theme color

Parameters:

themeIndex - Theme color index.

book - Parent workbook.

dTintValue - Tint value.

setRGB

public void setRGB(com.spire.ms.System.Drawing.Color rgb,
                   IWorkbook book,
                   double dTintValue)

Sets rgb color.

Parameters:

rgb - Rgb color to set.

book - Parent workbook.

dTintValue - Tint value.

setKnownColor

public void setKnownColor(ExcelColors value)

Sets known color.

Parameters:

value - Excel color to set.

getKnownColor

public ExcelColors getKnownColor(Workbook book)

equals

public boolean equals(java.lang.Object obj)

Determines whether the specified object is equal to the current object.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The object to compare with the current object.

Returns:

True if the specified object is equal to the current object; otherwise, false.