Package com.tom_roush.pdfbox.pdmodel.graphics.state

Class PDExtendedGraphicsState

    • 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 IOException
        This will implement the gs operator.
        Parameters:
        gs - The state to copy this dictionaries values into.
        Throws:
        IOException - If there is an error copying font information.

      • getCOSObject

        public COSDictionary getCOSObject()
        This will get the underlying dictionary that this class acts on.
        Specified by:
        getCOSObject in interface COSObjectable
        Returns:
        The underlying dictionary for this class.

      • getLineWidth

        public 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​(Float width)
        This will set the line width.
        Parameters:
        width - The line width for the object.

      • getLineCapStyle

        public Paint.Cap 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 Paint.Join 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 Float getMiterLimit()
        This will get the miter limit.
        Returns:
        null or the ML value in the dictionary.

      • setMiterLimit

        public void setMiterLimit​(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 RenderingIntent getRenderingIntent()
        This will get the rendering intent.
        Returns:
        null or the RI value in the dictionary.

      • setRenderingIntent

        public void setRenderingIntent​(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 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​(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 Float getFlatnessTolerance()
        This will get the flatness tolerance.
        Returns:
        The flatness tolerance or null if one has not been set.

      • setFlatnessTolerance

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

      • getSmoothnessTolerance

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

      • setSmoothnessTolerance

        public void setSmoothnessTolerance​(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 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​(Float alpha)
        This will get the stroking alpha constant.
        Parameters:
        alpha - The new stroking alpha constant.

      • getNonStrokingAlphaConstant

        public 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​(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 (“alpha is shape”), that specifies whether the current soft mask and alpha constant shall be interpreted as shape values (true) or opacity values (false).
        Returns:
        The alpha source flag.

      • setAlphaSourceFlag

        public void setAlphaSourceFlag​(boolean alpha)
        This will get the alpha source flag (“alpha is shape”), that specifies whether the current soft mask and alpha constant shall be interpreted as shape values (true) or opacity values (false).
        Parameters:
        alpha - The alpha source flag.

      • getBlendMode

        public BlendMode getBlendMode()
        Returns the blending mode stored in the COS dictionary
        Returns:
        the blending mode

      • setBlendMode

        public void setBlendMode​(BlendMode bm)
        Set the blending mode.
        Parameters:
        bm -

      • getSoftMask

        public PDSoftMask getSoftMask()
        Returns the soft mask stored in the COS dictionary
        Returns:
        the soft mask or null if there isn't any.

      • 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.

      • getTransfer

        public COSBase getTransfer()
        This will get the transfer function of the /TR dictionary.
        Returns:
        The transfer function. According to the PDF specification, this is either a single function (which applies to all process colorants) or an array of four functions (which apply to the process colorants individually). The name Identity may be used to represent the identity function.

      • setTransfer

        public void setTransfer​(COSBase transfer)
        This will set the transfer function of the /TR dictionary.
        Parameters:
        transfer - The transfer function. According to the PDF specification, this is either a single function (which applies to all process colorants) or an array of four functions (which apply to the process colorants individually). The name Identity may be used to represent the identity function.

      • getTransfer2

        public COSBase getTransfer2()
        This will get the transfer function of the /TR2 dictionary.
        Returns:
        The transfer function. According to the PDF specification, this is either a single function (which applies to all process colorants) or an array of four functions (which apply to the process colorants individually). The name Identity may be used to represent the identity function, and the name Default denotes the transfer function that was in effect at the start of the page.

      • setTransfer2

        public void setTransfer2​(COSBase transfer2)
        This will set the transfer function of the /TR2 dictionary.
        Parameters:
        transfer2 - The transfer function. According to the PDF specification, this is either a single function (which applies to all process colorants) or an array of four functions (which apply to the process colorants individually). The name Identity may be used to represent the identity function, and the name Default denotes the transfer function that was in effect at the start of the page.