Class PdfPatternPainter


public final class PdfPatternPainter extends PdfTemplate
Implements the pattern.
  • Field Details

    • xstep

      float xstep
    • ystep

      float ystep
    • stencil

      boolean stencil
    • defaultColor

      Color defaultColor
  • Constructor Details

    • PdfPatternPainter

      private PdfPatternPainter()
      Creates a PdfPattern.
    • PdfPatternPainter

      PdfPatternPainter(PdfWriter wr)
      Creates new PdfPattern
      Parameters:
      wr - the PdfWriter
    • PdfPatternPainter

      PdfPatternPainter(PdfWriter wr, Color defaultColor)
  • Method Details

    • getXStep

      public float getXStep()
      Returns the horizontal interval when repeating the pattern.
      Returns:
      a value
    • setXStep

      public void setXStep(float xstep)
      Sets the horizontal interval of this pattern.
      Parameters:
      xstep - the xstep in horizontal painting
    • getYStep

      public float getYStep()
      Returns the vertical interval when repeating the pattern.
      Returns:
      a value
    • setYStep

      public void setYStep(float ystep)
      Sets the vertical interval of this pattern.
      Parameters:
      ystep - in vertical painting
    • isStencil

      public boolean isStencil()
      Tells you if this pattern is colored/uncolored (stencil = uncolored, you need to set a default color).
      Returns:
      true if the pattern is an uncolored tiling pattern (stencil).
    • setPatternMatrix

      public void setPatternMatrix(float a, float b, float c, float d, float e, float f)
      Sets the transformation matrix for the pattern.
      Parameters:
      a - an element of the transformation matrix
      b - an element of the transformation matrix
      c - an element of the transformation matrix
      d - an element of the transformation matrix
      e - an element of the transformation matrix
      f - an element of the transformation matrix
    • getPattern

      PdfPattern getPattern()
      Gets the stream representing this pattern
      Returns:
      the stream representing this pattern
    • getPattern

      PdfPattern getPattern(int compressionLevel)
      Gets the stream representing this pattern
      Parameters:
      compressionLevel - the compression level of the stream
      Returns:
      the stream representing this pattern
      Since:
      2.1.3
    • getDuplicate

      public PdfContentByte getDuplicate()
      Gets a duplicate of this PdfPatternPainter. All the members are copied by reference but the buffer stays different.
      Overrides:
      getDuplicate in class PdfTemplate
      Returns:
      a copy of this PdfPatternPainter
    • getDefaultColor

      public Color getDefaultColor()
      Returns the default color of the pattern.
      Returns:
      a Color
    • setGrayFill

      public void setGrayFill(float gray)
      Description copied from class: PdfContentByte
      Changes the currentgray tint for filling paths (device dependent colors!).

      Sets the color space to DeviceGray (or the DefaultGray color space), and sets the gray tint to use for filling paths.

      Overrides:
      setGrayFill in class PdfContentByte
      Parameters:
      gray - a value between 0 (black) and 1 (white)
      See Also:
    • resetGrayFill

      public void resetGrayFill()
      Description copied from class: PdfContentByte
      Changes the current gray tint for filling paths to black.
      Overrides:
      resetGrayFill in class PdfContentByte
      See Also:
    • setGrayStroke

      public void setGrayStroke(float gray)
      Description copied from class: PdfContentByte
      Changes the currentgray tint for stroking paths (device dependent colors!).

      Sets the color space to DeviceGray (or the DefaultGray color space), and sets the gray tint to use for stroking paths.

      Overrides:
      setGrayStroke in class PdfContentByte
      Parameters:
      gray - a value between 0 (black) and 1 (white)
      See Also:
    • resetGrayStroke

      public void resetGrayStroke()
      Description copied from class: PdfContentByte
      Changes the current gray tint for stroking paths to black.
      Overrides:
      resetGrayStroke in class PdfContentByte
      See Also:
    • setRGBColorFillF

      public void setRGBColorFillF(float red, float green, float blue)
      Description copied from class: PdfContentByte
      Changes the current color for filling paths (device dependent colors!).

      Sets the color space to DeviceRGB (or the DefaultRGB color space), and sets the color to use for filling paths.

      Following the PDF manual, each operand must be a number between 0 (minimum intensity) and 1 (maximum intensity).

      Overrides:
      setRGBColorFillF in class PdfContentByte
      Parameters:
      red - the intensity of red. A value between 0 and 1
      green - the intensity of green. A value between 0 and 1
      blue - the intensity of blue. A value between 0 and 1
      See Also:
    • resetRGBColorFill

      public void resetRGBColorFill()
      Description copied from class: PdfContentByte
      Changes the current color for filling paths to black. Resetting using gray color to keep the backward compatibility.
      Overrides:
      resetRGBColorFill in class PdfContentByte
      See Also:
    • setRGBColorStrokeF

      public void setRGBColorStrokeF(float red, float green, float blue)
      Description copied from class: PdfContentByte
      Changes the current color for stroking paths (device dependent colors!).

      Sets the color space to DeviceRGB (or the DefaultRGB color space), and sets the color to use for stroking paths.

      Following the PDF manual, each operand must be a number between 0 (miniumum intensity) and 1 (maximum intensity).

      Overrides:
      setRGBColorStrokeF in class PdfContentByte
      Parameters:
      red - the intensity of red. A value between 0 and 1
      green - the intensity of green. A value between 0 and 1
      blue - the intensity of blue. A value between 0 and 1
      See Also:
    • resetRGBColorStroke

      public void resetRGBColorStroke()
      Description copied from class: PdfContentByte
      Changes the current color for stroking paths to black. Resetting using gray color to keep the backward compatibility.
      Overrides:
      resetRGBColorStroke in class PdfContentByte
      See Also:
    • setCMYKColorFillF

      public void setCMYKColorFillF(float cyan, float magenta, float yellow, float black)
      Description copied from class: PdfContentByte
      Changes the current color for filling paths (device dependent colors!).

      Sets the color space to DeviceCMYK (or the DefaultCMYK color space), and sets the color to use for filling paths.

      Following the PDF manual, each operand must be a number between 0 (no ink) and 1 (maximum ink).

      Overrides:
      setCMYKColorFillF in class PdfContentByte
      Parameters:
      cyan - the intensity of cyan. A value between 0 and 1
      magenta - the intensity of magenta. A value between 0 and 1
      yellow - the intensity of yellow. A value between 0 and 1
      black - the intensity of black. A value between 0 and 1
      See Also:
    • resetCMYKColorFill

      public void resetCMYKColorFill()
      Description copied from class: PdfContentByte
      Changes the current color for filling paths to black.
      Overrides:
      resetCMYKColorFill in class PdfContentByte
      See Also:
    • setCMYKColorStrokeF

      public void setCMYKColorStrokeF(float cyan, float magenta, float yellow, float black)
      Description copied from class: PdfContentByte
      Changes the current color for stroking paths (device dependent colors!).

      Sets the color space to DeviceCMYK (or the DefaultCMYK color space), and sets the color to use for stroking paths.

      Following the PDF manual, each operand must be a number between 0 (miniumum intensity) and 1 (maximum intensity).

      Overrides:
      setCMYKColorStrokeF in class PdfContentByte
      Parameters:
      cyan - the intensity of cyan. A value between 0 and 1
      magenta - the intensity of magenta. A value between 0 and 1
      yellow - the intensity of yellow. A value between 0 and 1
      black - the intensity of black. A value between 0 and 1
      See Also:
    • resetCMYKColorStroke

      public void resetCMYKColorStroke()
      Description copied from class: PdfContentByte
      Changes the current color for stroking paths to black.
      Overrides:
      resetCMYKColorStroke in class PdfContentByte
      See Also:
    • addImage

      public void addImage(Image image, float a, float b, float c, float d, float e, float f) throws DocumentException
      Description copied from class: PdfContentByte
      Adds an Image to the page. The positioning of the Image is done with the transformation matrix. To position an image at (x,y) use addImage(image, image_width, 0, 0, image_height, x, y).
      Overrides:
      addImage in class PdfContentByte
      Parameters:
      image - the Image object
      a - an element of the transformation matrix
      b - an element of the transformation matrix
      c - an element of the transformation matrix
      d - an element of the transformation matrix
      e - an element of the transformation matrix
      f - an element of the transformation matrix
      Throws:
      DocumentException - on error
      See Also:
    • setCMYKColorFill

      public void setCMYKColorFill(int cyan, int magenta, int yellow, int black)
      Description copied from class: PdfContentByte
      Changes the current color for filling paths (device dependent colors!).

      Sets the color space to DeviceCMYK (or the DefaultCMYK color space), and sets the color to use for filling paths.

      This method is described in the 'Portable Document Format Reference Manual version 1.3' section 8.5.2.1 (page 331).

      Following the PDF manual, each operand must be a number between 0 (no ink) and 1 (maximum ink). This method however accepts only integers between 0x00 and 0xFF.

      Overrides:
      setCMYKColorFill in class PdfContentByte
      Parameters:
      cyan - the intensity of cyan
      magenta - the intensity of magenta
      yellow - the intensity of yellow
      black - the intensity of black
      See Also:
    • setCMYKColorStroke

      public void setCMYKColorStroke(int cyan, int magenta, int yellow, int black)
      Description copied from class: PdfContentByte
      Changes the current color for stroking paths (device dependent colors!).

      Sets the color space to DeviceCMYK (or the DefaultCMYK color space), and sets the color to use for stroking paths.

      This method is described in the 'Portable Document Format Reference Manual version 1.3' section 8.5.2.1 (page 331).

      Following the PDF manual, each operand must be a number between 0 (minimum intensity) and 1 (maximum intensity). This method however accepts only integers between 0x00 and 0xFF.
      Overrides:
      setCMYKColorStroke in class PdfContentByte
      Parameters:
      cyan - the intensity of red
      magenta - the intensity of green
      yellow - the intensity of blue
      black - the intensity of black
      See Also:
    • setRGBColorFill

      public void setRGBColorFill(int red, int green, int blue)
      Description copied from class: PdfContentByte
      Changes the current color for filling paths (device dependent colors!).

      Sets the color space to DeviceRGB (or the DefaultRGB color space), and sets the color to use for filling paths.

      This method is described in the 'Portable Document Format Reference Manual version 1.3' section 8.5.2.1 (page 331).

      Following the PDF manual, each operand must be a number between 0 (minimum intensity) and 1 (maximum intensity). This method however accepts only integers between 0x00 and 0xFF.

      Overrides:
      setRGBColorFill in class PdfContentByte
      Parameters:
      red - the intensity of red
      green - the intensity of green
      blue - the intensity of blue
      See Also:
    • setRGBColorStroke

      public void setRGBColorStroke(int red, int green, int blue)
      Description copied from class: PdfContentByte
      Changes the current color for stroking paths (device dependent colors!).

      Sets the color space to DeviceRGB (or the DefaultRGB color space), and sets the color to use for stroking paths.

      This method is described in the 'Portable Document Format Reference Manual version 1.3' section 8.5.2.1 (page 331).

      Following the PDF manual, each operand must be a number between 0 (minimum intensity) and 1 (maximum intensity). This method however accepts only integers between 0x00 and 0xFF.
      Overrides:
      setRGBColorStroke in class PdfContentByte
      Parameters:
      red - the intensity of red
      green - the intensity of green
      blue - the intensity of blue
      See Also:
    • setColorStroke

      public void setColorStroke(Color color)
      Description copied from class: PdfContentByte
      Sets the stroke color. color can be an ExtendedColor.
      Overrides:
      setColorStroke in class PdfContentByte
      Parameters:
      color - the color
      See Also:
    • setColorFill

      public void setColorFill(Color color)
      Description copied from class: PdfContentByte
      Sets the fill color. color can be an ExtendedColor.
      Overrides:
      setColorFill in class PdfContentByte
      Parameters:
      color - the color
      See Also:
    • setColorFill

      public void setColorFill(PdfSpotColor sp, float tint)
      Description copied from class: PdfContentByte
      Sets the fill color to a spot color.
      Overrides:
      setColorFill in class PdfContentByte
      Parameters:
      sp - the spot color
      tint - the tint for the spot color. 0 is no color and 1 is 100% color
      See Also:
    • setColorStroke

      public void setColorStroke(PdfSpotColor sp, float tint)
      Description copied from class: PdfContentByte
      Sets the stroke color to a spot color.
      Overrides:
      setColorStroke in class PdfContentByte
      Parameters:
      sp - the spot color
      tint - the tint for the spot color. 0 is no color and 1 is 100% color
      See Also:
    • setPatternFill

      public void setPatternFill(PdfPatternPainter p)
      Description copied from class: PdfContentByte
      Sets the fill color to a pattern. The pattern can be colored or uncolored.
      Overrides:
      setPatternFill in class PdfContentByte
      Parameters:
      p - the pattern
      See Also:
    • setPatternFill

      public void setPatternFill(PdfPatternPainter p, Color color, float tint)
      Description copied from class: PdfContentByte
      Sets the fill color to an uncolored pattern.
      Overrides:
      setPatternFill in class PdfContentByte
      Parameters:
      p - the pattern
      color - the color of the pattern
      tint - the tint if the color is a spot color, ignored otherwise
      See Also:
    • setPatternStroke

      public void setPatternStroke(PdfPatternPainter p, Color color, float tint)
      Description copied from class: PdfContentByte
      Sets the stroke color to an uncolored pattern.
      Overrides:
      setPatternStroke in class PdfContentByte
      Parameters:
      p - the pattern
      color - the color of the pattern
      tint - the tint if the color is a spot color, ignored otherwise
      See Also:
    • setPatternStroke

      public void setPatternStroke(PdfPatternPainter p)
      Description copied from class: PdfContentByte
      Sets the stroke color to a pattern. The pattern can be colored or uncolored.
      Overrides:
      setPatternStroke in class PdfContentByte
      Parameters:
      p - the pattern
      See Also:
    • checkNoColor

      void checkNoColor()