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

    • FILL_SOLID

      public static final int FILL_SOLID
      Fill with a solid color
      See Also:
    • FILL_PATTERN

      public static final int FILL_PATTERN
      Fill with a pattern (bitmap)
      See Also:
    • FILL_TEXTURE

      public static final int FILL_TEXTURE
      A texture (pattern with its own color map)
      See Also:
    • FILL_PICTURE

      public static final int FILL_PICTURE
      Center a picture in the shape
      See Also:
    • FILL_SHADE

      public static final int FILL_SHADE
      Shade from start to end points
      See Also:
    • FILL_SHADE_CENTER

      public static final int FILL_SHADE_CENTER
      Shade from bounding rectangle to end point
      See Also:
    • FILL_SHADE_SHAPE

      public static final int FILL_SHADE_SHAPE
      Shade from shape outline to end point
      See Also:
    • FILL_SHADE_SCALE

      public static final int FILL_SHADE_SCALE
      Similar to FILL_SHADE, but the fill angle is additionally scaled by the aspect ratio of the shape. If shape is square, it is the same as FILL_SHADE
      See Also:
    • FILL_SHADE_TITLE

      public static final int FILL_SHADE_TITLE
      shade to title
      See Also:
    • FILL_BACKGROUND

      public static final int FILL_BACKGROUND
      Use the background fill color/pattern
      See Also:
  • 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
    • afterInsert

      protected void afterInsert(HSLFSheet sh)
    • getEscherBSERecord

      protected EscherBSERecord getEscherBSERecord(int idx)
    • 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[], org.apache.poi.sl.usermodel.PictureData.PictureType) method.