Package org.apache.pdfbox.rendering

Class SoftMask

  • All Implemented Interfaces:
    java.awt.Paint, java.awt.Transparency
    class SoftMask
extends java.lang.Object
implements java.awt.Paint
    A Paint which applies a soft mask to an underlying Paint.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static java.awt.image.ColorModel ARGB_COLOR_MODEL  
      private java.awt.geom.Rectangle2D bboxDevice  
      private int bc  
      private static org.apache.commons.logging.Log LOG  
      private java.awt.image.BufferedImage mask  
      private java.awt.Paint paint  
      private PDFunction transferFunction  

      • Fields inherited from interface java.awt.Transparency

        BITMASK, OPAQUE, TRANSLUCENT

    • Constructor Summary

      Constructors 
      Constructor Description
      SoftMask​(java.awt.Paint paint, java.awt.image.BufferedImage mask, java.awt.geom.Rectangle2D bboxDevice, PDColor backdropColor, PDFunction transferFunction)
      Creates a new soft mask paint.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.awt.PaintContext createContext​(java.awt.image.ColorModel cm, java.awt.Rectangle deviceBounds, java.awt.geom.Rectangle2D userBounds, java.awt.geom.AffineTransform xform, java.awt.RenderingHints hints)  
      int getTransparency()  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • LOG

        private static final org.apache.commons.logging.Log LOG

      • ARGB_COLOR_MODEL

        private static final java.awt.image.ColorModel ARGB_COLOR_MODEL

      • paint

        private final java.awt.Paint paint

      • mask

        private final java.awt.image.BufferedImage mask

      • bboxDevice

        private final java.awt.geom.Rectangle2D bboxDevice

      • bc

        private int bc

      • transferFunction

        private final PDFunction transferFunction

    • Constructor Detail

      • SoftMask

        SoftMask​(java.awt.Paint paint,
         java.awt.image.BufferedImage mask,
         java.awt.geom.Rectangle2D bboxDevice,
         PDColor backdropColor,
         PDFunction transferFunction)
        Creates a new soft mask paint.
        Parameters:
        paint - underlying paint.
        mask - soft mask
        bboxDevice - bbox of the soft mask in the underlying Graphics2D device space
        backdropColor - the color to be used outside the transparency group’s bounding box; if null, black will be used.
        transferFunction - the transfer function, may be null.

    • Method Detail

      • createContext

        public java.awt.PaintContext createContext​(java.awt.image.ColorModel cm,
                                           java.awt.Rectangle deviceBounds,
                                           java.awt.geom.Rectangle2D userBounds,
                                           java.awt.geom.AffineTransform xform,
                                           java.awt.RenderingHints hints)
        Specified by:
        createContext in interface java.awt.Paint

      • getTransparency

        public int getTransparency()
        Specified by:
        getTransparency in interface java.awt.Transparency