com.spire.xls.core.spreadsheet.shapes
Class XlsShapeFill

java.lang.Object
  com.spire.xls.core.spreadsheet.XlsObject
      com.spire.xls.core.spreadsheet.shapes.XlsShapeFill

All Implemented Interfaces:

IShapeFill

public class XlsShapeFill
extends XlsObject
implements IShapeFill

Represents XlsFill format in shape object.

Constructor Summary

XlsShapeFill(java.lang.Object parent)

XlsShapeFill(java.lang.Object parent, XlsShape innershape)

Method Summary

int	compareTo(IGradient twin) Compares with shape XlsFill impl.
void	customPicture(java.awt.image.BufferedImage im, java.lang.String name) Sets user defined picture.
void	customPicture(java.lang.String path) Sets user defined picture.
void	customTexture(java.awt.image.BufferedImage im, java.lang.String name) Sets user defined texture.
void	customTexture(java.lang.String path) Sets user defined texture.
java.awt.Color	getBackColor() Represents background color.
OColor	getBackColorObject() Represents background color.
ExcelColors	getBackKnownColor() Represents background color index.
ShapeFillType	getFillType() Represents shape XlsFill type.
java.awt.Color	getForeColor() Represents foreground color.
OColor	getForeColorObject() Represents foreground color.
ExcelColors	getForeKnownColor() Represents foreground color index.
GradientColorType	getGradientColorType() Represents gradient style.
double	getGradientDegree() Returns the gradient degree of the specified one-color shaded XlsFill as a floating-point value from 0.0 (dark) through 1.0 (light)
GradientStops	getGradientStops() Returns collection of gradient stops that stores gradient XlsFill settings.
GradientStyleType	getGradientStyle() Represents gradient shading style.
GradientVariantsType	getGradientVariant() Represents current shading variant.
GradientPatternType	getPattern() Represents gradient pattern
PicStretch	getPicStretch() Gets or sets pictrue format option.
PicTile	getPicTile() Gets or sets tile picture option.
java.awt.image.BufferedImage	getPicture() Represents user defined picture or textture.
java.lang.String	getPictureName() Returns user defined picture of texture name.
GradientPresetType	getPresetGradientType() Represents presed gradient type.
GradientTextureType	getTexture() Represents gradient texture
boolean	getTile() Represents whether picture is tiled or stretched.
double	getTransparency() Returns the transparency level of the specified Solid color shaded XlsFill as a floating-point value from 0.0 (opaque) through 1.0(transparent)
double	getTransparencyFrom() Returns or sets the degree of transparency of the specified XlsFill as a value from 0.0 (opaque) through 1.0 (clear).
double	getTransparencyTo() Returns or sets the degree of transparency of the specified XlsFill as a value from 0.0 (opaque) through 1.0 (clear).
boolean	getVisible() Represents if XlsFill style visible.
static boolean	isDoubled(GradientStyleType gradientStyle, GradientVariantsType variant) Detects whether color sequence should be doubled or not.
static boolean	isInverted(GradientStyleType gradientStyle, GradientVariantsType variant) Returns true if colors should be placed in inverted order.
void	oneColorGradient() Sets the specified XlsFill to a one-color gradient.
void	oneColorGradient(GradientStyleType style) Sets the specified XlsFill to a one-color gradient.
void	oneColorGradient(GradientStyleType style, GradientVariantsType variant) Sets the specified XlsFill to a one-color gradient.
void	patterned(GradientPatternType pattern) Sets the specified XlsFill to a pattern.
void	presetGradient(GradientPresetType grad) Sets the specified XlsFill to a preset gradient.
void	presetGradient(GradientPresetType grad, GradientStyleType shadStyle) Sets the specified XlsFill to a preset gradient.
void	presetGradient(GradientPresetType grad, GradientStyleType shadStyle, GradientVariantsType shadVar) Sets the specified XlsFill to a preset gradient.
void	presetTextured(GradientTextureType texture) Sets the specified XlsFill format to a preset texture.
void	setBackColor(java.awt.Color value) Represents background color.
void	setBackKnownColor(ExcelColors value) Represents background color index.
void	setFillType(ShapeFillType value) Represents shape XlsFill type.
void	setForeColor(java.awt.Color value) Represents foreground color.
void	setForeKnownColor(ExcelColors value) Represents foreground color index.
void	setGradientColorType(GradientColorType value) Represents gradient style.
void	setGradientDegree(double value) Returns the gradient degree of the specified one-color shaded XlsFill as a floating-point value from 0.0 (dark) through 1.0 (light)
void	setGradientStyle(GradientStyleType value) Represents gradient shading style.
void	setGradientVariant(GradientVariantsType value) Represents current shading variant.
void	setPattern(GradientPatternType value) Represents gradient pattern
void	setPresetGradientType(GradientPresetType value) Represents presed gradient type.
void	setTexture(GradientTextureType value) Represents gradient texture
void	setTile(boolean value) Represents whether picture is tiled or stretched.
void	setTransparency(double value) Returns the transparency level of the specified Solid color shaded XlsFill as a floating-point value from 0.0 (opaque) through 1.0(transparent)
void	setTransparencyFrom(double value) Returns or sets the degree of transparency of the specified XlsFill as a value from 0.0 (opaque) through 1.0 (clear).
void	setTransparencyTo(double value) Returns or sets the degree of transparency of the specified XlsFill as a value from 0.0 (opaque) through 1.0 (clear).
void	setVisible(boolean value) Represents if XlsFill style visible.
void	solid() Sets the specified XlsFill to a uniform color.
void	twoColorGradient() Sets the specified XlsFill to a two-color gradient.
void	twoColorGradient(GradientStyleType style) Sets the specified XlsFill to a two-color gradient.
void	twoColorGradient(GradientStyleType style, GradientVariantsType variant) Sets the specified XlsFill to a two-color gradient.

Methods inherited from class com.spire.xls.core.spreadsheet.XlsObject

dispose

Methods inherited from interface com.spire.xls.core.IShapeFill

setPicStretch

Constructor Detail

XlsShapeFill

public XlsShapeFill(java.lang.Object parent)

XlsShapeFill

public XlsShapeFill(java.lang.Object parent,
                    XlsShape innershape)

Method Detail

getGradientStops

public GradientStops getGradientStops()

Returns collection of gradient stops that stores gradient XlsFill settings. Read-only.

getFillType

public ShapeFillType getFillType()

Represents shape XlsFill type.

Specified by:

getFillType in interface IShapeFill

setFillType

public void setFillType(ShapeFillType value)

Represents shape XlsFill type.

Specified by:

setFillType in interface IShapeFill

getGradientStyle

public GradientStyleType getGradientStyle()

Represents gradient shading style.

Specified by:

getGradientStyle in interface IShapeFill

setGradientStyle

public void setGradientStyle(GradientStyleType value)

Represents gradient shading style.

Specified by:

setGradientStyle in interface IShapeFill

getGradientVariant

public GradientVariantsType getGradientVariant()

Represents current shading variant.

Specified by:

getGradientVariant in interface IShapeFill

setGradientVariant

public void setGradientVariant(GradientVariantsType value)

Represents current shading variant.

Specified by:

setGradientVariant in interface IShapeFill

getTransparency

public double getTransparency()

Returns the transparency level of the specified Solid color shaded XlsFill as a floating-point value from 0.0 (opaque) through 1.0(transparent)

Specified by:

getTransparency in interface IShapeFill

setTransparency

public void setTransparency(double value)

Returns the transparency level of the specified Solid color shaded XlsFill as a floating-point value from 0.0 (opaque) through 1.0(transparent)

Specified by:

setTransparency in interface IShapeFill

getTransparencyFrom

public double getTransparencyFrom()

Returns or sets the degree of transparency of the specified XlsFill as a value from 0.0 (opaque) through 1.0 (clear).

Specified by:

getTransparencyFrom in interface IShapeFill

setTransparencyFrom

public void setTransparencyFrom(double value)

Returns or sets the degree of transparency of the specified XlsFill as a value from 0.0 (opaque) through 1.0 (clear).

Specified by:

setTransparencyFrom in interface IShapeFill

getTransparencyTo

public double getTransparencyTo()

Returns or sets the degree of transparency of the specified XlsFill as a value from 0.0 (opaque) through 1.0 (clear).

Specified by:

getTransparencyTo in interface IShapeFill

setTransparencyTo

public void setTransparencyTo(double value)

Returns or sets the degree of transparency of the specified XlsFill as a value from 0.0 (opaque) through 1.0 (clear).

Specified by:

setTransparencyTo in interface IShapeFill

getVisible

public boolean getVisible()

Represents if XlsFill style visible.

Specified by:

getVisible in interface IShapeFill

setVisible

public void setVisible(boolean value)

Represents if XlsFill style visible.

Specified by:

setVisible in interface IShapeFill

getBackKnownColor

public ExcelColors getBackKnownColor()

Represents background color index.

Specified by:

getBackKnownColor in interface IShapeFill

setBackKnownColor

public void setBackKnownColor(ExcelColors value)

Represents background color index.

getForeKnownColor

public ExcelColors getForeKnownColor()

Represents foreground color index.

Specified by:

getForeKnownColor in interface IShapeFill

setForeKnownColor

public void setForeKnownColor(ExcelColors value)

Represents foreground color index.

Specified by:

setForeKnownColor in interface IShapeFill

getBackColor

public java.awt.Color getBackColor()

Represents background color.

Specified by:

getBackColor in interface IShapeFill

setBackColor

public void setBackColor(java.awt.Color value)

Represents background color.

Specified by:

setBackColor in interface IShapeFill

getForeColor

public java.awt.Color getForeColor()

Represents foreground color.

Specified by:

getForeColor in interface IShapeFill

setForeColor

public void setForeColor(java.awt.Color value)

Represents foreground color.

Specified by:

setForeColor in interface IShapeFill

getBackColorObject

public OColor getBackColorObject()

Represents background color.

getForeColorObject

public OColor getForeColorObject()

Represents foreground color.

getGradientColorType

public GradientColorType getGradientColorType()

Represents gradient style.

Specified by:

getGradientColorType in interface IShapeFill

setGradientColorType

public void setGradientColorType(GradientColorType value)

Represents gradient style.

Specified by:

setGradientColorType in interface IShapeFill

getTexture

public GradientTextureType getTexture()

Represents gradient texture

Specified by:

getTexture in interface IShapeFill

setTexture

public void setTexture(GradientTextureType value)

Represents gradient texture

Specified by:

setTexture in interface IShapeFill

getPattern

public GradientPatternType getPattern()

Represents gradient pattern

Specified by:

getPattern in interface IShapeFill

setPattern

public void setPattern(GradientPatternType value)

Represents gradient pattern

Specified by:

setPattern in interface IShapeFill

getPresetGradientType

public GradientPresetType getPresetGradientType()

Represents presed gradient type.

Specified by:

getPresetGradientType in interface IShapeFill

setPresetGradientType

public void setPresetGradientType(GradientPresetType value)

Represents presed gradient type.

Specified by:

setPresetGradientType in interface IShapeFill

getPicture

public java.awt.image.BufferedImage getPicture()

Represents user defined picture or textture. Read only.

Specified by:

getPicture in interface IShapeFill

getPictureName

public java.lang.String getPictureName()

Returns user defined picture of texture name. Read only.

Specified by:

getPictureName in interface IShapeFill

getGradientDegree

public double getGradientDegree()

Returns the gradient degree of the specified one-color shaded XlsFill as a floating-point value from 0.0 (dark) through 1.0 (light)

Specified by:

getGradientDegree in interface IShapeFill

setGradientDegree

public void setGradientDegree(double value)

Returns the gradient degree of the specified one-color shaded XlsFill as a floating-point value from 0.0 (dark) through 1.0 (light)

Specified by:

setGradientDegree in interface IShapeFill

getTile

public boolean getTile()

Represents whether picture is tiled or stretched.

Specified by:

getTile in interface IShapeFill

setTile

public void setTile(boolean value)

Represents whether picture is tiled or stretched.

Specified by:

setTile in interface IShapeFill

getPicStretch

public PicStretch getPicStretch()

Gets or sets pictrue format option.

Specified by:

getPicStretch in interface IShapeFill

getPicTile

public PicTile getPicTile()

Gets or sets tile picture option.

isDoubled

public static boolean isDoubled(GradientStyleType gradientStyle,
                                GradientVariantsType variant)

Detects whether color sequence should be doubled or not.

Parameters:

gradientStyle - Gradient style.

variant - Gradient variant.

Returns:

True if color sequence should be doubled.

isInverted

public static boolean isInverted(GradientStyleType gradientStyle,
                                 GradientVariantsType variant)

Returns true if colors should be placed in inverted order.

Parameters:

gradientStyle - Gradient style.

variant - Gradient variant.

Returns:

True if colors should be placed in inverted order.

compareTo

public int compareTo(IGradient twin)

Compares with shape XlsFill impl.

Parameters:

twin - Shape XlsFill to compare with.

Returns:

Zero if shape fills are equal.

customPicture

public void customPicture(java.lang.String path)

Sets user defined picture.

Specified by:

customPicture in interface IShapeFill

Parameters:

path - Path to image.

customPicture

public void customPicture(java.awt.image.BufferedImage im,
                          java.lang.String name)

Sets user defined picture.

Specified by:

customPicture in interface IShapeFill

Parameters:

im - Represents user defined image.

name - Represents name of user defined image.

customTexture

public void customTexture(java.lang.String path)

Sets user defined texture.

Specified by:

customTexture in interface IShapeFill

Parameters:

path - Path to image.

customTexture

public void customTexture(java.awt.image.BufferedImage im,
                          java.lang.String name)

Sets user defined texture.

Specified by:

customTexture in interface IShapeFill

Parameters:

im - Represents user defined texture.

name - Represents name of user defined texture.

patterned

public void patterned(GradientPatternType pattern)

Sets the specified XlsFill to a pattern.

Specified by:

patterned in interface IShapeFill

Parameters:

pattern - Pattern to set.

presetGradient

public void presetGradient(GradientPresetType grad)

Sets the specified XlsFill to a preset gradient.

Specified by:

presetGradient in interface IShapeFill

Parameters:

grad - Represents preset gradient type.

presetGradient

public void presetGradient(GradientPresetType grad,
                           GradientStyleType shadStyle)

Sets the specified XlsFill to a preset gradient.

Specified by:

presetGradient in interface IShapeFill

Parameters:

grad - Represents preset gradient type.

shadStyle - Represents gradient style, for preset gradient.

presetGradient

public void presetGradient(GradientPresetType grad,
                           GradientStyleType shadStyle,
                           GradientVariantsType shadVar)

Sets the specified XlsFill to a preset gradient.

Specified by:

presetGradient in interface IShapeFill

Parameters:

grad - Represents preset gradient type.

shadStyle - Represents gradient style, for preset gradient.

shadVar - Represents gradient variant for preset gradient.

presetTextured

public void presetTextured(GradientTextureType texture)

Sets the specified XlsFill format to a preset texture.

Specified by:

presetTextured in interface IShapeFill

Parameters:

texture - Represents texture to set.

twoColorGradient

public void twoColorGradient()

Sets the specified XlsFill to a two-color gradient.

Specified by:

twoColorGradient in interface IShapeFill

twoColorGradient

public void twoColorGradient(GradientStyleType style)

Sets the specified XlsFill to a two-color gradient.

Specified by:

twoColorGradient in interface IShapeFill

Parameters:

style - Represents shading shading style.

twoColorGradient

public void twoColorGradient(GradientStyleType style,
                             GradientVariantsType variant)

Sets the specified XlsFill to a two-color gradient.

Specified by:

twoColorGradient in interface IShapeFill

Parameters:

style - Represents shading shading style.

variant - Represents shading variant.

oneColorGradient

public void oneColorGradient()

Sets the specified XlsFill to a one-color gradient.

Specified by:

oneColorGradient in interface IShapeFill

oneColorGradient

public void oneColorGradient(GradientStyleType style)

Sets the specified XlsFill to a one-color gradient.

Specified by:

oneColorGradient in interface IShapeFill

Parameters:

style - Represents shading shading style.

oneColorGradient

public void oneColorGradient(GradientStyleType style,
                             GradientVariantsType variant)

Sets the specified XlsFill to a one-color gradient.

Specified by:

oneColorGradient in interface IShapeFill

Parameters:

style - Represents shading shading style.

variant - Represents shading variant.

solid

public void solid()

Sets the specified XlsFill to a uniform color.

Specified by:

solid in interface IShapeFill