JavaScript API [callas Intranet] - Adobe Acrobat Engineering

JavaScript API [callas Intranet]
JavaScript API
This chapter is a complete reference to the Acrobat extensions to JavaScript, its objects, methods, and
properties. The chapter is organized alphabetically by object name.
Doc
Preflight adds one method to the Acrobat Doc object allowing to preflight the document.
Doc methods
preflight
9.0 D P
Runs a Preflight profile for the document. An exception is thrown if the Preflight run fails.
Parameters
oProfile The Preflight profile to be used for the Preflight run, described by a PreflightProfile object.
bOmitFixups (optional) Omit all fixups in the Preflight profile. If bOmitFixups is not specified, false is used.
oThermometer
Returns
A PreflightResult object.
Example
http://10.0.0.26/doku.php?id=development:oyster:specs:preflightapi:javascript
10/31/2007 04:32 PM
(optional) Show status window and progress bar that indicates to the user that a lengthy operation is in progress.
To acquire a Thermometer object, use app.thermometer. If oThermometer is not specified, no progress is
shown.
var oProfile = Preflight.getProfileByName("Magazine Ads")
if( oProfile != undefined )
{
var oThermometer = app.thermometer;
var myPreflightResult = this.preflight( oProfile, false, oThermometer);
if( myPreflightResult.numErrors > 0 ) {
console.println( "Preflight found " + myPreflightResult.numErrors + " Errors.");
} else {
console.println( "Preflight found no Errors.");
}
}
Preflight
A Preflight object represents the Preflight tool.
Note: Preflight is only available in Acrobat Professional and cannot be accessed from Acrobat Reader.
Preflight methods
getNumProfiles
9.0 P
Page 1 of 6

JavaScript API [callas Intranet]
Retrieves the number of installed Preflight profiles.
Parameters
oThermometer
Returns
http://10.0.0.26/doku.php?id=development:oyster:specs:preflightapi:javascript
10/31/2007 04:32 PM
(optional) Show status window and progress bar that indicates to the user that a lengthy operation is in progress.
To acquire a Thermometer object, use app.thermometer. If oThermometer is not specified, no progress is
shown.
The number of installed Preflight profiles.
getNthProfile
9.0 P
Retrieves the Nth Preflight profile from the list of installed Preflight profiles.
Parameters
nIndex The 0-based index of the profile that should be obtained.
oThermometer
Returns
(optional) Show status window and progress bar that indicates to the user that a lengthy operation is in progress.
To acquire a Thermometer object, use app.thermometer. If oThermometer is not specified, no progress is
shown.
A PreflightProfile object, the profile that corresponds to nIndex. Undefined otherwise
Example
Enumerate through all of the profiles in Preflight.
var num = Preflight.getNumProfiles(app.thermometer);
for( i= 0; i< num; ++i)
{
var oProfile = Preflight.getNthProfile(i);
console.println("-----------------------------------------");
console.println("Name: " + oProfile.name);
console.println("Comment: " + oProfile.description);
console.println("HasFixups: " + oProfile.hasFixups);
console.println("HasChecks: " + oProfile.hasChecks);
console.println("-----------------------------------------");
}
getProfileByName
9.0 P
Retrieves the Preflight profile with a specific name from the list of installed Preflight profiles.
Parameters
cName The name of the profile that should be obtained.
oThermometer
Returns
(optional) Show status window and progress bar that indicates to the user that a lengthy operation is in progress.
To acquire a Thermometer object, use app.thermometer. If oThermometer is not specified, no progress is
shown.
A PreflightProfile object if a profile with specified name exists, Undefined otherwise.
Page 2 of 6

JavaScript API [callas Intranet]
Example
Get profile with name “Magazine Ads”.
var oProfile = Preflight.getProfileByName("Magazine Ads");
if( oProfile != undefined) {
console.println("-----------------------------------------");
console.println("Name: " + oProfile.name);
console.println("Comment: " + oProfile.description);
console.println("HasFixups: " + oProfile.hasFixups);
console.println("HasChecks: " + oProfile.hasChecks);
console.println("-----------------------------------------");
}
createComplianceProfile
9.0 P
Create a compliance profile for a given PDF standard for the document.
Parameters
cStandardKey PDF Standard version to verify
oThermometer
http://10.0.0.26/doku.php?id=development:oyster:specs:preflightapi:javascript
10/31/2007 04:32 PM
(optional) Show status window and progress bar that indicates to the user that a lengthy operation is in progress.
To acquire a Thermometer object, use app.thermometer. If oThermometer is not specified, no progress is
shown.
Valid standard version keys:
Key
PDF/X-1a:2001
PDF/X-1a:2003
PDF/X-3:2002
PDF/X-3:2003
PDF/X-4
PDF/X-5g
PDF/X-5n
PDF/X-5pg
PDF/A-1a:2005
PDF/A-1b:2005
PDF/E:2007
Returns
A PreflightProfile object, Undefined otherwise
Example
Check the current PDF document to PDF/A-1b:2005 compliance.
var oProfile = Preflight.createComplianceProfile("PDF/A-1b:2005")
if( oProfile != undefined )
{
var oThermometer = app.thermometer;
var myPreflightResult = this.preflight( oProfile, true, oThermometer);
if( myPreflightResult.numErrors > 0 ) {
console.println( "PDF document is NOT PDF/A-1b:2005 compliant.");
} else {
console.println( "PDF document is PDF/A-1b:2005 compliant.");
Page 3 of 6

JavaScript API [callas Intranet]
}
}
PreflightProfile
http://10.0.0.26/doku.php?id=development:oyster:specs:preflightapi:javascript
10/31/2007 04:32 PM
A PreflightProfile represents a particular Preflight profile; that is a Preflight profile that is installed in the
Preflight tool. The PreflightProfile object can be acquired from the Preflight object method getNthProfile or
getProfileByName.
PreflightProfile properties
9.0 P
Property Type Access Description
name String R The name of the Preflight profile.
description String R A description for the Preflight profile.
hasFixups Boolean R Indicates whether the Preflight profile has fixups.
hasChecks Boolean R Indicates whether the Preflight profile has checks.
PreflightProfile methods
hasConversion
9.0 P
Checks whether the preflight profiles contains a conversion to a specific PDF standard.
Parameters
version The PDF Standard as string “PDF/X-1a”, “PDF/X-3”, “PDF/X-4”, “PDF/A-1a”, “PDF/A-1b”
Returns
Boolean, true if the specified conversion is configured in the profile, false otherwise.
Example
PreflightResult
A PreflightResult represents a particular Preflight result; that is a data structure created by the Preflight tool.
The PreflightResult object can be acquired from the Doc object methods preflight.
PreflightResult properties
9.0 P
Property Type Access Description
numErrors Integer R Indicates the number of errors found in the PDF document.
numWarnings Integer R Indicates the number of warnings found in the PDF document.
numInfos Integer R Indicates the number of infos found in the PDF document.
numFixed 1) Integer R Indicates the number of successfully applied fixups.
numNotFixed 2) Integer R Indicates the number of unsuccessfully applied fixups.
Page 4 of 6

JavaScript API [callas Intranet]
PreflightResult methods
report
9.0 P
Creates a Preflight XML report.
Parameters
oThermometer
Returns
http://10.0.0.26/doku.php?id=development:oyster:specs:preflightapi:javascript
10/31/2007 04:32 PM
(optional) Show status window and progress bar that indicates to the user that a lengthy operation is in progress.
To acquire a Thermometer object, use app.thermometer. If oThermometer is not specified, no progress is
shown.
String containing the XML report. This string can be used with XMLData.parse to create an object of type XFA
object that represents either a tree headed by a single node or a tree started by a list of nodes (a tree list).
Example
var oProfile = Preflight.getProfileByName("Magazine Ads")
if( oProfile != undefined )
{
var oThermometer = app.thermometer;
var myPreflightResult = this.preflight( oProfile, false, oThermometer);
if( myPreflightResult.numErrors > 0 ) {
var cXMLData = myPreflightResult.report(oThermometer);
var oXMLData = XMLData.parse(sXMLData, false);
... do something with XMLData object ...
}
PreflightFeat
PreflightFeat properties
9.0 P
Property Type Access Description
versionMajor 3) Integer R Indicates the major version number of the Preflight plug-in.
versionMinor 4) Integer R Indicates the minor version number of the Preflight plug-in.
versionFix 5) Integer R Indicates the fix number of the Preflight plug-in.
versionBuild 6) Integer R Indicates the build number of the Preflight plug-in.
PreflightFeat methods
traceClear()
9.0 P
Clear all trace samples
traceActivate()
9.0 P
Page 5 of 6

JavaScript API [callas Intranet]
Activate sampling of trace points
traceDeactivate()
9.0 P
Deactivate sampling of trace points
traceSum
9.0 P
Evaluate the accumulated time for a given trace point.
Parameters
cTracePoint Name of the trace point, e.g. “PREFLIGHT”
Valid Tracepoints are listed in the table below 7) :
Tracepoint Description
LIB_LOAD Load PreflightLib
LIB_INIT Init Lib (Dict, CCW, etc.)
LIB_INIT_PRC Load default profile list
PRC_PACK_LOAD Load Preflight package
PRC_WIZ_LOAD Load profile definitions
PRC_WIZ_ADD_CHECKS 8) Add Wizard Checks
PRC_WIZ_ADD_FIXUPS 9) Add Wizard Fixups
PREFLIGHT_POST Complete Post Check
PREFLIGHT_PRC Prepare PRC profile as part of Preflight check (compress objects etc.)
PREFLIGHT_DVA DVA Checks
PREFLIGHT_PAGE_INKCOVERAGE Preflight ink coverage check
PREFLIGHT_PAGE_HITS Preflight all property checks
FIX Apply Fixups
FIX_OPTIMIZER PDFOptimizer
FIX_CONVERT_COLORS ConvertColors
FIX_HAIRLINES Fix Hairlines
FIX_SAVE Saving fixed file
Returns
Accumulated time for the given trace point cTracePoint as string.
1) , 2) , 3) , 4) , 5) , 6) , 7) Implemented in 9.0.0.002
8) , 9) Implemented in 9.0.0.006
http://10.0.0.26/doku.php?id=development:oyster:specs:preflightapi:javascript
10/31/2007 04:32 PM
development/oyster/specs/preflightapi/javascript.txt ! Last modified: 2007/10/31 15:59 by rgu
Page 6 of 6