From 835256964f3fa64587a0e05b859d012d125be308 Mon Sep 17 00:00:00 2001 From: Andreas Fitzek Date: Thu, 20 Feb 2014 10:54:04 +0100 Subject: Documentation update --- .../egiz/pdfas/api/analyze/AnalyzeParameters.html | 452 ++++++++++++++++++ .../gv/egiz/pdfas/api/analyze/AnalyzeResult.html | 255 ++++++++++ .../egiz/pdfas/api/analyze/NonTextObjectInfo.html | 516 +++++++++++++++++++++ .../gv/egiz/pdfas/api/analyze/package-frame.html | 24 + .../gv/egiz/pdfas/api/analyze/package-summary.html | 150 ++++++ .../at/gv/egiz/pdfas/api/analyze/package-tree.html | 131 ++++++ 6 files changed, 1528 insertions(+) create mode 100644 docs/full/at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html create mode 100644 docs/full/at/gv/egiz/pdfas/api/analyze/AnalyzeResult.html create mode 100644 docs/full/at/gv/egiz/pdfas/api/analyze/NonTextObjectInfo.html create mode 100644 docs/full/at/gv/egiz/pdfas/api/analyze/package-frame.html create mode 100644 docs/full/at/gv/egiz/pdfas/api/analyze/package-summary.html create mode 100644 docs/full/at/gv/egiz/pdfas/api/analyze/package-tree.html (limited to 'docs/full/at/gv/egiz/pdfas/api/analyze') diff --git a/docs/full/at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html b/docs/full/at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html new file mode 100644 index 00000000..6bac050a --- /dev/null +++ b/docs/full/at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html @@ -0,0 +1,452 @@ + + + + + +AnalyzeParameters + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
at.gv.egiz.pdfas.api.analyze
+

Class AnalyzeParameters

+
+
+ +
+
    +
  • +
    +
    Deprecated.
    +
    +
    @Deprecated
+public class AnalyzeParameters
+extends java.lang.Object
    +
    Parameter object that holds the analyze parameters.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      protected DataSourcedocument +
      Deprecated. 
      +
      The document to be analyzed.
      +
      protected booleanhasBeenCorrected +
      Deprecated. 
      + 
      protected booleanreturnNonTextualObjects +
      Deprecated. 
      + 
      protected java.lang.StringverifyMode +
      Deprecated. 
      +
      The mode of operation how the document is analyzed.
      +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      AnalyzeParameters() +
      Deprecated. 
      + 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      DataSourcegetDocument() +
      Deprecated. 
      + 
      java.lang.StringgetVerifyMode() +
      Deprecated. 
      + 
      booleanisReturnNonTextualObjects() +
      Deprecated. 
      + 
      voidsetDocument(DataSource document) +
      Deprecated. 
      + 
      voidsetReturnNonTextualObjects(boolean returnNonTextualObjects) +
      Deprecated. 
      +
      Tells if non text object of the signed pdf should be extracted and returned.
      +
      voidsetVerifyMode(java.lang.String verifyMode) +
      Deprecated. 
      + 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        document

        +
        protected DataSource document
        +
        Deprecated. 
        +
        The document to be analyzed.
        +
        • +
      + + + + + + + +
        +
      • +

        returnNonTextualObjects

        +
        protected boolean returnNonTextualObjects
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        hasBeenCorrected

        +
        protected boolean hasBeenCorrected
        +
        Deprecated. 
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AnalyzeParameters

        +
        public AnalyzeParameters()
        +
        Deprecated. 
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDocument

        +
        public DataSource getDocument()
        +
        Deprecated. 
        +
        Returns:
        the document
        +
        • +
      + + + +
        +
      • +

        setDocument

        +
        public void setDocument(DataSource document)
        +
        Deprecated. 
        +
        Parameters:
        document - the document to set
        +
        • +
      + + + +
        +
      • +

        getVerifyMode

        +
        public java.lang.String getVerifyMode()
        +
        Deprecated. 
        +
        Returns:
        the verifyMode
        +
        • +
      + + + +
        +
      • +

        setVerifyMode

        +
        public void setVerifyMode(java.lang.String verifyMode)
        +
        Deprecated. 
        +
        Parameters:
        verifyMode - the verifyMode to set
        +
        • +
      + + + +
        +
      • +

        isReturnNonTextualObjects

        +
        public boolean isReturnNonTextualObjects()
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        setReturnNonTextualObjects

        +
        public void setReturnNonTextualObjects(boolean returnNonTextualObjects)
        +
        Deprecated. 
        +
        Tells if non text object of the signed pdf should be extracted and returned. + One should show this to the user, especially in case of textual signature. + Defaults to false
        +
        Parameters:
        returnNonTextualObjects -
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/full/at/gv/egiz/pdfas/api/analyze/AnalyzeResult.html b/docs/full/at/gv/egiz/pdfas/api/analyze/AnalyzeResult.html new file mode 100644 index 00000000..ee337d7d --- /dev/null +++ b/docs/full/at/gv/egiz/pdfas/api/analyze/AnalyzeResult.html @@ -0,0 +1,255 @@ + + + + + +AnalyzeResult + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
at.gv.egiz.pdfas.api.analyze
+

Interface AnalyzeResult

+
+
+
+
    +
  • +
    +
    Deprecated.
    +
    +
    @Deprecated
+public interface AnalyzeResult
    +
    The result of an analyze operation, which is a list of verifyable signatures.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.util.ListgetNoSignatures() +
      Deprecated. 
      + 
      java.util.ListgetSignatures() +
      Deprecated. 
      +
      Returns the list of found signatures.
      +
      booleanhasBeenCorrected() +
      Deprecated. 
      +
      Tells if the document has been corrected before verification.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getNoSignatures

        +
        java.util.List getNoSignatures()
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        hasBeenCorrected

        +
        boolean hasBeenCorrected()
        +
        Deprecated. 
        +
        Tells if the document has been corrected before verification. The correction maybe done + after a first failing parse to repair a document (if enabled in the configuration + correct_document_on_verify_if_necessary). The correction can only work for textual + signatures. Binary signatures are lost anyhow.
        +
        Returns:
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/full/at/gv/egiz/pdfas/api/analyze/NonTextObjectInfo.html b/docs/full/at/gv/egiz/pdfas/api/analyze/NonTextObjectInfo.html new file mode 100644 index 00000000..7c0550df --- /dev/null +++ b/docs/full/at/gv/egiz/pdfas/api/analyze/NonTextObjectInfo.html @@ -0,0 +1,516 @@ + + + + + +NonTextObjectInfo + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
at.gv.egiz.pdfas.api.analyze
+

Class NonTextObjectInfo

+
+
+ +
+
    +
  • +
    +
    Deprecated.
    +
    +
    @Deprecated
+public class NonTextObjectInfo
+extends java.lang.Object
    +
    Encapsulates information about non textual objects in a pdf document.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.lang.StringTYPE_ANNOTATION +
      Deprecated. 
      + 
      static java.lang.StringTYPE_IMAGE +
      Deprecated. 
      + 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      NonTextObjectInfo() +
      Deprecated. 
      + 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      doublegetHeight() +
      Deprecated. 
      + 
      java.lang.StringgetName() +
      Deprecated. 
      + 
      java.lang.StringgetObjectType() +
      Deprecated. 
      + 
      intgetPageNr() +
      Deprecated. 
      + 
      java.lang.StringgetSubType() +
      Deprecated. 
      + 
      doublegetWidth() +
      Deprecated. 
      + 
      voidsetHeight(double height) +
      Deprecated. 
      + 
      voidsetName(java.lang.String name) +
      Deprecated. 
      + 
      voidsetObjectType(java.lang.String objectType) +
      Deprecated. 
      + 
      voidsetPageNr(int pageNr) +
      Deprecated. 
      + 
      voidsetSubType(java.lang.String subType) +
      Deprecated. 
      + 
      voidsetWidth(double width) +
      Deprecated. 
      + 
      java.lang.StringtoString() +
      Deprecated. 
      + 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        TYPE_IMAGE

        +
        public static final java.lang.String TYPE_IMAGE
        +
        Deprecated. 
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        TYPE_ANNOTATION

        +
        public static final java.lang.String TYPE_ANNOTATION
        +
        Deprecated. 
        +
        See Also:
        Constant Field Values
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NonTextObjectInfo

        +
        public NonTextObjectInfo()
        +
        Deprecated. 
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getObjectType

        +
        public java.lang.String getObjectType()
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        setObjectType

        +
        public void setObjectType(java.lang.String objectType)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        setName

        +
        public void setName(java.lang.String name)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        getPageNr

        +
        public int getPageNr()
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        setPageNr

        +
        public void setPageNr(int pageNr)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        getWidth

        +
        public double getWidth()
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        setWidth

        +
        public void setWidth(double width)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        getHeight

        +
        public double getHeight()
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        setHeight

        +
        public void setHeight(double height)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        getSubType

        +
        public java.lang.String getSubType()
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        setSubType

        +
        public void setSubType(java.lang.String subType)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Deprecated. 
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/full/at/gv/egiz/pdfas/api/analyze/package-frame.html b/docs/full/at/gv/egiz/pdfas/api/analyze/package-frame.html new file mode 100644 index 00000000..539c91bf --- /dev/null +++ b/docs/full/at/gv/egiz/pdfas/api/analyze/package-frame.html @@ -0,0 +1,24 @@ + + + + + +at.gv.egiz.pdfas.api.analyze + + + + +

at.gv.egiz.pdfas.api.analyze

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/docs/full/at/gv/egiz/pdfas/api/analyze/package-summary.html b/docs/full/at/gv/egiz/pdfas/api/analyze/package-summary.html new file mode 100644 index 00000000..0f8ccfbc --- /dev/null +++ b/docs/full/at/gv/egiz/pdfas/api/analyze/package-summary.html @@ -0,0 +1,150 @@ + + + + + +at.gv.egiz.pdfas.api.analyze + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package at.gv.egiz.pdfas.api.analyze

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/full/at/gv/egiz/pdfas/api/analyze/package-tree.html b/docs/full/at/gv/egiz/pdfas/api/analyze/package-tree.html new file mode 100644 index 00000000..4c904744 --- /dev/null +++ b/docs/full/at/gv/egiz/pdfas/api/analyze/package-tree.html @@ -0,0 +1,131 @@ + + + + + +at.gv.egiz.pdfas.api.analyze Class Hierarchy + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package at.gv.egiz.pdfas.api.analyze

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + -- cgit v1.2.3