From 835256964f3fa64587a0e05b859d012d125be308 Mon Sep 17 00:00:00 2001 From: Andreas Fitzek Date: Thu, 20 Feb 2014 10:54:04 +0100 Subject: Documentation update --- .../at/knowcenter/wag/egov/egiz/pdf/PDFPage.html | 590 +++++++++++++++++++++ 1 file changed, 590 insertions(+) create mode 100644 docs/full/at/knowcenter/wag/egov/egiz/pdf/PDFPage.html (limited to 'docs/full/at/knowcenter/wag/egov/egiz/pdf/PDFPage.html') diff --git a/docs/full/at/knowcenter/wag/egov/egiz/pdf/PDFPage.html b/docs/full/at/knowcenter/wag/egov/egiz/pdf/PDFPage.html new file mode 100644 index 00000000..1f2ec744 --- /dev/null +++ b/docs/full/at/knowcenter/wag/egov/egiz/pdf/PDFPage.html @@ -0,0 +1,590 @@ + + + + + +PDFPage + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
at.knowcenter.wag.egov.egiz.pdf
+

Class PDFPage

+
+
+ +
+
    +
  • +
    +
    +
    public class PDFPage
+extends org.apache.pdfbox.util.PDFTextStripper
    +
    PDFPage is an inner class that is used to calculate the page length of a PDF + Document page. It extends the PDFTextStripper class and implement one + interested method: showCharacter(TextPosition)
    + This method is called when processing the FileStream. By calling the method + org.apache.pdfbox.util.PDFStreamEngine#processStream(org.apache.pdfbox.pdmodel.PDPage, org.apache.pdfbox.pdmodel.PDResources, org.pdfbox.cos.COSStream) + the implemented method showCharacter is called.
    +
    See Also:
    PDFTextStripper
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      class PDFPage.MyInvoke 
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      protected floateffectivePageHeight +
      The effective page height.
      +
      protected floatmax_character_ypos +
      The maximum (lowest) y position of a character.
      +
      protected floatmax_image_ypos +
      The maximum (lowest y position of an image.
      +
      +
        +
      • + + +

        Fields inherited from class org.apache.pdfbox.util.PDFTextStripper

        +charactersByArticle, document, output, outputEncoding, systemLineSeparator
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      PDFPage(float effectivePageHeight, + boolean legacy32) +
      Constructor.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static floatfindMaxX(Pos[] coordinates) 
      static floatfindMaxY(Pos[] coordinates) 
      static floatfindMinX(Pos[] coordinates) 
      static floatfindMinY(Pos[] coordinates) 
      java.awt.geom.GeneralPathgetCurrentPath() +
      Returns the path currently being constructed.
      +
      floatgetMaxPageLength() +
      Returns the calculated page length.
      +
      protected voidprocessOperator(org.apache.pdfbox.util.PDFOperator operator, + java.util.List arguments) 
      protected voidprocessTextPosition(org.apache.pdfbox.util.TextPosition text) 
      voidregisterPathBounds(java.awt.Rectangle bounds) +
      Registers a rectangle that bounds the path currently being drawn.
      +
      voidsetCurrentPath(java.awt.geom.GeneralPath currentPath) +
      Sets the current path.
      +
      protected voidshowCharacter(org.apache.pdfbox.util.TextPosition text) +
      A method provided as an event interface to allow a subclass to perform + some specific functionality when a character needs to be displayed.
      +
      static PostranstormCoordinate(Pos pos, + org.apache.pdfbox.util.Matrix m) 
      static Pos[]transtormCoordinates(Pos[] coordinates, + org.apache.pdfbox.util.Matrix m) 
      +
        +
      • + + +

        Methods inherited from class org.apache.pdfbox.util.PDFTextStripper

        +endArticle, endDocument, endPage, getAddMoreFormatting, getArticleEnd, getArticleStart, getAverageCharTolerance, getCharactersByArticle, getCurrentPageNo, getDropThreshold, getEndBookmark, getEndPage, getIndentThreshold, getLineSeparator, getListItemPatterns, getOutput, getPageEnd, getPageSeparator, getPageStart, getParagraphEnd, getParagraphStart, getSeparateByBeads, getSortByPosition, getSpacingTolerance, getStartBookmark, getStartPage, getSuppressDuplicateOverlappingText, getText, getText, getWordSeparator, handleLineSeparation, inspectFontEncoding, isParagraphSeparation, matchListItemPattern, matchPattern, processPage, processPages, resetEngine, setAddMoreFormatting, setArticleEnd, setArticleStart, setAverageCharTolerance, setDropThreshold, setEndBookmark, setEndPage, setIndentThreshold, setLineSeparator, setListItemPatterns, setPageEnd, setPageSeparator, setPageStart, setParagraphEnd, setParagraphStart, setShouldSeparateByBeads, setSortByPosition, setSpacingTolerance, setStartBookmark, setStartPage, setSuppressDuplicateOverlappingText, setWordSeparator, startArticle, startArticle, startDocument, startPage, writeCharacters, writeLineSeparator, writePage, writePageEnd, writePageSeperator, writePageStart, writeParagraphEnd, writeParagraphSeparator, writeParagraphStart, writeString, writeText, writeText, writeWordSeparator
        • +
      +
        +
      • + + +

        Methods inherited from class org.apache.pdfbox.util.PDFStreamEngine

        +getColorSpaces, getCurrentPage, getFonts, getGraphicsStack, getGraphicsState, getGraphicsStates, getResources, getTextLineMatrix, getTextMatrix, getTotalCharCnt, getValidCharCnt, getXObjects, isForceParsing, processEncodedText, processOperator, processStream, processSubStream, registerOperatorProcessor, setColorSpaces, setFonts, setForceParsing, setGraphicsStack, setGraphicsState, setGraphicsStates, setTextLineMatrix, setTextMatrix
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        max_character_ypos

        +
        protected float max_character_ypos
        +
        The maximum (lowest) y position of a character.
        +
        • +
      + + + +
        +
      • +

        max_image_ypos

        +
        protected float max_image_ypos
        +
        The maximum (lowest y position of an image.
        +
        • +
      + + + +
        +
      • +

        effectivePageHeight

        +
        protected float effectivePageHeight
        +
        The effective page height.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PDFPage

        +
        public PDFPage(float effectivePageHeight,
+       boolean legacy32)
+        throws java.io.IOException
        +
        Constructor.
        +
        Parameters:
        effectivePageHeight - The height of the page to be evaluated. PDF elements outside + this height will not be considered.
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getCurrentPath

        +
        public java.awt.geom.GeneralPath getCurrentPath()
        +
        Returns the path currently being constructed.
        +
        Returns:
        The path currently being constructed.
        +
        • +
      + + + +
        +
      • +

        setCurrentPath

        +
        public void setCurrentPath(java.awt.geom.GeneralPath currentPath)
        +
        Sets the current path.
        +
        Parameters:
        currentPath - The new current path.
        +
        • +
      + + + +
        +
      • +

        registerPathBounds

        +
        public void registerPathBounds(java.awt.Rectangle bounds)
        +
        Registers a rectangle that bounds the path currently being drawn.
        +
        Parameters:
        bounds - A rectangle depicting the bounds (coordinates originating from + bottom left).
        +
        • +
      + + + +
        +
      • +

        processOperator

        +
        protected void processOperator(org.apache.pdfbox.util.PDFOperator operator,
+                   java.util.List arguments)
+                        throws java.io.IOException
        +
        +
        Overrides:
        +
        processOperator in class org.apache.pdfbox.util.PDFStreamEngine
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        processTextPosition

        +
        protected void processTextPosition(org.apache.pdfbox.util.TextPosition text)
        +
        +
        Overrides:
        +
        processTextPosition in class org.apache.pdfbox.util.PDFTextStripper
        +
        +
        • +
      + + + +
        +
      • +

        showCharacter

        +
        protected void showCharacter(org.apache.pdfbox.util.TextPosition text)
        +
        A method provided as an event interface to allow a subclass to perform + some specific functionality when a character needs to be displayed. This + method is used to calculate the latest position of a text in the page. + Sorry for this missinterpretation of the method, but it is the only way + to do this (provided by PDFBox)!!!
        +
        Parameters:
        text - the character to be displayed -> calculate there y position.
        +
        • +
      + + + +
        +
      • +

        getMaxPageLength

        +
        public float getMaxPageLength()
        +
        Returns the calculated page length.
        +
        Returns:
        the max page length value
        +
        • +
      + + + +
        +
      • +

        transtormCoordinates

        +
        public static Pos[] transtormCoordinates(Pos[] coordinates,
+                         org.apache.pdfbox.util.Matrix m)
        +
        • +
      + + + +
        +
      • +

        transtormCoordinate

        +
        public static Pos transtormCoordinate(Pos pos,
+                      org.apache.pdfbox.util.Matrix m)
        +
        • +
      + + + +
        +
      • +

        findMinY

        +
        public static float findMinY(Pos[] coordinates)
        +
        • +
      + + + +
        +
      • +

        findMaxY

        +
        public static float findMaxY(Pos[] coordinates)
        +
        • +
      + + + +
        +
      • +

        findMaxX

        +
        public static float findMaxX(Pos[] coordinates)
        +
        • +
      + + + +
        +
      • +

        findMinX

        +
        public static float findMinX(Pos[] coordinates)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + -- cgit v1.2.3