com.brightech.xmp.js

Interface IFileObject

All Superinterfaces:

org.mozilla.javascript.Scriptable

All Known Implementing Classes:

Bundle, FileBase, ManagedFile, PDF, TranscodingFile, UnmanagedFile, Workflow

public interface IFileObject
extends org.mozilla.javascript.Scriptable

Required javascript interface for File objects.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	kServerTypeAttribute Server type variable name in the global scope.

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Method Summary

Modifier and Type	Method and Description
BufferedReader	jsFunction_getBufferedReader(java.lang.String theEncoding) Returns a BufferedReader for reading the file contents.
BufferedWriter	jsFunction_getBufferedWriter(boolean theAppend, java.lang.String theEncoding) Returns a BufferedWriter for writing the file contents.
FileOutputStream	jsFunction_getFileOutputStream() Gets a FileOutputStream for writing the file contents.
boolean	jsFunction_writeXmp() Saves xmp changes.
java.lang.String	jsGet_base64() Gets the bytes for this file and encodes it as a base64 string
java.lang.String	jsGet_colorprofile() Returns the colorprofile format.
java.lang.String	jsGet_colorspace() Returns the colorspace format.
org.mozilla.javascript.IdScriptableObject	jsGet_errorMessage() Gets error message that occurred during xmp writing.
boolean	jsGet_exists() Tests whether the file denoted by this abstract pathname exists.
java.lang.String	jsGet_fileNameExtension() Returns the file name extension by parsing the file's name.
java.lang.String	jsGet_format() Returns the image format.
java.lang.String	jsGet_getFileContents() Deprecated.
int	jsGet_height() Returns the image height.
long	jsGet_lastModified() Return file modified timestamp in milliseconds
long	jsGet_length() Returns the lenth of the file.
java.lang.String	jsGet_name() Returns the name of the file or directory.
IFolderObject	jsGet_parent() Returns the parent file o directory.
java.lang.String	jsGet_path() Returns the file's path.
java.lang.Double	jsGet_resolution() Returns the image resolution.
int	jsGet_width() Returns the image width.
Xmp	jsGet_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

Field Detail

kServerTypeAttribute

static final java.lang.String kServerTypeAttribute

Server type variable name in the global scope.

See Also:

Constant Field Values

Method Detail

jsGet_exists

boolean jsGet_exists()

Tests whether the file denoted by this abstract pathname exists.

Returns:

true if the file or directory exists.

jsGet_lastModified

long jsGet_lastModified()

Return file modified timestamp in milliseconds

Returns:

File modified timestamp in milliseconds

jsGet_name

java.lang.String jsGet_name()

Returns the name of the file or directory.

Returns:

returns the name of the file or directory.

jsGet_fileNameExtension

java.lang.String jsGet_fileNameExtension()

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

Returns:

the file name extension.

jsGet_path

java.lang.String jsGet_path()

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

Returns:

the file's path.

jsGet_parent

IFolderObject jsGet_parent()

Returns the parent file o directory.

Returns:

the IFileObject represents parent file or directory.

jsGet_length

long jsGet_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.

jsGet_xmp

Xmp jsGet_xmp()

Gets XMP block from the file.

Returns:

the Xmp block.

See Also:

Xmp

jsFunction_writeXmp

boolean jsFunction_writeXmp()
                     throws com.brightech.xmp.model.xmlmodel.MalformedXmpFieldException

Saves xmp changes.

Returns:

written successully?

Throws:

com.brightech.xmp.model.xmlmodel.MalformedXmpFieldException

jsGet_errorMessage

org.mozilla.javascript.IdScriptableObject jsGet_errorMessage()

Gets error message that occurred during xmp writing.

Returns:

the error message

jsGet_width

int jsGet_width()

Returns the image width.

Returns:

the image width in pixels.

jsGet_height

int jsGet_height()

Returns the image height.

Returns:

the image height in pixels.

jsGet_format

java.lang.String jsGet_format()

Returns the image format.

Returns:

the image format.

jsGet_colorspace

java.lang.String jsGet_colorspace()

Returns the colorspace format.

Returns:

the colorspace format.

jsGet_colorprofile

java.lang.String jsGet_colorprofile()

Returns the colorprofile format.

Returns:

the colorprofile format.

jsGet_resolution

java.lang.Double jsGet_resolution()

Returns the image resolution.

Returns:

the image resolution.

jsGet_getFileContents

@Deprecated
java.lang.String jsGet_getFileContents()

Deprecated.

Returns the file contents.

Returns:

the file contents.

jsFunction_getBufferedReader

BufferedReader jsFunction_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

jsFunction_getBufferedWriter

BufferedWriter jsFunction_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

jsFunction_getFileOutputStream

FileOutputStream jsFunction_getFileOutputStream()
                                         throws java.io.IOException

Gets a FileOutputStream for writing the file contents.

Returns:

a FileOutputStream

Throws:

java.io.IOException

jsGet_base64

java.lang.String jsGet_base64()

Gets the bytes for this file and encodes it as a base64 string

Returns:

a base64 string representation of the file or null.