Class PDExtendedGraphicsState

  • All Implemented Interfaces:
    COSObjectable

    public class PDExtendedGraphicsState
    extends java.lang.Object
    implements COSObjectable
    This class represents the graphics state dictionary that is stored in the PDF document. The PDGraphicsStateValue holds the current runtime values as a stream is being executed.
    Version:
    $Revision: 1.5 $
    Author:
    Ben Litchfield
    • Field Detail

      • RENDERING_INTENT_ABSOLUTE_COLORIMETRIC

        public static final java.lang.String RENDERING_INTENT_ABSOLUTE_COLORIMETRIC
        Rendering intent constants, see PDF Reference 1.5 Section 4.5.4 Rendering Intents.
        See Also:
        Constant Field Values
      • RENDERING_INTENT_RELATIVE_COLORIMETRIC

        public static final java.lang.String RENDERING_INTENT_RELATIVE_COLORIMETRIC
        Rendering intent constants, see PDF Reference 1.5 Section 4.5.4 Rendering Intents.
        See Also:
        Constant Field Values
      • RENDERING_INTENT_SATURATION

        public static final java.lang.String RENDERING_INTENT_SATURATION
        Rendering intent constants, see PDF Reference 1.5 Section 4.5.4 Rendering Intents.
        See Also:
        Constant Field Values
      • RENDERING_INTENT_PERCEPTUAL

        public static final java.lang.String RENDERING_INTENT_PERCEPTUAL
        Rendering intent constants, see PDF Reference 1.5 Section 4.5.4 Rendering Intents.
        See Also:
        Constant Field Values
    • Constructor Detail

      • PDExtendedGraphicsState

        public PDExtendedGraphicsState()
        Default constructor, creates blank graphics state.
      • PDExtendedGraphicsState

        public PDExtendedGraphicsState​(COSDictionary dictionary)
        Create a graphics state from an existing dictionary.
        Parameters:
        dictionary - The existing graphics state.
    • Method Detail

      • copyIntoGraphicsState

        public void copyIntoGraphicsState​(PDGraphicsState gs)
                                   throws java.io.IOException
        This will implement the gs operator.
        Parameters:
        gs - The state to copy this dictionaries values into.
        Throws:
        java.io.IOException - If there is an error copying font information.
      • getCOSDictionary

        public COSDictionary getCOSDictionary()
        This will get the underlying dictionary that this class acts on.
        Returns:
        The underlying dictionary for this class.
      • getCOSObject

        public COSBase getCOSObject()
        Convert this standard java object to a COS object.
        Specified by:
        getCOSObject in interface COSObjectable
        Returns:
        The cos object that matches this Java object.
      • getLineWidth

        public java.lang.Float getLineWidth()
        This will get the line width. This will return null if there is no line width
        Returns:
        null or the LW value of the dictionary.
      • setLineWidth

        public void setLineWidth​(java.lang.Float width)
        This will set the line width.
        Parameters:
        width - The line width for the object.
      • getLineCapStyle

        public int getLineCapStyle()
        This will get the line cap style.
        Returns:
        null or the LC value of the dictionary.
      • setLineCapStyle

        public void setLineCapStyle​(int style)
        This will set the line cap style for the graphics state.
        Parameters:
        style - The new line cap style to set.
      • getLineJoinStyle

        public int getLineJoinStyle()
        This will get the line join style.
        Returns:
        null or the LJ value in the dictionary.
      • setLineJoinStyle

        public void setLineJoinStyle​(int style)
        This will set the line join style.
        Parameters:
        style - The new line join style.
      • getMiterLimit

        public java.lang.Float getMiterLimit()
        This will get the miter limit.
        Returns:
        null or the ML value in the dictionary.
      • setMiterLimit

        public void setMiterLimit​(java.lang.Float miterLimit)
        This will set the miter limit for the graphics state.
        Parameters:
        miterLimit - The new miter limit value
      • getLineDashPattern

        public PDLineDashPattern getLineDashPattern()
        This will get the dash pattern.
        Returns:
        null or the D value in the dictionary.
      • setLineDashPattern

        public void setLineDashPattern​(PDLineDashPattern dashPattern)
        This will set the dash pattern for the graphics state.
        Parameters:
        dashPattern - The dash pattern
      • getRenderingIntent

        public java.lang.String getRenderingIntent()
        This will get the rendering intent.
        Returns:
        null or the RI value in the dictionary.
      • setRenderingIntent

        public void setRenderingIntent​(java.lang.String ri)
        This will set the rendering intent for the graphics state.
        Parameters:
        ri - The new rendering intent
      • getStrokingOverprintControl

        public boolean getStrokingOverprintControl()
        This will get the overprint control.
        Returns:
        The overprint control or null if one has not been set.
      • setStrokingOverprintControl

        public void setStrokingOverprintControl​(boolean op)
        This will get the overprint control(OP).
        Parameters:
        op - The overprint control.
      • getNonStrokingOverprintControl

        public boolean getNonStrokingOverprintControl()
        This will get the overprint control for non stroking operations. If this value is null then the regular overprint control value will be returned.
        Returns:
        The overprint control or null if one has not been set.
      • setNonStrokingOverprintControl

        public void setNonStrokingOverprintControl​(boolean op)
        This will get the overprint control(OP).
        Parameters:
        op - The overprint control.
      • getOverprintMode

        public java.lang.Float getOverprintMode()
        This will get the overprint control mode.
        Returns:
        The overprint control mode or null if one has not been set.
      • setOverprintMode

        public void setOverprintMode​(java.lang.Float overprintMode)
        This will get the overprint mode(OPM).
        Parameters:
        overprintMode - The overprint mode
      • getFontSetting

        public PDFontSetting getFontSetting()
        This will get the font setting of the graphics state.
        Returns:
        The font setting.
      • setFontSetting

        public void setFontSetting​(PDFontSetting fs)
        This will set the font setting for this graphics state.
        Parameters:
        fs - The new font setting.
      • getFlatnessTolerance

        public java.lang.Float getFlatnessTolerance()
        This will get the flatness tolerance.
        Returns:
        The flatness tolerance or null if one has not been set.
      • setFlatnessTolerance

        public void setFlatnessTolerance​(java.lang.Float flatness)
        This will get the flatness tolerance.
        Parameters:
        flatness - The new flatness tolerance
      • getSmoothnessTolerance

        public java.lang.Float getSmoothnessTolerance()
        This will get the smothness tolerance.
        Returns:
        The smothness tolerance or null if one has not been set.
      • setSmoothnessTolerance

        public void setSmoothnessTolerance​(java.lang.Float smoothness)
        This will get the smoothness tolerance.
        Parameters:
        smoothness - The new smoothness tolerance
      • getAutomaticStrokeAdjustment

        public boolean getAutomaticStrokeAdjustment()
        This will get the automatic stroke adjustment flag.
        Returns:
        The automatic stroke adjustment flag or null if one has not been set.
      • setAutomaticStrokeAdjustment

        public void setAutomaticStrokeAdjustment​(boolean sa)
        This will get the automatic stroke adjustment flag.
        Parameters:
        sa - The new automatic stroke adjustment flag.
      • getStrokingAlphaConstant

        public java.lang.Float getStrokingAlphaConstant()
        This will get the stroking alpha constant.
        Returns:
        The stroking alpha constant or null if one has not been set.
      • setStrokingAlphaConstant

        public void setStrokingAlphaConstant​(java.lang.Float alpha)
        This will get the stroking alpha constant.
        Parameters:
        alpha - The new stroking alpha constant.
      • getNonStrokingAlphaConstant

        public java.lang.Float getNonStrokingAlphaConstant()
        This will get the non stroking alpha constant.
        Returns:
        The non stroking alpha constant or null if one has not been set.
      • setNonStrokingAlphaConstant

        public void setNonStrokingAlphaConstant​(java.lang.Float alpha)
        This will get the non stroking alpha constant.
        Parameters:
        alpha - The new non stroking alpha constant.
      • getAlphaSourceFlag

        public boolean getAlphaSourceFlag()
        This will get the alpha source flag.
        Returns:
        The alpha source flag.
      • setAlphaSourceFlag

        public void setAlphaSourceFlag​(boolean alpha)
        This will get the alpha source flag.
        Parameters:
        alpha - The alpha source flag.
      • getTextKnockoutFlag

        public boolean getTextKnockoutFlag()
        This will get the text knockout flag.
        Returns:
        The text knockout flag.
      • setTextKnockoutFlag

        public void setTextKnockoutFlag​(boolean tk)
        This will get the text knockout flag.
        Parameters:
        tk - The text knockout flag.