Enterprise Tookit for Acrobat Products > Mobile > (Android | iOS)

JavaScript for Acrobat Reader Mobile API Reference (iOS)

File: Doc.js

  1.                         /*************************************************************************
  2.                          *
  3.                          * ADOBE CONFIDENTIAL
  4.                          * ___________________
  5.                          *
  6.                          * Copyright 2014 Adobe Systems Incorporated
  7.                          * All Rights Reserved.
  8.                          *
  9.                          * NOTICE: All information contained herein is, and remains
  10.                          * the property of Adobe Systems Incorporated and its suppliers,
  11.                          * if any. The intellectual and technical concepts contained
  12.                          * herein are proprietary to Adobe Systems Incorporated and its
  13.                          * suppliers and are protected by trade secret or copyright law.
  14.                          * Dissemination of this information or reproduction of this material
  15.                          * is strictly forbidden unless prior written permission is obtained
  16.                          * from Adobe Systems Incorporated.
  17.                          *
  18.                          **************************************************************************/
  19.                         
  20.                         /**
  21.                          *  The Doc object provides the interface between a PDF document open in the viewer and the
  22.                          *  JavaScript interpreter. It provides methods and properties for accessing the PDF document.
  23.                          *
  24.                          *  @class Doc
  25.                          */
  26.                         
  27.                         /**
  28.                          *  The total number of fields in the document.
  29.                          *
  30.                          *  @property numFields
  31.                          *  @type {Number}
  32.                          *  @readonly
  33.                          */
  34.                         Object.defineProperty(this, 'numFields',
  35.                         {
  36.                             get: function()
  37.                             {
  38.                                 return ARJavaScriptDoc.numFields;
  39.                             }
  40.                         });
  41.                         
  42.                         /**
  43.                          *  Gets or sets the current page of the document. When setting pageNum to a specific 
  44.                          *  page, remember that the values are 0-based.
  45.                          *
  46.                          *  @property pageNum
  47.                          *  @type {Number}
  48.                          */
  49.                         Object.defineProperty(this, 'pageNum',
  50.                         {
  51.                             // Usage of pageNum has been replaced with pageIndex in the codebase. The Objective-C protocol now exposes pageIndex property instead of pageNum property.
  52.                             get: function()
  53.                             {
  54.                                 return ARJavaScriptDoc.pageIndex;
  55.                             },
  56.                             set: function(pageNum)
  57.                             {
  58.                                 ARJavaScriptDoc.pageIndex = pageNum;
  59.                             }
  60.                         });
  61.                         
  62.                         /**
  63.                          *  Gets the name of the nth field in the document.
  64.                          *
  65.                          *  @param nIndex {Number} The index of the field whose name should be obtained.
  66.                          *  @return {String} The name of the field in the document.
  67.                          */
  68.                         getNthFieldName = function(nIndex)
  69.                         {
  70.                             if (arguments.length < 1)
  71.                                 throw new TypeError();
  72.                             
  73.                             if (typeof nIndex != "number" || isNaN(nIndex))
  74.                                 nIndex = AFMakeNumber(nIndex);
  75.                             
  76.                             if (typeof nIndex != "number" || isNaN(nIndex))
  77.                                 throw new TypeError();
  78.                                 
  79.                             return ARJavaScriptDoc.getNthFieldName(nIndex);
  80.                         }
  81.                         
  82.                         /**
  83.                          *  Maps a Field object in the PDF document to a JavaScript variable.
  84.                          *
  85.                          *  @method getField
  86.                          *  @param cName {String} The name of the field of interest.
  87.                          *  @return {Object} A Field object representing a form field in the PDF document.
  88.                          */
  89.                         getField = function(name)
  90.                         {
  91.                             var returnVal = null;
  92.                             
  93.                             var field = ARJavaScriptDoc.getField(name);
  94.                             if (field)
  95.                             {
  96.                                 returnVal = new Field(field);
  97.                             }
  98.                             
  99.                             return returnVal;
  100.                         };
  101.                         
  102.                         /**
  103.                          *  Resets the field values within a document. Resetting a field causes it to take on 
  104.                          *  its default value (which, in the case of text fields, is usually blank).
  105.                          *
  106.                          *  @method resetForm
  107.                          *  @param [fieldNames=null] {Object} An array specifying the fields to reset. If not 
  108.                          *  present or null, all fields in the form are reset.
  109.                          */
  110.                         resetForm = function(fieldNames)
  111.                         {
  112.                             ARJavaScriptDoc.resetForm(fieldNames);
  113.                         };
  114.                         
  115.                         /**
  116.                          *  Submits the form to a specified URL.  Currently only supports FormsCentral submissions.
  117.                          *
  118.                          *  submitForm JS API currently only supports FormsCentral submissions.  And FormsCentral has now 
  119.                          *  been decommissioned.  Leave the submitForm code intact so that if it is executed, the return 
  120.                          *  response can be processed by the application.  Leave the submitForm code intact so that it can 
  121.                          *  serve as a guide for any future non-FormsCentral submit functionality.  But mark the API as 
  122.                          *  private so that any autogenerated documentation does NOT include this API.
  123.                          *  @private
  124.                          *  @method submitForm
  125.                          *  @param cURL {String} The URL to submit to.  cURL must be a FormsCentral target.
  126.                          *  @param [cSubmitAs='FDF'] {String} This parameter indicates the format for submission.
  127.                          *  Must be 'HTML' to support FormsCentral submission.
  128.                          *  @param [cCharset='utf-8'] {String} The encoding for the values submitted.  Must be
  129.                          *  'utf-8' to support FormsCentral submission.
  130.                          */
  131.                         submitForm = function()
  132.                         {
  133.                             var cURL = null;
  134.                             var cSubmitAs = null;
  135.                             var cCharset = null;
  136.                             
  137.                             if (arguments.length > 0)
  138.                             {
  139.                                 if (typeof arguments[0].cURL == "string")
  140.                                 {
  141.                                     cSubmitAs = 'FDF';
  142.                                     cCharset = 'utf-8';
  143.                                     
  144.                                     cURL = arguments[0].cURL;
  145.                                     
  146.                                     if (typeof arguments[0].cSubmitAs == "string")
  147.                                     {
  148.                                         cSubmitAs = arguments[0].cSubmitAs;
  149.                                     }
  150.                                     
  151.                                     if (typeof arguments[0].cCharset == "string")
  152.                                     {
  153.                                         cCharset = arguments[0].cCharset;
  154.                                     }
  155.                                 }
  156.                                 else if (typeof arguments[0] == "string")
  157.                                 {
  158.                                     cSubmitAs = 'FDF';
  159.                                     cCharset = 'utf-8';
  160.                                     
  161.                                     cURL = arguments[0];
  162.                                     
  163.                                     if (arguments.length >= 9 && typeof arguments[8] == "boolean" && arguments[8] == true)
  164.                                     {
  165.                                         cSubmitAs = 'PDF';
  166.                                     }
  167.                                     else if (arguments.length >= 7 && typeof arguments[6] == "boolean" && arguments[6] == true)
  168.                                     {
  169.                                         cSubmitAs = 'XML';
  170.                                     }
  171.                                     else if (arguments.length >= 2 && typeof arguments[1] == "boolean" && arguments[1] == false)
  172.                                     {
  173.                                         cSubmitAs = 'none';
  174.                                     }
  175.                                 }
  176.                             }
  177.                             
  178.                             ARJavaScriptDoc.submitForm(cURL, cSubmitAs, cCharset);
  179.                         };
  180.                         
  181.                         // register undefined properties on the 'this' object
  182.                         registerUndefinedProperty(this, 'Doc', 'alternatePresentations');
  183.                         registerUndefinedProperty(this, 'Doc', 'author');
  184.                         registerUndefinedProperty(this, 'Doc', 'baseURL');
  185.                         registerUndefinedProperty(this, 'Doc', 'bookmarkRoot');
  186.                         registerUndefinedProperty(this, 'Doc', 'calculate');
  187.                         registerUndefinedProperty(this, 'Doc', 'creationDate');
  188.                         registerUndefinedProperty(this, 'Doc', 'creator');
  189.                         registerUndefinedProperty(this, 'Doc', 'dataObjects');
  190.                         registerUndefinedProperty(this, 'Doc', 'delay');
  191.                         registerUndefinedProperty(this, 'Doc', 'dirty');
  192.                         registerUndefinedProperty(this, 'Doc', 'disclosed');
  193.                         registerUndefinedProperty(this, 'Doc', 'docID');
  194.                         registerUndefinedProperty(this, 'Doc', 'documentFileName');
  195.                         registerUndefinedProperty(this, 'Doc', 'dynamicXFAForm');
  196.                         registerUndefinedProperty(this, 'Doc', 'external');
  197.                         registerUndefinedProperty(this, 'Doc', 'filesize');
  198.                         registerUndefinedProperty(this, 'Doc', 'hidden');
  199.                         registerUndefinedProperty(this, 'Doc', 'hostContainer');
  200.                         registerUndefinedProperty(this, 'Doc', 'icons');
  201.                         registerUndefinedProperty(this, 'Doc', 'info');
  202.                         registerUndefinedProperty(this, 'Doc', 'innerAppWindowRect');
  203.                         registerUndefinedProperty(this, 'Doc', 'innerDocWindowRect');
  204.                         registerUndefinedProperty(this, 'Doc', 'isModal');
  205.                         registerUndefinedProperty(this, 'Doc', 'keywords');
  206.                         registerUndefinedProperty(this, 'Doc', 'layout');
  207.                         registerUndefinedProperty(this, 'Doc', 'media');
  208.                         registerUndefinedProperty(this, 'Doc', 'metadata');
  209.                         registerUndefinedProperty(this, 'Doc', 'modDate');
  210.                         registerUndefinedProperty(this, 'Doc', 'mouseX');
  211.                         registerUndefinedProperty(this, 'Doc', 'mouseY');
  212.                         registerUndefinedProperty(this, 'Doc', 'noautocomplete');
  213.                         registerUndefinedProperty(this, 'Doc', 'nocache');
  214.                         registerUndefinedProperty(this, 'Doc', 'numPages');
  215.                         registerUndefinedProperty(this, 'Doc', 'numTemplates');
  216.                         registerUndefinedProperty(this, 'Doc', 'path');
  217.                         registerUndefinedProperty(this, 'Doc', 'outerAppWindowRect');
  218.                         registerUndefinedProperty(this, 'Doc', 'outerDocWindowRect');
  219.                         registerUndefinedProperty(this, 'Doc', 'pageWindowRect');
  220.                         registerUndefinedProperty(this, 'Doc', 'permStatusReady');
  221.                         registerUndefinedProperty(this, 'Doc', 'producer');
  222.                         registerUndefinedProperty(this, 'Doc', 'requiresFullSave');
  223.                         registerUndefinedProperty(this, 'Doc', 'securityHandler');
  224.                         registerUndefinedProperty(this, 'Doc', 'selectedAnnots');
  225.                         registerUndefinedProperty(this, 'Doc', 'sounds');
  226.                         registerUndefinedProperty(this, 'Doc', 'spellDictionaryOrder');
  227.                         registerUndefinedProperty(this, 'Doc', 'spellLanguageOrder');
  228.                         registerUndefinedProperty(this, 'Doc', 'subject');
  229.                         registerUndefinedProperty(this, 'Doc', 'templates');
  230.                         registerUndefinedProperty(this, 'Doc', 'title');
  231.                         registerUndefinedProperty(this, 'Doc', 'URL');
  232.                         registerUndefinedProperty(this, 'Doc', 'viewState');
  233.                         registerUndefinedProperty(this, 'Doc', 'xfa');
  234.                         registerUndefinedProperty(this, 'Doc', 'XFAForeground');
  235.                         registerUndefinedProperty(this, 'Doc', 'zoom');
  236.                         registerUndefinedProperty(this, 'Doc', 'zoomType');
  237.                         
  238.
© 2013-15 Adobe Systems, Inc. All rights reserved. Use of these APIs including, the download of software, submission of comments, ideas, feature requests and techniques, and Adobe's rights to use such submitted materials, is governed by the Adobe.com Terms of Use and the Adobe Privacy Policy.