Package org.apache.pdfbox.rendering

Class SoftMask

java.lang.Object

org.apache.pdfbox.rendering.SoftMask

All Implemented Interfaces:

Paint, Transparency

class SoftMask
extends Object
implements Paint

A Paint which applies a soft mask to an underlying Paint.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	SoftMask.SoftPaintContext

Field Summary

Fields

Modifier and Type	Field	Description
private static final ColorModel	ARGB_COLOR_MODEL
private final Rectangle2D	bboxDevice
private int	bc
private final BufferedImage	mask
private final Paint	paint
private final PDFunction	transferFunction

Fields inherited from interface java.awt.Transparency

BITMASK, OPAQUE, TRANSLUCENT

Constructor Summary

Constructors

Constructor	Description
SoftMask(Paint paint, BufferedImage mask, Rectangle2D bboxDevice, PDColor backdropColor, PDFunction transferFunction)	Creates a new soft mask paint.

Method Summary

Modifier and Type	Method	Description
PaintContext	createContext(ColorModel cm, Rectangle deviceBounds, Rectangle2D userBounds, AffineTransform xform, RenderingHints hints)
int	getTransparency()

Methods inherited from class java.lang.Object

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

Field Details

ARGB_COLOR_MODEL

private static final ColorModel ARGB_COLOR_MODEL

paint

private final Paint paint

mask

private final BufferedImage mask

bboxDevice

private final Rectangle2D bboxDevice

bc

private int bc

transferFunction

private final PDFunction transferFunction

Constructor Details

SoftMask

SoftMask(Paint paint,
 BufferedImage mask,
 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 Details

createContext

public PaintContext createContext(ColorModel cm,
 Rectangle deviceBounds,
 Rectangle2D userBounds,
 AffineTransform xform,
 RenderingHints hints)

Specified by:

createContext in interface Paint

getTransparency

public int getTransparency()

Specified by:

getTransparency in interface Transparency