Package org.apache.poi.hslf.usermodel

Class HSLFFill

java.lang.Object
org.apache.poi.hslf.usermodel.HSLFFill
public final class HSLFFill extends Object
Represents functionality provided by the 'Fill Effects' dialog in PowerPoint.

  • Constructor Details

    • 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 Details

    • 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 Color getForegroundColor()
      Foreground color

    • setForegroundColor

      public void setForegroundColor(Color color)
      Foreground color

    • getBackgroundColor

      public Color getBackgroundColor()
      Background color

    • setBackgroundColor

      public void setBackgroundColor(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.