Package com.adobe.external.pdfutil.client
Classpublic class PDFPropertiesResponse
InheritancePDFPropertiesResponse Inheritance Object

Contains the results of a PDF document query request, which you create with a com.adobe.external.pdfutil.client.PDFPropertiesRequest object. By using this object, you can determine document properties such as the version, whether it contains comments, or whether it contains attachments.

An accessor method that belongs to this class may return null, meaning that either the property was not requested or the property could not be determined. If there is a problem, invoke the getQueryExceptions() method.

See also

PDFPropertiesRequest

Public Methods
 MethodDefined by
  
PDFPropertiesResponse()
The default constructor.
PDFPropertiesResponse
  
String getFormType()
Retrieves the form type of the queried PDF document.
PDFPropertiesResponse
  
Boolean getHasAttachments()
Determines if the document has attachments.
PDFPropertiesResponse
  
Boolean getHasComments()
Determines whether the document contains comments.
PDFPropertiesResponse
  
Boolean getIsAcroForm()
Determines if the document is an Acrobat form (Acroform) that does not contain an XFA stream.
PDFPropertiesResponse
  
Boolean getIsFillableForm()
Determines if the document contains fillable form fields.
PDFPropertiesResponse
  
Boolean getIsPDFDocument()
Determines whether you can perform PDF document operations on this document.
PDFPropertiesResponse
  
Boolean getIsPDFPackage()
Determines whether the document is a PDF package, which is a portable collection that uses metadata, including user-defined metadata, to manage a collection of document-level file attachments.
PDFPropertiesResponse
  
Boolean getIsXFADocument()
Determines if the PDF document contains an XFA stream.
PDFPropertiesResponse
  
String getPDFVersion()
Retrieves the document's version.
PDFPropertiesResponse
  
Map getQueryExceptions()
When processing the properties requested by the com.adobe.external.pdfutil.client.PDFPropertiesRequest object, the #getPDFProperties getPDFProperties() method throws an exception if the PDF document cannot be queried.
PDFPropertiesResponse
  
String getRequiredAcrobatVersion()
Retrieves the Acrobat version (or Adobe Reader) that is required to view the queried PDF document.
PDFPropertiesResponse
  
String getXFAVersion()
Retrieves the XFA version of the PDF document.
PDFPropertiesResponse
  
boolean isLocked()
Determines whether the document is locked.
PDFPropertiesResponse
  
void setFormType(String value)
Sets the form type of the queried PDF document.
PDFPropertiesResponse
  
void setHasAttachments(Boolean value)
Sets whether the document has attachments.
PDFPropertiesResponse
  
void setHasComments(Boolean value)
Sets whether the document contains comments.
PDFPropertiesResponse
  
void setIsAcroForm(Boolean value)
Sets if the document is an Acrobat form (Acroform) that does not contain an XFA stream.
PDFPropertiesResponse
  
void setIsFillableForm(Boolean value)
Sets if the document contains fillable form fields.
PDFPropertiesResponse
  
void setIsPDFDocument(Boolean value)
Sets whether you can perform PDF document operations on this document.
PDFPropertiesResponse
  
void setIsPDFPackage(Boolean value)
Sets whether the document is a PDF package.
PDFPropertiesResponse
  
void setIsXFADocument(Boolean value)
Sets if the PDF document contains an XFA stream.
PDFPropertiesResponse
  
void setLocked(boolean locked)
Sets whether the document is locked.
PDFPropertiesResponse
  
void setPDFVersion(String value)
Sets the document's version.
PDFPropertiesResponse
  
void setQueryExceptions(Map queryExceptions)
Assigns a collection of exceptions to this result object.
PDFPropertiesResponse
  
void setRequiredAcrobatVersion(String value)
Sets the Acrobat version (or Adobe Reader) that is required to view the queried PDF document.
PDFPropertiesResponse
  
void setXFAVersion(String value)
Sets the XFA version of the PDF document.
PDFPropertiesResponse
  
String toString()
Retrieves a string representation of this object.
PDFPropertiesResponse
Public Constants
 ConstantDefined by
  ACROFORM
[static] A form type indicating this document is an AcroForm.
PDFPropertiesResponse
  DYNAMIC_XFA
[static] A form type indicating this document is dynamic XFA.
PDFPropertiesResponse
  NOT_A_FORM
[static] A form type indicating this document is not a form.
PDFPropertiesResponse
  PROPERTYNAME_FORMTYPE
[static] The property name for querying the document form type.
PDFPropertiesResponse
  PROPERTYNAME_HASATTACHMENTS
[static] The property name for querying if the PDF document has attachments.
PDFPropertiesResponse
  PROPERTYNAME_HASCOMMENTS
[static] The property name for querying if the PDF document has comments.
PDFPropertiesResponse
  PROPERTYNAME_ISACROFORM
[static] The property name for querying if the PDF document is an AcroForm.
PDFPropertiesResponse
  PROPERTYNAME_ISFILLABLEFORM
[static] The property name for querying if the document has a fillable form.
PDFPropertiesResponse
  PROPERTYNAME_ISPDFDOCUMENT
[static] The property name for querying if the document is a PDF document.
PDFPropertiesResponse
  PROPERTYNAME_ISPDFPACKAGE
[static] The property name for querying if the document is a PDF package.
PDFPropertiesResponse
  PROPERTYNAME_ISXFADOCUMENT
[static] The property name for querying if the document is an XFA document.
PDFPropertiesResponse
  PROPERTYNAME_PDFVERSION
[static] The property name for querying the PDF version.
PDFPropertiesResponse
  PROPERTYNAME_REQUIREDACROBATVERSION
[static] The property name for querying the Acrobat version recommended for viewing.
PDFPropertiesResponse
  PROPERTYNAME_XFAVERSION
[static] The property name for querying the XFA version.
PDFPropertiesResponse
  STATIC_XFA
[static] A form type indicating this document is static XFA.
PDFPropertiesResponse
  XFAFOREGROUND
[static] A form type indicating this document is an XFA foreground.
PDFPropertiesResponse
Constructor Detail
PDFPropertiesResponse()
public PDFPropertiesResponse()

The default constructor.

Method Detail
getFormType()
public String getFormType()

Retrieves the form type of the queried PDF document.

One of the following form types can be returned:

Returns
A java.lang.String containing the form type. The value null is returned if the property was not requested or could not be determined.
getHasAttachments() 
public Boolean getHasAttachments()

Determines if the document has attachments.

Returns
true if the PDF document contains attachments, false if the PDF document does not contain attachments, and null if the property was not requested or could not be determined.
getHasComments() 
public Boolean getHasComments()

Determines whether the document contains comments.

Comments can be one of the following types:

Returns
true if the PDF document contains comments, false if the PDF document does not contain comments and null if the property was not requested or could not be determined.
getIsAcroForm() 
public Boolean getIsAcroForm()

Determines if the document is an Acrobat form (Acroform) that does not contain an XFA stream.

Returns
true if the PDF document is a form which is not an XFA document, false if the PDF document is not a form or contains an XFA stream, and null if the property was not requested or could not be determined.
getIsFillableForm() 
public Boolean getIsFillableForm()

Determines if the document contains fillable form fields.

Returns
true if the document contains fillable form fields, false if the document does not contain fillable form fields, and null if the property was not requested or could not be determined.
getIsPDFDocument() 
public Boolean getIsPDFDocument()

Determines whether you can perform PDF document operations on this document. If the document contains an XFA stream, but is an XFA Foreground stream, then it is still a PDF document. An XFA Foreground stream is a PDF document which displays an XFA form as a layer on applicable pages.

Returns
true if the PDF document allows PDF operations, false if there are restrictions. For example if it is an XFA form, then pages may not be added.
getIsPDFPackage() 
public Boolean getIsPDFPackage()

Determines whether the document is a PDF package, which is a portable collection that uses metadata, including user-defined metadata, to manage a collection of document-level file attachments. The root PDF, to which all the files are attached, is less important than the attachments, and is referred to as a cover sheet within Acrobat.

Returns
true if the PDF document is a portable collection (regardless of whether it contains any package files), false if the PDF document is not a portable collection, and null if the property was not requested or could not be determined.
getIsXFADocument() 
public Boolean getIsXFADocument()

Determines if the PDF document contains an XFA stream.

Returns
true if the document contains an XFA stream, false if the document does not contain an XFA stream, and null if the property was not requested could not be determined.
getPDFVersion() 
public String getPDFVersion()

Retrieves the document's version. The first line of a PDF file is a header identifying the version of the PDF specification to which the file conforms. For a file conforming to PDF version 1.5, the header is %PDF-1.5.

Returns
A java.lang.String containing the version of the PDF document.
getQueryExceptions() 
public Map getQueryExceptions()

When processing the properties requested by the com.adobe.external.pdfutil.client.PDFPropertiesRequest object, the getPDFProperties() method throws an exception if the PDF document cannot be queried. This method returns a map that contains exceptions that are thrown when property values are retrieved.

Returns
A java.util.Map containing any exceptions that are thrown while retrieving property values.
getRequiredAcrobatVersion() 
public String getRequiredAcrobatVersion()

Retrieves the Acrobat version (or Adobe Reader) that is required to view the queried PDF document. For example, a PDF 1.4 requires Acrobat 5, a PDF 1.5 document requires Acrobat 6, and so on.

Returns
A java.lang.String containing the version of Adobe Reader or Acrobat required to correctly view the PDF document.
getXFAVersion() 
public String getXFAVersion()

Retrieves the XFA version of the PDF document.

Returns
A java.lang.String containing the version stored in the document's XFA stream. null is returned if the PDF document does not contain an XFA stream or the property was not requested.
isLocked() 
public boolean isLocked()

Determines whether the document is locked.

Returns
true if the document is locked, false otherwise.
setFormType() 
public void setFormType(String value)

Sets the form type of the queried PDF document.

Parameters

value — A java.lang.String containing the form type.

One of the following form types can be used:

  • NotAForm
  • Acroform
  • Static-XFA
  • Dynamic-XFA
  • XFAForeground

See also

getFormType()
setHasAttachments() 
public void setHasAttachments(Boolean value)

Sets whether the document has attachments.

Parameters

value — true if the PDF document contains attachments, false if the PDF document does not contain attachments.

See also

getHasAttachments()
setHasComments() 
public void setHasComments(Boolean value)

Sets whether the document contains comments.

Parameters

value — true if the PDF document contains comments, false if the PDF document does not contain comments.

See also

getHasComments()
setIsAcroForm() 
public void setIsAcroForm(Boolean value)

Sets if the document is an Acrobat form (Acroform) that does not contain an XFA stream.

Parameters

value — true if the PDF document is a form which is not an XFA document, false if the PDF document is not a form or contains an XFA stream.

See also

getIsAcroForm()
setIsFillableForm() 
public void setIsFillableForm(Boolean value)

Sets if the document contains fillable form fields.

Parameters

value — true if the document contains fillable form fields, false if the document does not contain fillable form fields.

See also

getIsFillableForm()
setIsPDFDocument() 
public void setIsPDFDocument(Boolean value)

Sets whether you can perform PDF document operations on this document.

Parameters

value — true if the PDF document allows PDF operations, false if there are restrictions. For example if it is an XFA form, then pages may not be added.

See also

getIsPDFDocument()
setIsPDFPackage() 
public void setIsPDFPackage(Boolean value)

Sets whether the document is a PDF package.

Parameters

value — true if the PDF document is a portable collection (regardless of whether it contains any package files), false if the PDF document is not a portable collection.

See also

getIsPDFPackage()
setIsXFADocument() 
public void setIsXFADocument(Boolean value)

Sets if the PDF document contains an XFA stream.

Parameters

value — true if the document contains an XFA stream, false if the document does not contain an XFA stream.

See also

getIsXFADocument()
setLocked() 
public void setLocked(boolean locked)

Sets whether the document is locked.

Parameters

locked — true if the document is locked, false otherwise.

setPDFVersion() 
public void setPDFVersion(String value)

Sets the document's version.

Parameters

value — A java.lang.String containing the version of the PDF document.

See also

getPDFVersion()
setQueryExceptions() 
public void setQueryExceptions(Map queryExceptions)

Assigns a collection of exceptions to this result object. In general this should not be used by clients.

Parameters

queryExceptions — A collection of exceptions.

setRequiredAcrobatVersion() 
public void setRequiredAcrobatVersion(String value)

Sets the Acrobat version (or Adobe Reader) that is required to view the queried PDF document.

Parameters

value — A java.lang.String containing the version of Adobe Reader or Acrobat required to correctly view the PDF document.

See also

getRequiredAcrobatVersion()
setXFAVersion() 
public void setXFAVersion(String value)

Sets the XFA version of the PDF document.

Parameters

value — A java.lang.String containing the version stored in the document's XFA stream.

See also

getXFAVersion()
toString() 
public String toString()

Retrieves a string representation of this object.

Returns
A string representation of this object.
Constant Detail
ACROFORMConstant
public static final ACROFORM

A form type indicating this document is an AcroForm.

DYNAMIC_XFAConstant 
public static final DYNAMIC_XFA

A form type indicating this document is dynamic XFA.

NOT_A_FORMConstant 
public static final NOT_A_FORM

A form type indicating this document is not a form.

PROPERTYNAME_FORMTYPEConstant 
public static final PROPERTYNAME_FORMTYPE

The property name for querying the document form type.

PROPERTYNAME_HASATTACHMENTSConstant 
public static final PROPERTYNAME_HASATTACHMENTS

The property name for querying if the PDF document has attachments.

PROPERTYNAME_HASCOMMENTSConstant 
public static final PROPERTYNAME_HASCOMMENTS

The property name for querying if the PDF document has comments.

PROPERTYNAME_ISACROFORMConstant 
public static final PROPERTYNAME_ISACROFORM

The property name for querying if the PDF document is an AcroForm.

PROPERTYNAME_ISFILLABLEFORMConstant 
public static final PROPERTYNAME_ISFILLABLEFORM

The property name for querying if the document has a fillable form.

PROPERTYNAME_ISPDFDOCUMENTConstant 
public static final PROPERTYNAME_ISPDFDOCUMENT

The property name for querying if the document is a PDF document.

PROPERTYNAME_ISPDFPACKAGEConstant 
public static final PROPERTYNAME_ISPDFPACKAGE

The property name for querying if the document is a PDF package.

PROPERTYNAME_ISXFADOCUMENTConstant 
public static final PROPERTYNAME_ISXFADOCUMENT

The property name for querying if the document is an XFA document.

PROPERTYNAME_PDFVERSIONConstant 
public static final PROPERTYNAME_PDFVERSION

The property name for querying the PDF version.

PROPERTYNAME_REQUIREDACROBATVERSIONConstant 
public static final PROPERTYNAME_REQUIREDACROBATVERSION

The property name for querying the Acrobat version recommended for viewing.

PROPERTYNAME_XFAVERSIONConstant 
public static final PROPERTYNAME_XFAVERSION

The property name for querying the XFA version.

STATIC_XFAConstant 
public static final STATIC_XFA

A form type indicating this document is static XFA.

XFAFOREGROUNDConstant 
public static final XFAFOREGROUND

A form type indicating this document is an XFA foreground.




© 2004-2006 Adobe Systems Incorporated. All rights reserved.
Thu Sep 27 2007, 8:38 AM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/programmer/javadoc/com/adobe/external/pdfutil/client/PDFPropertiesResponse.html