From 87c9269152f8c631123525b796cf07dc0cca7398 Mon Sep 17 00:00:00 2001 From: Andreas Fitzek Date: Wed, 5 Feb 2014 09:20:54 +0100 Subject: Documentation + Documentation building --- .../placeholder/SignaturePlaceholderContext.html | 263 ++++++++++++ .../impl/placeholder/SignaturePlaceholderData.html | 454 +++++++++++++++++++++ .../placeholder/SignaturePlaceholderExtractor.html | 356 ++++++++++++++++ .../pdfas/lib/impl/positioning/Positioning.html | 369 +++++++++++++++++ 4 files changed, 1442 insertions(+) create mode 100644 docs/at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderContext.html create mode 100644 docs/at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderData.html create mode 100644 docs/at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderExtractor.html create mode 100644 docs/at/gv/egiz/pdfas/lib/impl/positioning/Positioning.html (limited to 'docs/at/gv/egiz/pdfas/lib/impl') diff --git a/docs/at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderContext.html b/docs/at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderContext.html new file mode 100644 index 00000000..e4863c26 --- /dev/null +++ b/docs/at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderContext.html @@ -0,0 +1,263 @@ + + + + + + +SignaturePlaceholderContext (PDF-AS 4.0 Library) + + + + + + + +
+ + + + + +
PDF-AS 4.0 Library false
+
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
at.gv.egiz.pdfas.lib.impl.placeholder
+

Class SignaturePlaceholderContext

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        isSignaturePlaceholderDataSet

        +
        public static boolean isSignaturePlaceholderDataSet()
        +
        Returns:
        true if there is currently a SignaturePlaceholderData bound to this thread, false otherwise.
        +
        • +
      + + + +
        +
      • +

        setSignaturePlaceholderData

        +
        public static void setSignaturePlaceholderData(SignaturePlaceholderData data)
        +
        Bind a SignaturePlaceholderData to this thread. + If the given data is null, the context will be cleared.
        +
        Parameters:
        data - if null, clears the ThreadLocal, else binds the data to the current thread.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
PDF-AS 4.0 Library false
+
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderData.html b/docs/at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderData.html new file mode 100644 index 00000000..86fc0403 --- /dev/null +++ b/docs/at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderData.html @@ -0,0 +1,454 @@ + + + + + + +SignaturePlaceholderData (PDF-AS 4.0 Library) + + + + + + + +
+ + + + + +
PDF-AS 4.0 Library false
+
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
at.gv.egiz.pdfas.lib.impl.placeholder
+

Class SignaturePlaceholderData

+
+
+ +
+
    +
  • +
    +
    +
    public class SignaturePlaceholderData
+extends Object
    +
    This class represents all the data which can be extracted from a placeholder image.
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SignaturePlaceholderData

        +
        public SignaturePlaceholderData(String profile,
+                        String type,
+                        String sigKey,
+                        String id)
        +
        Parameters:
        profile -
        type -
        sigKey -
        id -
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getTablePos

        +
        public TablePos getTablePos()
        +
        Get the table position for the signature block.
        + The table position is created from the page number, the upper left corner and the width of the placeholder image.
        +
        Returns:
        +
        • +
      + + + +
        +
      • +

        getProfile

        +
        public String getProfile()
        +
        The profile name. Might be null if not included in the qr-code.
        +
        Returns:
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public String getType()
        +
        The signature type: "textual" or "binary". Might be null if not included in the qr-code.
        +
        Returns:
        +
        • +
      + + + +
        +
      • +

        getKey

        +
        public String getKey()
        +
        The key identifier for MOA signature. Might be null if not included in the qr-code.
        +
        Returns:
        +
        • +
      + + + + + + + +
        +
      • +

        getPlaceholderName

        +
        public String getPlaceholderName()
        +
        The name of the placeholder image.
        +
        Returns:
        +
        • +
      + + + +
        +
      • +

        getId

        +
        public String getId()
        +
        The id associated with this placeholder.
        +
        Returns:
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
PDF-AS 4.0 Library false
+
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderExtractor.html b/docs/at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderExtractor.html new file mode 100644 index 00000000..a3ea9e56 --- /dev/null +++ b/docs/at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderExtractor.html @@ -0,0 +1,356 @@ + + + + + + +SignaturePlaceholderExtractor (PDF-AS 4.0 Library) + + + + + + + +
+ + + + + +
PDF-AS 4.0 Library false
+
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
at.gv.egiz.pdfas.lib.impl.placeholder
+

Class SignaturePlaceholderExtractor

+
+
+ +
+
    +
  • +
    +
    +
    public class SignaturePlaceholderExtractor
+extends org.apache.pdfbox.util.PDFStreamEngine
    +
    Extract all relevant information from a placeholder image.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static SignaturePlaceholderDataextract(InputStream inputStream, + String placeholderId, + int matchMode) +
      Search the document for placeholder images and possibly included + additional info.
      + Searches only for the first placeholder page after page from top.
      +
      protected voidprocessOperator(org.apache.pdfbox.util.PDFOperator operator, + List arguments) 
      +
        +
      • + + +

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

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

      Field Detail

      + + + + + + + +
        +
      • +

        PLACEHOLDER_MATCH_MODE_STRICT

        +
        public static final int PLACEHOLDER_MATCH_MODE_STRICT
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        PLACEHOLDER_MATCH_MODE_MODERATE

        +
        public static final int PLACEHOLDER_MATCH_MODE_MODERATE
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        PLACEHOLDER_MATCH_MODE_LENIENT

        +
        public static final int PLACEHOLDER_MATCH_MODE_LENIENT
        +
        See Also:
        Constant Field Values
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        extract

        +
        public static SignaturePlaceholderData extract(InputStream inputStream,
+                               String placeholderId,
+                               int matchMode)
+                                        throws at.gv.egiz.pdfas.common.exceptions.PdfAsException
        +
        Search the document for placeholder images and possibly included + additional info.
        + Searches only for the first placeholder page after page from top.
        +
        Parameters:
        inputStream -
        +
        Returns:
        all available info from the first found placeholder.
        +
        Throws:
        +
        PDFDocumentException - if the document could not be read.
        +
        at.gv.egiz.pdfas.common.exceptions.PlaceholderExtractionException - if STRICT matching mode was requested and no suitable placeholder could be found.
        +
        at.gv.egiz.pdfas.common.exceptions.PdfAsException
        +
        • +
      + + + +
        +
      • +

        processOperator

        +
        protected void processOperator(org.apache.pdfbox.util.PDFOperator operator,
+                   List arguments)
+                        throws IOException
        +
        +
        Overrides:
        +
        processOperator in class org.apache.pdfbox.util.PDFStreamEngine
        +
        Throws:
        +
        IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
PDF-AS 4.0 Library false
+
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/at/gv/egiz/pdfas/lib/impl/positioning/Positioning.html b/docs/at/gv/egiz/pdfas/lib/impl/positioning/Positioning.html new file mode 100644 index 00000000..cf2365b5 --- /dev/null +++ b/docs/at/gv/egiz/pdfas/lib/impl/positioning/Positioning.html @@ -0,0 +1,369 @@ + + + + + + +Positioning (PDF-AS 4.0 Library) + + + + + + + +
+ + + + + +
PDF-AS 4.0 Library false
+
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
at.gv.egiz.pdfas.lib.impl.positioning
+

Class Positioning

+
+
+ +
+
    +
  • +
    +
    +
    public class Positioning
+extends Object
    +
    Created with IntelliJ IDEA. + User: afitzek + Date: 8/29/13 + Time: 4:30 PM + To change this template use File | Settings | File Templates.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        SIGNATURE_MARGIN_HORIZONTAL

        +
        public static final float SIGNATURE_MARGIN_HORIZONTAL
        +
        The left/right margin.
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        SIGNATURE_MARGIN_VERTICAL

        +
        public static final float SIGNATURE_MARGIN_VERTICAL
        +
        The top/bottom margin.
        +
        See Also:
        Constant Field Values
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Positioning

        +
        public Positioning()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        determineTablePositioning

        +
        public static PositioningInstruction determineTablePositioning(TablePos pos,
+                                               String signature_type,
+                                               org.apache.pdfbox.pdmodel.PDDocument pdfDataSource,
+                                               IPDFVisualObject pdf_table,
+                                               boolean legacy32)
+                                                        throws at.gv.egiz.pdfas.common.exceptions.PdfAsException
        +
        Evalutates absolute positioning and prepares the PositioningInstruction for + placing the table.
        +
        Parameters:
        pos - The absolute positioning parameter. If null it is sought in the + profile definition.
        signature_type - The profile definition of the table to be written.
        pdfDataSource - The pdf.
        pdf_table - The pdf table to be written.
        +
        Returns:
        Returns the PositioningInformation.
        +
        Throws:
        +
        at.gv.egiz.pdfas.common.exceptions.PdfAsException - F.e.
        +
        • +
      + + + +
        +
      • +

        adjustSignatureTableandCalculatePosition

        +
        public static PositioningInstruction adjustSignatureTableandCalculatePosition(org.apache.pdfbox.pdmodel.PDDocument pdfDataSource,
+                                                              IPDFVisualObject pdf_table,
+                                                              TablePos pos,
+                                                              boolean legacy32)
+                                                                       throws at.gv.egiz.pdfas.common.exceptions.PdfAsException
        +
        Sets the width of the table according to the layout of the document and + calculates the y position where the PDFPTable should be placed.
        +
        Parameters:
        pdfDataSource - The PDF document.
        pdf_table - The PDFPTable to be placed.
        +
        Returns:
        Returns the position where the PDFPTable should be placed.
        +
        Throws:
        +
        at.gv.egiz.pdfas.common.exceptions.PdfAsException - F.e.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
PDF-AS 4.0 Library false
+
+
+ + + +
+ +
+
+ + +
+ + +
+ + + -- cgit v1.2.3