io.starter.formats.OOXML

Class Fill

java.lang.Object

io.starter.formats.OOXML.Fill

All Implemented Interfaces:

OOXMLElement, Serializable

public class Fill
extends Object
implements OOXMLElement

fill OOXML element fill (Fill) This element specifies fill formatting parent: styleSheet/fills element in styles.xml, dxf->fills children: REQ CHOICE OF: patternFill, gradientFill

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Fill(Fill f)
Fill(int pattern, int fg, String fgColorCustom, int bg, String bgColorCustom, Theme t) create a new Fill from external vals
Fill(io.starter.formats.OOXML.PatternFill p, io.starter.formats.OOXML.GradientFill g, Theme t)
Fill(String fs, int fg, int bg, Theme t) create a new Fill from external vals

Method Summary

Modifier and Type	Method and Description
OOXMLElement	cloneElement()
int	getBgColorAsInt(Theme t) return the bg color in indexed (int) representation
String	getBgColorAsRGB(Theme t) return the bg color of this fill, if any
int	getFgColorAsInt(Theme t) return the fg color in indexed (int) representation
String	getFgColorAsRGB(Theme t) return the foreground color of this fill, if any
String	getFillPattern()
int	getFillPatternInt() return the fill pattern in 2003 int representation
String	getOOXML()
String	getOOXML(boolean isDxf) dxfs apparently have different pattern fill syntax -- UNDOCUMENTED ****
static String	getOOXML(int fs, int fg, int bg) returns the OOXML specifying the fill based on fill pattern fs, foreground color fg, background color bg
static String	getOOXML(Xf xf) returns the OOXML specifying the fill based on this FormatHandle object
boolean	isBackgroundSolid() returns true if the background pattern is solid
static OOXMLElement	parseOOXML(org.xmlpull.v1.XmlPullParser xpp, boolean isDxf, WorkBookHandle bk)
void	setBgColor(int t) sets the bg fill color via color int
void	setBgColor(int t, String colorString) sets the foreground fill color to a color string and Excel-2003-mapped color int
void	setFgColor(int t) sets the foreground fill color via color int
void	setFgColor(int t, String colorString) sets the foreground fill color to a color string and Excel-2003-mapped color int
void	setFillPattern(int t) sets the fill pattern
protected static String	transformToOOXMLRGBColor(String rgbcolor) OOXML values are stored with an intiall FF in their value, this method assures that values returned are 8 digits with ff appended to rgb value for ooxml usage
protected static String	transformToWebRGBColor(String rgbcolor) OOXML values are stored with an intiall FF in their value, this method assures that values returned are 6 digits + # for web usage

Methods inherited from class java.lang.Object

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

Constructor Detail

Fill

public Fill(io.starter.formats.OOXML.PatternFill p,
            io.starter.formats.OOXML.GradientFill g,
            Theme t)

Fill

public Fill(Fill f)

Fill

public Fill(String fs,
            int fg,
            int bg,
            Theme t)

create a new Fill from external vals

Parameters:

fs - String pattern type

fg - int color index

bg - int color index

Fill

public Fill(int pattern,
            int fg,
            String fgColorCustom,
            int bg,
            String bgColorCustom,
            Theme t)

create a new Fill from external vals

Parameters:

i - XLS indexed pattern

fg - int color index

fgColorCustom -

bg - int color index

Method Detail

parseOOXML

public static OOXMLElement parseOOXML(org.xmlpull.v1.XmlPullParser xpp,
                                      boolean isDxf,
                                      WorkBookHandle bk)

transformToWebRGBColor

protected static String transformToWebRGBColor(String rgbcolor)

OOXML values are stored with an intiall FF in their value, this method assures that values returned are 6 digits + # for web usage

Parameters:

rgbcolor -

transformToOOXMLRGBColor

protected static String transformToOOXMLRGBColor(String rgbcolor)

OOXML values are stored with an intiall FF in their value, this method assures that values returned are 8 digits with ff appended to rgb value for ooxml usage

Parameters:

rgbcolor -

getOOXML

public String getOOXML()

Specified by:

getOOXML in interface OOXMLElement

See Also:

OOXMLElement.getOOXML()

getOOXML

public String getOOXML(boolean isDxf)

dxfs apparently have different pattern fill syntax -- UNDOCUMENTED ****

Parameters:

isDxf - if this is an Dxf-generated fill, solid fills are handled differently than regular fills

Returns:

cloneElement

public OOXMLElement cloneElement()

Specified by:

cloneElement in interface OOXMLElement

See Also:

OOXMLElement.cloneElement()

getOOXML

public static String getOOXML(Xf xf)

returns the OOXML specifying the fill based on this FormatHandle object

getOOXML

public static String getOOXML(int fs,
                              int fg,
                              int bg)

returns the OOXML specifying the fill based on fill pattern fs, foreground color fg, background color bg

getFgColorAsRGB

public String getFgColorAsRGB(Theme t)

return the foreground color of this fill, if any

Returns:

getFgColorAsInt

public int getFgColorAsInt(Theme t)

return the fg color in indexed (int) representation

Returns:

getBgColorAsRGB

public String getBgColorAsRGB(Theme t)

return the bg color of this fill, if any

Returns:

getBgColorAsInt

public int getBgColorAsInt(Theme t)

return the bg color in indexed (int) representation

Returns:

setFgColor

public void setFgColor(int t)

sets the foreground fill color via color int

Parameters:

t -

setFgColor

public void setFgColor(int t,
                       String colorString)

sets the foreground fill color to a color string and Excel-2003-mapped color int

Parameters:

t - Excel-2003-mapped color int for the hex color string

colorString - hex color string

setBgColor

public void setBgColor(int t)

sets the bg fill color via color int

Parameters:

t -

setBgColor

public void setBgColor(int t,
                       String colorString)

sets the foreground fill color to a color string and Excel-2003-mapped color int

Parameters:

t - Excel-2003-mapped color int for the hex color string

colorString - hex color string

getFillPattern

public String getFillPattern()

getFillPatternInt

public int getFillPatternInt()

return the fill pattern in 2003 int representation

Returns:

setFillPattern

public void setFillPattern(int t)

sets the fill pattern

isBackgroundSolid

public boolean isBackgroundSolid()

returns true if the background pattern is solid

Returns: