com.brightech.xmp.js

Interface IFileObject

All Superinterfaces:

org.mozilla.javascript.Scriptable

All Known Implementing Classes:

Bundle, ManagedFile, PDF, UnmanagedFile, Workflow

public interface IFileObject
extends org.mozilla.javascript.Scriptable

Required javascript interface for File objects.

Field Summary

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Method Summary

Modifier and Type	Method and Description
BufferedReader	(JavaScript Function) getBufferedReader(java.lang.String theEncoding) Returns a BufferedReader for reading the file contents.
BufferedWriter	(JavaScript Function) getBufferedWriter(boolean theAppend, java.lang.String theEncoding) Returns a BufferedWriter for writing the file contents.
FileOutputStream	(JavaScript Function) getFileOutputStream() Gets a FileOutputStream for writing the file contents.
boolean	(JavaScript Function) writeXmp() Saves xmp changes.
java.lang.String	(JavaScript Getter) colorprofile() Returns the colorprofile format.
java.lang.String	(JavaScript Getter) colorspace() Returns the colorspace format.
boolean	(JavaScript Getter) exists() Tests whether the file denoted by this abstract pathname exists.
java.lang.String	(JavaScript Getter) fileNameExtension() Returns the file name extension by parsing the file's name.
java.lang.String	(JavaScript Getter) format() Returns the image format.
java.lang.String	(JavaScript Getter) getFileContents() Deprecated.
int	(JavaScript Getter) height() Returns the image height.
long	(JavaScript Getter) lastModified() Return file modified timestamp in milliseconds
long	(JavaScript Getter) length() Returns the lenth of the file.
java.lang.String	(JavaScript Getter) name() Returns the name of the file or directory.
IFolderObject	(JavaScript Getter) parent() Returns the parent file o directory.
java.lang.String	(JavaScript Getter) path() Returns the file's path.
java.lang.Double	(JavaScript Getter) resolution() Returns the image resolution.
int	(JavaScript Getter) width() Returns the image width.
Xmp	(JavaScript Getter) xmp() Gets XMP block from the file.

Methods inherited from interface org.mozilla.javascript.Scriptable

delete, delete, get, get, getClassName, getDefaultValue, getIds, getParentScope, getPrototype, has, has, hasInstance, put, put, setParentScope, setPrototype

Method Detail

(JavaScript Getter) exists

boolean (JavaScript Getter) exists()

Tests whether the file denoted by this abstract pathname exists.

Returns:

true if the file or directory exists.

(JavaScript Getter) lastModified

long (JavaScript Getter) lastModified()

Return file modified timestamp in milliseconds

Returns:

File modified timestamp in milliseconds

(JavaScript Getter) name

java.lang.String (JavaScript Getter) name()

Returns the name of the file or directory.

Returns:

returns the name of the file or directory.

(JavaScript Getter) fileNameExtension

java.lang.String (JavaScript Getter) fileNameExtension()

Returns the file name extension by parsing the file's name.

Returns:

the file name extension.

(JavaScript Getter) path

java.lang.String (JavaScript Getter) path()

Returns the file's path. May be relative or absolute.

Returns:

the file's path.

(JavaScript Getter) parent

IFolderObject (JavaScript Getter) parent()

Returns the parent file o directory.

Returns:

the IFileObject represents parent file or directory.

(JavaScript Getter) length

long (JavaScript Getter) length()

Returns the lenth of the file.

Returns:

The length, in bytes, of the file denoted by this abstract pathname, or 0L if the file does not exist.

(JavaScript Getter) xmp

Xmp (JavaScript Getter) xmp()

Gets XMP block from the file.

Returns:

the Xmp block.

See Also:

Xmp

(JavaScript Function) writeXmp

boolean (JavaScript Function) writeXmp()
                     throws MalformedXmpFieldException

Saves xmp changes.

Returns:

written successully?

Throws:

MalformedXmpFieldException

(JavaScript Getter) width

int (JavaScript Getter) width()

Returns the image width.

Returns:

the image width in pixels.

(JavaScript Getter) height

int (JavaScript Getter) height()

Returns the image height.

Returns:

the image height in pixels.

(JavaScript Getter) format

java.lang.String (JavaScript Getter) format()

Returns the image format.

Returns:

the image format.

(JavaScript Getter) colorspace

java.lang.String (JavaScript Getter) colorspace()

Returns the colorspace format.

Returns:

the colorspace format.

(JavaScript Getter) colorprofile

java.lang.String (JavaScript Getter) colorprofile()

Returns the colorprofile format.

Returns:

the colorprofile format.

(JavaScript Getter) resolution

java.lang.Double (JavaScript Getter) resolution()

Returns the image resolution.

Returns:

the image resolution.

(JavaScript Getter) getFileContents

@Deprecated
java.lang.String (JavaScript Getter) getFileContents()

Deprecated.

Returns the file contents.

Returns:

the file contents.

(JavaScript Function) getBufferedReader

BufferedReader (JavaScript Function) getBufferedReader(java.lang.String theEncoding)
                                     throws java.io.IOException

Returns a BufferedReader for reading the file contents.

Returns:

a BufferedReader

Throws:

java.io.IOException

See Also:

BufferedReader

(JavaScript Function) getBufferedWriter

BufferedWriter (JavaScript Function) getBufferedWriter(boolean theAppend,
                                            java.lang.String theEncoding)
                                     throws java.io.IOException

Returns a BufferedWriter for writing the file contents.

Parameters:

theAppend - true if file should be opened for append

theEncoding - default is UTF-8, can pass others (like UTF-16)

Returns:

a BufferedWriter

Throws:

java.io.IOException

See Also:

BufferedWriter

(JavaScript Function) getFileOutputStream

FileOutputStream (JavaScript Function) getFileOutputStream()
                                         throws java.io.IOException

Gets a FileOutputStream for writing the file contents.

Returns:

a FileOutputStream

Throws:

java.io.IOException