Package com.itextpdf.text.pdf
Class PdfGState
- java.lang.Object
-
- com.itextpdf.text.pdf.PdfObject
-
- com.itextpdf.text.pdf.PdfDictionary
-
- com.itextpdf.text.pdf.PdfGState
-
- All Implemented Interfaces:
java.io.Serializable
public class PdfGState extends PdfDictionary
The graphic state dictionary.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static PdfName
BM_COLORBURN
A possible blend modestatic PdfName
BM_COLORDODGE
A possible blend modestatic PdfName
BM_COMPATIBLE
A possible blend modestatic PdfName
BM_DARKEN
A possible blend modestatic PdfName
BM_DIFFERENCE
A possible blend modestatic PdfName
BM_EXCLUSION
A possible blend modestatic PdfName
BM_HARDLIGHT
A possible blend modestatic PdfName
BM_LIGHTEN
A possible blend modestatic PdfName
BM_MULTIPLY
A possible blend modestatic PdfName
BM_NORMAL
A possible blend modestatic PdfName
BM_OVERLAY
A possible blend modestatic PdfName
BM_SCREEN
A possible blend modestatic PdfName
BM_SOFTLIGHT
A possible blend mode
-
Constructor Summary
Constructors Constructor Description PdfGState()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
setAlphaIsShape(boolean ais)
The alpha source flag specifying whether the current soft mask and alpha constant are to be interpreted as shape values (true) or opacity values (false).void
setBlendMode(PdfName bm)
The current blend mode to be used in the transparent imaging model.void
setFillOpacity(float ca)
Sets the current stroking alpha constant, specifying the constant shape or constant opacity value to be used for nonstroking operations in the transparent imaging model.void
setOverPrintMode(int opm)
Sets the flag whether to toggle knockout behavior for overprinted objects.void
setOverPrintNonStroking(boolean op)
Sets the flag whether to apply overprint for non stroking painting operations.void
setOverPrintStroking(boolean op)
Sets the flag whether to apply overprint for stroking.void
setRenderingIntent(PdfName ri)
Set the rendering intent, possible values are: PdfName.ABSOLUTECOLORIMETRIC, PdfName.RELATIVECOLORIMETRIC, PdfName.SATURATION, PdfName.PERCEPTUAL.void
setStrokeOpacity(float ca)
Sets the current stroking alpha constant, specifying the constant shape or constant opacity value to be used for stroking operations in the transparent imaging model.void
setTextKnockout(boolean tk)
Determines the behavior of overlapping glyphs within a text object in the transparent imaging model.void
toPdf(PdfWriter writer, java.io.OutputStream os)
Writes the PDF representation of thisPdfDictionary
as an array ofbyte
to the givenOutputStream
.-
Methods inherited from class com.itextpdf.text.pdf.PdfDictionary
checkType, clear, contains, get, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsStream, getAsString, getDirectObject, getKeys, isCatalog, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, putEx, remove, size, toString
-
Methods inherited from class com.itextpdf.text.pdf.PdfObject
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, type
-
-
-
-
Field Detail
-
BM_NORMAL
public static final PdfName BM_NORMAL
A possible blend mode
-
BM_COMPATIBLE
public static final PdfName BM_COMPATIBLE
A possible blend mode
-
BM_MULTIPLY
public static final PdfName BM_MULTIPLY
A possible blend mode
-
BM_SCREEN
public static final PdfName BM_SCREEN
A possible blend mode
-
BM_OVERLAY
public static final PdfName BM_OVERLAY
A possible blend mode
-
BM_DARKEN
public static final PdfName BM_DARKEN
A possible blend mode
-
BM_LIGHTEN
public static final PdfName BM_LIGHTEN
A possible blend mode
-
BM_COLORDODGE
public static final PdfName BM_COLORDODGE
A possible blend mode
-
BM_COLORBURN
public static final PdfName BM_COLORBURN
A possible blend mode
-
BM_HARDLIGHT
public static final PdfName BM_HARDLIGHT
A possible blend mode
-
BM_SOFTLIGHT
public static final PdfName BM_SOFTLIGHT
A possible blend mode
-
BM_DIFFERENCE
public static final PdfName BM_DIFFERENCE
A possible blend mode
-
BM_EXCLUSION
public static final PdfName BM_EXCLUSION
A possible blend mode
-
-
Method Detail
-
setOverPrintStroking
public void setOverPrintStroking(boolean op)
Sets the flag whether to apply overprint for stroking.- Parameters:
op
-
-
setOverPrintNonStroking
public void setOverPrintNonStroking(boolean op)
Sets the flag whether to apply overprint for non stroking painting operations.- Parameters:
op
-
-
setOverPrintMode
public void setOverPrintMode(int opm)
Sets the flag whether to toggle knockout behavior for overprinted objects.- Parameters:
opm
- - accepts 0 or 1
-
setStrokeOpacity
public void setStrokeOpacity(float ca)
Sets the current stroking alpha constant, specifying the constant shape or constant opacity value to be used for stroking operations in the transparent imaging model.- Parameters:
ca
-
-
setFillOpacity
public void setFillOpacity(float ca)
Sets the current stroking alpha constant, specifying the constant shape or constant opacity value to be used for nonstroking operations in the transparent imaging model.- Parameters:
ca
-
-
setAlphaIsShape
public void setAlphaIsShape(boolean ais)
The alpha source flag specifying whether the current soft mask and alpha constant are to be interpreted as shape values (true) or opacity values (false).- Parameters:
ais
-
-
setTextKnockout
public void setTextKnockout(boolean tk)
Determines the behavior of overlapping glyphs within a text object in the transparent imaging model.- Parameters:
tk
-
-
setBlendMode
public void setBlendMode(PdfName bm)
The current blend mode to be used in the transparent imaging model.- Parameters:
bm
-
-
setRenderingIntent
public void setRenderingIntent(PdfName ri)
Set the rendering intent, possible values are: PdfName.ABSOLUTECOLORIMETRIC, PdfName.RELATIVECOLORIMETRIC, PdfName.SATURATION, PdfName.PERCEPTUAL.- Parameters:
ri
-- Since:
- 5.0.2
-
toPdf
public void toPdf(PdfWriter writer, java.io.OutputStream os) throws java.io.IOException
Description copied from class:PdfDictionary
Writes the PDF representation of thisPdfDictionary
as an array ofbyte
to the givenOutputStream
.- Overrides:
toPdf
in classPdfDictionary
- Parameters:
writer
- for backwards compatibilityos
- theOutputStream
to write the bytes to.- Throws:
java.io.IOException
-
-