Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.graphics.state.PDSoftMask

Field Summary

Modifier and Type	Field and Description
private COSArray	backdropColor
private Matrix	ctm To allow a soft mask to know the CTM at the time of activation of the ExtGState.
private final COSDictionary	dictionary
private PDTransparencyGroup	group
private static final Log	LOG
private COSName	subType
private PDFunction	transferFunction

Constructor Summary

Access	Constructor and Description
public	PDSoftMask(COSDictionary The soft mask dictionary. dictionary) Creates a new soft mask.

Method Summary

Modifier and Type	Method and Description
public static PDSoftMask	Returns: the newly created instance of PDSoftMask create(COSBase SMask dictionary) Creates a new soft mask.
public COSArray	Returns: the backdrop color getBackdropColor() Returns the backdrop color.
public COSDictionary	getCOSObject() Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject. Convert this standard java object to a COS object.
public PDTransparencyGroup	Returns: form containing the transparency group getGroup() Returns the G entry of the soft mask object
public Matrix	Returns: the transformation matrix getInitialTransformationMatrix() Returns the CTM at the time the ExtGState was activated.
public COSName	Returns: the subtype of the soft mask getSubType() Returns the subtype of the soft mask (Alpha, Luminosity) - S entry
public PDFunction	Returns: the transfer function getTransferFunction() Returns the transfer function.
pack-priv void	setInitialTransformationMatrix(Matrix the transformation matrix ctm) Set the CTM that is valid at the time the ExtGState was activated.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

backdropColor	back to summary
private COSArray backdropColor

ctm	back to summary
private Matrix ctm To allow a soft mask to know the CTM at the time of activation of the ExtGState.

dictionary	back to summary
private final COSDictionary dictionary

group	back to summary
private PDTransparencyGroup group

LOG	back to summary
private static final Log LOG

subType	back to summary
private COSName subType

transferFunction	back to summary
private PDFunction transferFunction

Constructor Detail

PDSoftMask	back to summary
public PDSoftMask(COSDictionary dictionary) Creates a new soft mask. Parameters dictionary:COSDictionary The soft mask dictionary.

PDSoftMask

back to summary

public PDSoftMask(COSDictionary dictionary)

Creates a new soft mask.

Parameters

dictionary:COSDictionary: The soft mask dictionary.

Method Detail

create	back to summary
public static PDSoftMask create(COSBase dictionary) Creates a new soft mask. Parameters dictionary:COSBase SMask Returns:PDSoftMask the newly created instance of PDSoftMask

create

back to summary

public static PDSoftMask create(COSBase dictionary)

Creates a new soft mask.

Parameters

dictionary:COSBase: SMask

Returns:PDSoftMask

the newly created instance of PDSoftMask

getBackdropColor	back to summary
public COSArray getBackdropColor() Returns the backdrop color. Returns:COSArray the backdrop color

getBackdropColor

back to summary

public COSArray getBackdropColor()

Returns the backdrop color.

Returns:COSArray: the backdrop color

getCOSObject	back to summary
public COSDictionary getCOSObject() Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject. Doc from org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject. Convert this standard java object to a COS object. Returns:COSDictionary The cos object that matches this Java object. Annotations @Override

getCOSObject

back to summary

public COSDictionary getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Doc from org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

Returns:COSDictionary

The cos object that matches this Java object.

Annotations

@Override

getGroup	back to summary
public PDTransparencyGroup getGroup() throws IOException Returns the G entry of the soft mask object Returns:PDTransparencyGroup form containing the transparency group Exceptions IOException: if the group could not be read

getGroup

back to summary

public PDTransparencyGroup getGroup() throws IOException

Returns the G entry of the soft mask object

Returns:PDTransparencyGroup

form containing the transparency group

Exceptions

IOException:: if the group could not be read

getInitialTransformationMatrix	back to summary
public Matrix getInitialTransformationMatrix() Returns the CTM at the time the ExtGState was activated. Returns:Matrix the transformation matrix

getInitialTransformationMatrix

back to summary

public Matrix getInitialTransformationMatrix()

Returns the CTM at the time the ExtGState was activated.

Returns:Matrix: the transformation matrix

getSubType	back to summary
public COSName getSubType() Returns the subtype of the soft mask (Alpha, Luminosity) - S entry Returns:COSName the subtype of the soft mask

getSubType

back to summary

public COSName getSubType()

Returns the subtype of the soft mask (Alpha, Luminosity) - S entry

Returns:COSName: the subtype of the soft mask

getTransferFunction	back to summary
public PDFunction getTransferFunction() throws IOException Returns the transfer function. Returns:PDFunction the transfer function Exceptions IOException: If we are unable to create the PDFunction object.

getTransferFunction

back to summary

public PDFunction getTransferFunction() throws IOException

Returns the transfer function.

Returns:PDFunction

the transfer function

Exceptions

IOException:: If we are unable to create the PDFunction object.

setInitialTransformationMatrix	back to summary
pack-priv void setInitialTransformationMatrix(Matrix ctm) Set the CTM that is valid at the time the ExtGState was activated. Parameters ctm:Matrix the transformation matrix

setInitialTransformationMatrix

back to summary

pack-priv void setInitialTransformationMatrix(Matrix ctm)

Set the CTM that is valid at the time the ExtGState was activated.

Parameters

ctm:Matrix: the transformation matrix

public final Class PDSoftMask

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail