Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate


com.aspose.cells
Class FillFormat

java.lang.Object
  extended by com.aspose.cells.FillFormat

public class FillFormat
extends java.lang.Object

Encapsulates the object that represents fill formatting for a shape


Method Summary
 Color getColor1()
          Gets the gradient color 1 or the pattern foreground color for the the specified fill.
 Color getColor2()
          Gets the gradient color 2 or the pattern foreground color for the the specified fill.
 byte getGradientColorType()
          Gets the gradient color type for the specified fill.
 float getGradientDegree()
          Gets the gradient degree for the the specified fill.
 byte getGradientStyle()
          Gets the gradient style for the specified fill.
 int getGradientVariant()
          Gets the gradient variant for the the specified fill.
 short getPattern()
          Gets an area's display pattern.
 short getPresetColor()
          Gets the gradient preset color for the the specified fill.
 short getTexture()
          Gets the texture type for the specified fill.
 void setColor1(Color color1)
          Sets the gradient color 1 or the pattern foreground color for the the specified fill.
 void setColor2(Color color2)
          Sets the gradient color 2 or the pattern foreground color for the the specified fill.
 void setGradientColorType(byte gradientColorType)
          Sets the gradient color type for the specified fill.
 void setGradientDegree(float gradientDegree)
          Sets the gradient degree for the the specified fill.
 void setGradientStyle(byte gradientStyle)
          Sets the gradient style for the specified fill.
 void setGradientVariant(int gradientVariant)
          Sets the gradient variant for the the specified fill.
 void setPattern(short pattern)
          Sets an area's display pattern.
 void setPresetColor(short presetColor)
          Sets the gradient preset color for the the specified fill.
 void setTexture(short texture)
          Sets the texture type for the specified fill.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getColor1

public Color getColor1()
Gets the gradient color 1 or the pattern foreground color for the the specified fill.

Returns:
the gradient color 1 or the pattern foreground color.

setColor1

public void setColor1(Color color1)
Sets the gradient color 1 or the pattern foreground color for the the specified fill.

Parameters:
color1 - the gradient color 1 or the pattern foreground color.

getColor2

public Color getColor2()
Gets the gradient color 2 or the pattern foreground color for the the specified fill.

Returns:
the gradient color 2 or the pattern foreground color.

setColor2

public void setColor2(Color color2)
Sets the gradient color 2 or the pattern foreground color for the the specified fill.

Parameters:
color2 - the gradient color 2 or the pattern foreground color.

getGradientColorType

public byte getGradientColorType()
Gets the gradient color type for the specified fill.

Returns:
the gradient color type.
See Also:
setGradientColorType(byte)

setGradientColorType

public void setGradientColorType(byte gradientColorType)
Sets the gradient color type for the specified fill.

Parameters:
gradientColorType - the gradient color type.
Throws:
java.lang.IllegalArgumentException - if gradientColorType is not a const member of GradientColorType
See Also:
GradientColorType

getGradientDegree

public float getGradientDegree()
Gets the gradient degree for the the specified fill.

Returns:
the gradient degree.

setGradientDegree

public void setGradientDegree(float gradientDegree)
Sets the gradient degree for the the specified fill.

Parameters:
gradientDegree - the gradient degree.Can only be a value from 0.0 (dark) through 1.0 (light).
Throws:
java.lang.IllegalArgumentException - if gradientDegree is not between 0.0 (dark) and 1.0 (light).

getGradientStyle

public byte getGradientStyle()
Gets the gradient style for the specified fill.

Returns:
the gradient style.
See Also:
setGradientStyle(byte)

setGradientStyle

public void setGradientStyle(byte gradientStyle)
Sets the gradient style for the specified fill.

Parameters:
gradientStyle - the gradient style.
Throws:
java.lang.IllegalArgumentException - if gradientStyle is not a const member of GradientStyleType.
See Also:
GradientStyleType

getGradientVariant

public int getGradientVariant()
Gets the gradient variant for the the specified fill.

Returns:
the gradient variant.

setGradientVariant

public void setGradientVariant(int gradientVariant)
Sets the gradient variant for the the specified fill. The gradient variant can only be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If style is GradientStyle.FROM_CENTER, the Variant argument can only be 1 or 2.

Parameters:
gradientVariant - the gradient variant.

getPresetColor

public short getPresetColor()
Gets the gradient preset color for the the specified fill.

Returns:
the gradient preset color.
See Also:
GradientPresetType

setPresetColor

public void setPresetColor(short presetColor)
Sets the gradient preset color for the the specified fill.

Parameters:
presetColor - the gradient preset color.
See Also:
GradientPresetType

getPattern

public short getPattern()
Gets an area's display pattern.

Returns:
an area's display pattern.
See Also:
setPattern(short)

setPattern

public void setPattern(short pattern)
Sets an area's display pattern.

Parameters:
pattern - an area's display pattern.
See Also:
FillPatternType

getTexture

public short getTexture()
Gets the texture type for the specified fill.

Returns:
the texture type for the specified fill.
See Also:
getTexture()

setTexture

public void setTexture(short texture)
Sets the texture type for the specified fill.

Parameters:
texture - the texture type for the specified fill.
See Also:
TextureType