io.starter.formats.OOXML

Class Color

java.lang.Object

io.starter.formats.OOXML.Color

All Implemented Interfaces:

OOXMLElement, Serializable

public class Color
extends Object
implements OOXMLElement

color (Data Bar Color) One of the colors associated with the data bar or color scale. Also font ... Note: the auto attribute is not used in the context of data bars NOTE: both color, fgColor and bgColor use same CT_COLOR schema: fgColor (Foreground Color) Foreground color of the cell fill pattern. Cell fill patterns operate with two colors: a background color and a foreground color. These combine together to make a patterned cell fill. bgColor (Background Color) Background color of the cell fill pattern. Cell fill patterns operate with two colors: a background color and a foreground color. These combine together to make a patterned cell fill.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	COLORTYPEINDEXED
static int	COLORTYPERGB
static int	COLORTYPETHEME

Constructor Summary

Constructors

Constructor and Description
Color()
Color(Color c)
Color(Color c, String element, Theme t) creates a new Color object based upon a java.awt.Color
Color(String element, boolean auto, int colortype, String colorval, double tint, short type, Theme t)
Color(String clr, String element, Theme t) creates a new Color object based upon a web-compliant Hex Color string

Method Summary

Modifier and Type	Method and Description
OOXMLElement	cloneElement()
Color	getColorAsColor()
String	getColorAsOOXMLRBG() return the translated HTML color string for this OOXML color
int	getColorInt() return the translated color int for this OOXML color
int	getColorType() return the color type for this OOXML color (indexed= 0, rgb= 1, theme= 2)
String	getOOXML()
static String	getOOXML(String element, int colortype, int colorval, String colorstr, double tint)
static String	parseColor(String val, int colortype, short type, Theme t) static version of parseColor --takes a color value of OOXML type type COLORTYPERBG, COLORTYPEINDEXED or COLORTYPETHEME and returns the
static int	parseColorInt(String val, int colortype, short type, Theme t) static version of parseColor --takes a color value of OOXML type type COLORTYPERBG, COLORTYPEINDEXED or COLORTYPETHEME and returns the indexed color int it represents
static OOXMLElement	parseOOXML(org.xmlpull.v1.XmlPullParser xpp, short type, WorkBookHandle bk) parses a color element root= color, fgColor or bgColor
static Object[]	parseThemeColor(String colorval, double tint, short type, Theme t) interprets theme colorval and tint TODO: read in theme colors from theme1.xml
void	setColor(Color c) sets the color via java.awt.Color
void	setColor(String clr) sets the color via a web-compliant Hex Color String
void	setColorInt(int clr) manually set color int automatically defaults to indexed color, and looks up color in COLORTABLE
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COLORTYPEINDEXED

public static int COLORTYPEINDEXED

COLORTYPERGB

public static int COLORTYPERGB

COLORTYPETHEME

public static int COLORTYPETHEME

Constructor Detail

Color

public Color()

Color

public Color(String element,
             boolean auto,
             int colortype,
             String colorval,
             double tint,
             short type,
             Theme t)

Color

public Color(Color c)

Color

public Color(Color c,
             String element,
             Theme t)

creates a new Color object based upon a java.awt.Color

Parameters:

clr - Color objeect

element - "color", "fgColor" or "bgColor"

Color

public Color(String clr,
             String element,
             Theme t)

creates a new Color object based upon a web-compliant Hex Color string

Parameters:

clr -

element - "color", "fgColor" or "bgColor"

Method Detail

parseOOXML

public static OOXMLElement parseOOXML(org.xmlpull.v1.XmlPullParser xpp,
                                      short type,
                                      WorkBookHandle bk)

parses a color element root= color, fgColor or bgColor

Parameters:

xpp -

Returns:

getOOXML

public String getOOXML()

Specified by:

getOOXML in interface OOXMLElement

See Also:

OOXMLElement.getOOXML()

getOOXML

public static String getOOXML(String element,
                              int colortype,
                              int colorval,
                              String colorstr,
                              double tint)

cloneElement

public OOXMLElement cloneElement()

Specified by:

cloneElement in interface OOXMLElement

See Also:

OOXMLElement.cloneElement()

toString

public String toString()

Overrides:

toString in class Object

getColorInt

public int getColorInt()

return the translated color int for this OOXML color

Returns:

getColorType

public int getColorType()

return the color type for this OOXML color (indexed= 0, rgb= 1, theme= 2)

Returns:

getColorAsOOXMLRBG

public String getColorAsOOXMLRBG()

return the translated HTML color string for this OOXML color

Returns:

getColorAsColor

public Color getColorAsColor()

setColorInt

public void setColorInt(int clr)

manually set color int automatically defaults to indexed color, and looks up color in COLORTABLE

Parameters:

clr -

setColor

public void setColor(Color c)

sets the color via java.awt.Color

Parameters:

c -

setColor

public void setColor(String clr)

sets the color via a web-compliant Hex Color String

Parameters:

clr -

parseColor

public static String parseColor(String val,
                                int colortype,
                                short type,
                                Theme t)

static version of parseColor --takes a color value of OOXML type type
COLORTYPERBG, COLORTYPEINDEXED or COLORTYPETHEME
and returns the

Parameters:

val - String OOXML color value, value depends upon colortype

colortype - int val's colortype, one of: Color.COLORTYPERGB, Color.COLORTYPEINDEXED, Color.COLORTYPETHEME

type - 0= font, 1= fill

Returns:

String HEX-style color string

parseColorInt

public static int parseColorInt(String val,
                                int colortype,
                                short type,
                                Theme t)

static version of parseColor --takes a color value of OOXML type type
COLORTYPERBG, COLORTYPEINDEXED or COLORTYPETHEME
and returns the indexed color int it represents

Parameters:

val - String OOXML color value, value depends upon colortype

colortype - int val's colortype, one of: Color.COLORTYPERGB, Color.COLORTYPEINDEXED, Color.COLORTYPETHEME

type - 0= font, 1= fill

Returns:

int

parseThemeColor

public static Object[] parseThemeColor(String colorval,
                                       double tint,
                                       short type,
                                       Theme t)

interprets theme colorval and tint TODO: read in theme colors from theme1.xml

Parameters:

colorval - String theme colorval (see SchemeClr and Theme for details) EITHER an Index into the collection, referencing a particular or value expressed in the Theme part. OR the actual clrScheme string

tint - double tint to apply to the base color (0 for none)

type - short 0= font, 1= fill

Returns: