| Package | coldfusion.service.mxml |
| Class | public class Pdf |
| Inheritance | Pdf  BasicService InternalConfig Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | action : String
Action string for the service. | BasicService | |
| addQuads : Boolean = false
Add the position or quadrants of the thumbnail
| |||
| cfContextRoot : String
Context root of the ColdFusion server. | InternalConfig | |
| cfPort : int
Port where the ColdFusion server is running. | InternalConfig | |
| cfServer : String
Name or IP address of the ColdFusion server. | InternalConfig | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| copyFrom : String
Pathname of the PDF document from which to use the first page as a watermark. | |||
| ddxString : String
Pathname of the DDX file, or a string with DDX instructions. | |||
| destination : String
Specifies the destination for the remoting call. | InternalConfig | |
| encrypt : String
Encryption type for the PDF output file:
RC4_40
RC4_128
RC4_128M
AES_128
None
| |||
| foreground : Boolean
Placement of the watermark on the page:
yes: the watermark appears in the foreground (over the page content).
no: the watermark appears in the background (behind the page content).
| |||
| format : String
File type of thumbnail image output:
jpg
tiff
png
| |||
| honourSpaces : Boolean = false
Set this option to "true", for improved readability and spacing. | |||
| image : String
Image used as a watermark. | |||
| imagePrefix : String
Prefix used for each image thumbnail file generated. | |||
| info : Array
Structure variable for relevant information, for example, “ #infoStruct#". | |||
| inputFiles : Array
Structure that maps the PDF source files to the input variables
in the DDX file, or a string of elements and their pathname. | |||
| isbase64 : Boolean
Valid only when the image attribute is specified. | |||
| keepBookmark : Boolean
Specifies whether bookmarks from the source PDF documents are retained
in the merged document:
yes: the bookmarks are retained.
no: the bookmarks are removed.
| |||
| newOwnerPassword : String
Password used to set permissions on a PDF document. | |||
| newUserPassword : String
Password used to open PDF document. | |||
| opacity : uint = 3
Opacity of the watermark. | |||
| outputFiles : Array
Structure that contains the output files in the DDX file or string as
keys and the pathname to the result file as the value. | |||
| pages : String
Page or pages in the source PDF document on which to perform the action. | |||
| password : String
Owner or user password of the source PDF document,
if the document is password-protected. | |||
| pdfParam : Array
Provides additional information for the cfpdf tag. | |||
| permissions : String
Type of permissions on the PDF document:
All
AllowAssembly
AllowCopy
AllowDegradedPrinting
AllowFillIn
AllowModifyAnnotations
AllowModifyContents
AllowPrinting
AllowScreenReaders
AllowSecure
None
| |||
| position : String
Position on the page where the watermark is placed. | |||
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| resolution : String
Image quality used to generate thumbnail images:
high: use high resolution (uses more memory).
low: use low resolution.
| |||
| rotation : String
Degree of rotation of the watermark image on the page, for example, “60”. | |||
| scale : uint = 25
Size of the thumbnail relative to the source page. | |||
| secureHttp : Boolean
Boolean value that specifies if secure HTTP is used:
yes: uses secure HTTP
no: does not use secure HTTP
| InternalConfig | |
| servicePassword : String
Password to access ColdFusion services. | InternalConfig | |
| serviceUserName : String
Username to access ColdFusion services. | InternalConfig | |
| showOnPrint : Boolean
Specify whether to print the watermark with the PDF document:
yes: the watermark is printed with the PDF document.
no: the watermark is display-only.
| |||
| source : String
PDF document used as the source. | |||
| stopOnError : Boolean
Valid only if the directory attribute is specified. | |||
| transparent : Boolean
(format="png" only)
Specifies whether the image background is transparent or opaque:
yes: the background is transparent.
no: the background is opaque.
| |||
| type : String = "string"
Type attribute indicates the text format in which the text
has to be extracted for the action extractText. | |||
| useStructure : Boolean = true
Lets you extract content based on the PDF structure. | |||
| Method | Defined By | ||
|---|---|---|---|
Pdf()
Creates an instance of the Pdf class. | |||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | BasicService | |
|
Dispatches an event into the event flow. | BasicService | |
Sends the information to the ColdFusion service based on the action and
attributes that the user sets. | |||
|
Returns the RemoteObject instance used by the proxy classes to make the
remote object call. | BasicService | |
|
Checks whether the EventDispatcher object has any listeners registered
for a specific type of event. | BasicService | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | BasicService | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of its
ancestors for the specified event type. | BasicService | |
| Method | Defined By | ||
|---|---|---|---|
[override]
This is the overriden function of the default implementation is BasicService. | |||
addQuads | property |
public var addQuads:Boolean = false| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9.0.1 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Add the position or quadrants of the thumbnail
The default value is false.
copyFrom | property |
public var copyFrom:String| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Pathname of the PDF document from which to use the first page as a watermark.
ddxString | property |
public var ddxString:String| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Pathname of the DDX file, or a string with DDX instructions.
encrypt | property |
public var encrypt:String| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Encryption type for the PDF output file:
RC4_40RC4_128RC4_128MAES_128None
The default value is RC4_128 (Acrobat 5.0 or higher).
foreground | property |
public var foreground:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Placement of the watermark on the page:
yes: the watermark appears in the foreground (over the page content).no: the watermark appears in the background (behind the page content).
The default value is no.
format | property |
public var format:String| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
File type of thumbnail image output:
jpgtiffpng
The default value is jpg.
honourSpaces | property |
public var honourSpaces:Boolean = false| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9.0.1 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Set this option to "true", for improved readability and spacing.
The default value is false.
image | property |
public var image:String| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Image used as a watermark. You can specify a pathname, a variable that contains an image file, or a ColdFusion image variable.
imagePrefix | property |
public var imagePrefix:String| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Prefix used for each image thumbnail file generated. The image filenames use the format: imagePrefix_page_n.format.
info | property |
public var info:Array| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Structure variable for relevant information, for example, “ #infoStruct#". You can specify the Author, Subject, Title, and Keywords for the PDF output file.
inputFiles | property |
public var inputFiles:Array| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Structure that maps the PDF source files to the input variables in the DDX file, or a string of elements and their pathname.
isbase64 | property |
public var isbase64:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Valid only when the image attribute is specified. Specifies whether the image used as a watermark is in Base64 format:
yes: the image is in Base64 format.no: the image is not in Base64 format.
The default value is no.
keepBookmark | property |
public var keepBookmark:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Specifies whether bookmarks from the source PDF documents are retained in the merged document:
yes: the bookmarks are retained.no: the bookmarks are removed.
newOwnerPassword | property |
public var newOwnerPassword:String| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Password used to set permissions on a PDF document.
newUserPassword | property |
public var newUserPassword:String| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Password used to open PDF document.
opacity | property |
public var opacity:uint = 3| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Opacity of the watermark. Valid values are integers in the range 0 (transparent) through 10 (opaque).
outputFiles | property |
public var outputFiles:Array| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Structure that contains the output files in the DDX file or string as keys and the pathname to the result file as the value.
pages | property |
public var pages:String| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Page or pages in the source PDF document on which to perform the action.
The default value is all.
password | property |
public var password:String| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Owner or user password of the source PDF document, if the document is password-protected.
pdfParam | property |
public var pdfParam:Array| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Provides additional information for the cfpdf tag.
The cfpdfparam tag applies only to the merge action of the
cfpdf tag and is always a child tag of the cfpdf tag.
permissions | property |
public var permissions:String| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Type of permissions on the PDF document:
AllAllowAssemblyAllowCopyAllowDegradedPrintingAllowFillInAllowModifyAnnotationsAllowModifyContentsAllowPrintingAllowScreenReadersAllowSecureNone
The default value is all.
position | property |
public var position:String| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Position on the page where the watermark is placed. The position represents the top-left corner of the watermark. Specify the x and y coordinates; for example “50,30”.
resolution | property |
public var resolution:String| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Image quality used to generate thumbnail images:
high: use high resolution (uses more memory).low: use low resolution.
The default value is high.
rotation | property |
public var rotation:String| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Degree of rotation of the watermark image on the page, for example, “60”.
scale | property |
public var scale:uint = 25| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Size of the thumbnail relative to the source page. The value represents a percentage from 1 through 100.
The default value is 25.
showOnPrint | property |
public var showOnPrint:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Specify whether to print the watermark with the PDF document:
yes: the watermark is printed with the PDF document.no: the watermark is display-only.
The default value is no.
source | property |
public var source:String| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
PDF document used as the source. The source can be one of the following:
- An absolute or relative pathname to a PDF document; for example, c:\work\myPDF.pdf or myPDF.pdf.
- A PDF document variable in memory that is generated by the
cfdocumenttag or thecfpdftag.
stopOnError | property |
public var stopOnError:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Valid only if the directory attribute is specified.
If the specified directory contains files other then ColdFusion-readable
PDF files, ColdFusion either stops merge process or continues.
yes: stops the merge process if invalid PDF files exist in the specified directory.no: continues the merge process even if invalid files exist in the specified directory.
transparent | property |
public var transparent:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
(format="png" only) Specifies whether the image background is transparent or opaque:
yes:the background is transparent.no:the background is opaque.
The default value is no.
type | property |
public var type:String = "string"| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9.0.1 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Type attribute indicates the text format in which the text has to be extracted for the action extractText. The values can be string or xml.
The default value is false.
useStructure | property |
public var useStructure:Boolean = true| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9.0.1 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Lets you extract content based on the PDF structure. For better readability of the extracted text, use this attribute together with the attribute honourspaces.
The default value is true.
| () | Constructor |
public function Pdf()| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Creates an instance of the Pdf class.
convertResultInEvent | () | method |
override protected function convertResultInEvent(event:ResultEvent):ColdFusionServiceResultEventThis is the overriden function of the default implementation is BasicService. This function checks if the result returned is an array of specific object instances. If it is, it converts it into an array of objects and creates an instance of ColdFusionResultEvent and returns the event
Parameters
event:ResultEvent |
ColdFusionServiceResultEvent |
execute | () | method |
public function execute():void| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Sends the information to the ColdFusion service based on the action and attributes that the user sets.
Mon Nov 28 2011, 06:48 AM -08:00