Package com.openhtmltopdf.pdfboxout

Interface PdfBoxOutputDevice

All Superinterfaces:
com.openhtmltopdf.extend.OutputDevice
All Known Implementing Classes:
PdfBoxFastOutputDevice, PdfBoxSlowOutputDevice
public interface PdfBoxOutputDevice
extends com.openhtmltopdf.extend.OutputDevice

  • Method Details

    • setWriter

      void setWriter​(org.apache.pdfbox.pdmodel.PDDocument writer)

    • getWriter

      org.apache.pdfbox.pdmodel.PDDocument getWriter()

    • initializePage

      void initializePage​(org.apache.pdfbox.pdmodel.PDPageContentStream currentPage, org.apache.pdfbox.pdmodel.PDPage page, float height)
      Start a page. A new PDF page starts a new content stream so all graphics state has to be set back to default.

    • finishPage

      void finishPage()

    • paintReplacedElement

      void paintReplacedElement​(com.openhtmltopdf.render.RenderingContext c, com.openhtmltopdf.render.BlockBox box)
      Specified by:
      paintReplacedElement in interface com.openhtmltopdf.extend.OutputDevice

    • paintBackground

      void paintBackground​(com.openhtmltopdf.render.RenderingContext c, com.openhtmltopdf.render.Box box)
      We use paintBackground to do extra stuff such as processing links, forms and form controls.
      Specified by:
      paintBackground in interface com.openhtmltopdf.extend.OutputDevice

    • getDeviceLength

      float getDeviceLength​(float length)
      Given a value in dots units, converts to PDF points.

    • drawBorderLine

      void drawBorderLine​(Shape bounds, int side, int lineWidth, boolean solid)
      Specified by:
      drawBorderLine in interface com.openhtmltopdf.extend.OutputDevice

    • setColor

      void setColor​(com.openhtmltopdf.css.parser.FSColor color)
      Specified by:
      setColor in interface com.openhtmltopdf.extend.OutputDevice

    • draw

      void draw​(Shape s)
      Specified by:
      draw in interface com.openhtmltopdf.extend.OutputDevice

    • drawRect

      void drawRect​(int x, int y, int width, int height)
      Specified by:
      drawRect in interface com.openhtmltopdf.extend.OutputDevice

    • drawOval

      void drawOval​(int x, int y, int width, int height)
      Specified by:
      drawOval in interface com.openhtmltopdf.extend.OutputDevice

    • fill

      void fill​(Shape s)
      Specified by:
      fill in interface com.openhtmltopdf.extend.OutputDevice

    • fillRect

      void fillRect​(int x, int y, int width, int height)
      Specified by:
      fillRect in interface com.openhtmltopdf.extend.OutputDevice

    • fillOval

      void fillOval​(int x, int y, int width, int height)
      Specified by:
      fillOval in interface com.openhtmltopdf.extend.OutputDevice

    • translate

      void translate​(double tx, double ty)
      Specified by:
      translate in interface com.openhtmltopdf.extend.OutputDevice

    • getRenderingHint

      Object getRenderingHint​(RenderingHints.Key key)
      Specified by:
      getRenderingHint in interface com.openhtmltopdf.extend.OutputDevice

    • setRenderingHint

      void setRenderingHint​(RenderingHints.Key key, Object value)
      Specified by:
      setRenderingHint in interface com.openhtmltopdf.extend.OutputDevice

    • setFont

      void setFont​(com.openhtmltopdf.render.FSFont font)
      Specified by:
      setFont in interface com.openhtmltopdf.extend.OutputDevice

    • drawString

      void drawString​(String s, float x, float y, com.openhtmltopdf.render.JustificationInfo info)

    • drawStringFast

      void drawStringFast​(String s, float x, float y, com.openhtmltopdf.render.JustificationInfo info, PdfBoxFontResolver.FontDescription desc, float fontSize)

    • getCurrentPage

      PdfContentStreamAdapter getCurrentPage()

    • getPage

      org.apache.pdfbox.pdmodel.PDPage getPage()

    • normalizeY

      float normalizeY​(float y, float pageHeight)
      Converts a top down unit to a bottom up PDF unit for the specified page height.

    • setStroke

      void setStroke​(Stroke s)
      Specified by:
      setStroke in interface com.openhtmltopdf.extend.OutputDevice

    • clip

      void clip​(Shape s)
      Specified by:
      clip in interface com.openhtmltopdf.extend.OutputDevice

    • getClip

      Shape getClip()
      Specified by:
      getClip in interface com.openhtmltopdf.extend.OutputDevice

    • popClip

      void popClip()
      Specified by:
      popClip in interface com.openhtmltopdf.extend.OutputDevice

    • pushClip

      void pushClip​(Shape s)
      Specified by:
      pushClip in interface com.openhtmltopdf.extend.OutputDevice

    • setClip

      void setClip​(Shape s)
      Specified by:
      setClip in interface com.openhtmltopdf.extend.OutputDevice

    • getStroke

      Stroke getStroke()
      Specified by:
      getStroke in interface com.openhtmltopdf.extend.OutputDevice

    • realizeImage

      void realizeImage​(PdfBoxImage img)

    • drawImage

      void drawImage​(com.openhtmltopdf.extend.FSImage fsImage, int x, int y, boolean interpolate)
      Specified by:
      drawImage in interface com.openhtmltopdf.extend.OutputDevice

    • getDotsPerPoint

      float getDotsPerPoint()

    • start

      void start​(Document doc)

    • finish

      void finish​(com.openhtmltopdf.render.RenderingContext c, com.openhtmltopdf.render.Box root)

    • addMetadata

      void addMetadata​(String name, String value)
      Appends a name/content metadata pair to this output device. A name or content value of null will be ignored.
      Parameters:
      name - the name of the metadata element to add.

    • getMetadataByName

      String getMetadataByName​(String name)
      Searches the metadata name/content pairs of the current document and returns the content value from the first pair with a matching name. The search is case insensitive.
      Parameters:
      name - the metadata element name to locate.
      Returns:
      the content value of the first found metadata element; otherwise null.

    • getMetadataListByName

      List<String> getMetadataListByName​(String name)
      Searches the metadata name/content pairs of the current document and returns any content values with a matching name in an ArrayList. The search is case insensitive.
      Parameters:
      name - the metadata element name to locate.
      Returns:
      an ArrayList with matching content values; otherwise an empty list.

    • setMetadata

      void setMetadata​(String name, String value)
      Replaces all copies of the named metadata with a single value. A a new value of null will result in the removal of all copies of the named metadata. Use addMetadata to append additional values with the same name.
      Parameters:
      name - the metadata element name to locate.

    • getSharedContext

      com.openhtmltopdf.layout.SharedContext getSharedContext()

    • setSharedContext

      void setSharedContext​(com.openhtmltopdf.layout.SharedContext sharedContext)

    • setRoot

      void setRoot​(com.openhtmltopdf.render.Box root)

    • getStartPageNo

      int getStartPageNo()

    • setStartPageNo

      void setStartPageNo​(int startPageNo)

    • drawSelection

      void drawSelection​(com.openhtmltopdf.render.RenderingContext c, com.openhtmltopdf.render.InlineText inlineText)
      Specified by:
      drawSelection in interface com.openhtmltopdf.extend.OutputDevice

    • isSupportsSelection

      boolean isSupportsSelection()
      Specified by:
      isSupportsSelection in interface com.openhtmltopdf.extend.OutputDevice

    • isSupportsCMYKColors

      boolean isSupportsCMYKColors()
      Specified by:
      isSupportsCMYKColors in interface com.openhtmltopdf.extend.OutputDevice

    • drawWithGraphics

      void drawWithGraphics​(float x, float y, float width, float height, com.openhtmltopdf.extend.OutputDeviceGraphicsDrawer renderer)
      Specified by:
      drawWithGraphics in interface com.openhtmltopdf.extend.OutputDevice

    • findPagePositionsByID

      List<PagePosition> findPagePositionsByID​(com.openhtmltopdf.css.style.CssContext c, Pattern pattern)

    • setRenderingContext

      void setRenderingContext​(com.openhtmltopdf.render.RenderingContext result)

    • setBidiReorderer

      void setBidiReorderer​(com.openhtmltopdf.bidi.BidiReorderer reorderer)

    • popTransforms

      void popTransforms​(List<AffineTransform> inverse)
      Specified by:
      popTransforms in interface com.openhtmltopdf.extend.OutputDevice

    • pushTransforms

      List<AffineTransform> pushTransforms​(List<AffineTransform> transforms)
      Specified by:
      pushTransforms in interface com.openhtmltopdf.extend.OutputDevice

    • getAbsoluteTransformOriginX

      float getAbsoluteTransformOriginX()
      Specified by:
      getAbsoluteTransformOriginX in interface com.openhtmltopdf.extend.OutputDevice

    • getAbsoluteTransformOriginY

      float getAbsoluteTransformOriginY()
      Specified by:
      getAbsoluteTransformOriginY in interface com.openhtmltopdf.extend.OutputDevice

    • setPaint

      void setPaint​(Paint paint)
      Specified by:
      setPaint in interface com.openhtmltopdf.extend.OutputDevice

    • isPDF

      boolean isPDF()
      Specified by:
      isPDF in interface com.openhtmltopdf.extend.OutputDevice

    • close

      void close()
      Perform any internal cleanup needed

    • pushTransformLayer

      void pushTransformLayer​(AffineTransform transform)
      Specified by:
      pushTransformLayer in interface com.openhtmltopdf.extend.OutputDevice

    • popTransformLayer

      void popTransformLayer()
      Specified by:
      popTransformLayer in interface com.openhtmltopdf.extend.OutputDevice

    • isFastRenderer

      boolean isFastRenderer()
      Specified by:
      isFastRenderer in interface com.openhtmltopdf.extend.OutputDevice

    • getPageRefY

      int getPageRefY​(com.openhtmltopdf.render.Box box)

    • getMetadata

      List<com.openhtmltopdf.pdfboxout.PdfBoxSlowOutputDevice.Metadata> getMetadata()

    • drawPdfAsImage

      void drawPdfAsImage​(org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject _src, Rectangle contentBounds, float intrinsicWidth, float intrinsicHeight)