Package org.apache.poi.hslf.usermodel

Class HSLFFill

  • public final class HSLFFill
extends java.lang.Object
    Represents functionality provided by the 'Fill Effects' dialog in PowerPoint.

    • Field Detail

      • FILL_PATTERN

        public static final int FILL_PATTERN
        Fill with a pattern (bitmap)
        See Also:
        Constant Field Values

      • FILL_TEXTURE

        public static final int FILL_TEXTURE
        A texture (pattern with its own color map)
        See Also:
        Constant Field Values

      • FILL_PICTURE

        public static final int FILL_PICTURE
        Center a picture in the shape
        See Also:
        Constant Field Values

      • FILL_SHADE

        public static final int FILL_SHADE
        Shade from start to end points
        See Also:
        Constant Field Values

      • FILL_SHADE_CENTER

        public static final int FILL_SHADE_CENTER
        Shade from bounding rectangle to end point
        See Also:
        Constant Field Values

      • FILL_SHADE_SHAPE

        public static final int FILL_SHADE_SHAPE
        Shade from shape outline to end point
        See Also:
        Constant Field Values

      • 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:
        Constant Field Values

      • FILL_SHADE_TITLE

        public static final int FILL_SHADE_TITLE
        shade to title
        See Also:
        Constant Field Values

      • FILL_BACKGROUND

        public static final int FILL_BACKGROUND
        Use the background fill color/pattern
        See Also:
        Constant Field Values

    • 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

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