org.apache.poi.hslf.usermodel

Class HSLFFill

java.lang.Object

org.apache.poi.hslf.usermodel.HSLFFill

public final class HSLFFill
extends java.lang.Object

Represents functionality provided by the 'Fill Effects' dialog in PowerPoint.

Constructor Summary

Constructors

Constructor and Description
HSLFFill(HSLFShape shape) Construct a Fill object for a shape.

Method Summary

Modifier and Type	Method and Description
java.awt.Color	getBackgroundColor() Background color
int	getFillFocus() The fillFocus property specifies the relative position of the last color in the shaded fill.
FillStyle	getFillStyle()
int	getFillType() Returns fill type.
java.awt.Color	getForegroundColor() Foreground color
HSLFPictureData	getPictureData() PictureData object used in a texture, pattern of picture fill.
void	setBackgroundColor(java.awt.Color color) Background color
void	setFillType(int type) Sets fill type.
void	setForegroundColor(java.awt.Color color) Foreground color
void	setPictureData(HSLFPictureData data) Assign picture used to fill the underlying shape.

Methods inherited from class java.lang.Object

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

Constructor Detail

HSLFFill

public HSLFFill(HSLFShape shape)

Construct a Fill object for a shape. Fill information will be read from shape's escher properties.

Parameters:

shape - the shape this background applies to

Method Detail

getFillStyle

public FillStyle getFillStyle()

getFillType

public int getFillType()

Returns fill type. Must be one of the FILL_* constants defined in this class.

Returns:

type of fill

getFillFocus

public int getFillFocus()

The fillFocus property specifies the relative position of the last color in the shaded fill. Its used to specify the center of an reflected fill. 0 = no reflection, 50 = reflected in the middle. If fillFocus is less than 0, the relative position of the last color is outside the shape, and the relative position of the first color is within the shape.

Returns:

a percentage in the range of -100 .. 100; defaults to 0

setFillType

public void setFillType(int type)

Sets fill type. Must be one of the FILL_* constants defined in this class.

Parameters:

type - type of the fill

getForegroundColor

public java.awt.Color getForegroundColor()

Foreground color

setForegroundColor

public void setForegroundColor(java.awt.Color color)

Foreground color

getBackgroundColor

public java.awt.Color getBackgroundColor()

Background color

setBackgroundColor

public void setBackgroundColor(java.awt.Color color)

Background color

getPictureData

public HSLFPictureData getPictureData()

PictureData object used in a texture, pattern of picture fill.

setPictureData

public void setPictureData(HSLFPictureData data)

Assign picture used to fill the underlying shape.

Parameters:

data - the picture data added to this ppt by HSLFSlideShow.addPicture(byte[], PictureData.PictureType) method.