Class PDSoftMask
java.lang.Object
org.apache.pdfbox.pdmodel.graphics.state.PDSoftMask
- All Implemented Interfaces:
COSObjectable
Soft mask.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate COSArray
private Matrix
To allow a soft mask to know the CTM at the time of activation of the ExtGState.private final COSDictionary
private PDTransparencyGroup
private static final org.apache.commons.logging.Log
private COSName
private PDFunction
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic PDSoftMask
Creates a new soft mask.Returns the backdrop color.Convert this standard java object to a COS object.getGroup()
Returns the G entry of the soft mask objectReturns the CTM at the time the ExtGState was activated.Returns the subtype of the soft mask (Alpha, Luminosity) - S entryReturns the transfer function.(package private) void
Set the CTM that is valid at the time the ExtGState was activated.
-
Field Details
-
LOG
private static final org.apache.commons.logging.Log LOG -
dictionary
-
subType
-
group
-
backdropColor
-
transferFunction
-
ctm
To allow a soft mask to know the CTM at the time of activation of the ExtGState.
-
-
Constructor Details
-
PDSoftMask
Creates a new soft mask.- Parameters:
dictionary
- The soft mask dictionary.
-
-
Method Details
-
create
Creates a new soft mask.- Parameters:
dictionary
- SMask
-
getCOSObject
Description copied from interface:COSObjectable
Convert this standard java object to a COS object.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- The cos object that matches this Java object.
-
getSubType
Returns the subtype of the soft mask (Alpha, Luminosity) - S entry -
getGroup
Returns the G entry of the soft mask object- Returns:
- form containing the transparency group
- Throws:
IOException
-
getBackdropColor
Returns the backdrop color. -
getTransferFunction
Returns the transfer function.- Throws:
IOException
- If we are unable to create the PDFunction object.
-
setInitialTransformationMatrix
Set the CTM that is valid at the time the ExtGState was activated.- Parameters:
ctm
-
-
getInitialTransformationMatrix
Returns the CTM at the time the ExtGState was activated.- Returns:
- the CTM at the time the ExtGState was activated.
-