FileSpecification Class Documentation

class FileSpecification

Namespace:com::datalogics::PDFL

Detailed Description

Refers to the location of a PDF file within a file system. The PDF file system is known more commonly as the file path name.

The reference can be either absolute, as in a complete path name, or relative to the current place in a directory structure.

Referenced by

LaunchActionRemoteGoToAction

Uses types

DocumentPDFObject

Constructor & Destructor Documentation

FileSpecification

FileSpecification(Document doc, String path)

Parameters

doc: Document

The document in which the file specification is created.

path: String

The string corresponding to the path of the file to reference. It may be relative or absolute.

Creates a new file specification object.

Member Function Documentation

delete

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized void delete()

Returns:

synchronized void

finalize

void finalize()

Returns:

void

getPDFObject

PDFObject getPDFObject()

Returns:

PDFObject

The underlying PDFObject for this FileSpecification.

Retrieve the PDFObject representation of this object.

getPath

String getPath()

Returns:

String

The file path as a string, which may be relative or absolute.

Gets the path to the file referenced.

toString

String toString()

Returns:

String

The path to the file referenced by this FileSpecification.

Returns a string representation of this FileSpecification. The returned value is the file path referenced by this specification.