com.brightech.xmp.js

Class File

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.brightech.xmp.js.MBScriptableObject

com.brightech.xmp.js.File

All Implemented Interfaces:

java.io.Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable

Deprecated.

use UnmanagedFile and UnmanagedFolder instead in 5.3+ versions, the class is still valid for using in the standalone M3taforms application though.

public class File
extends MBScriptableObject

The JavaScript wrapper for File object. This class should not be used to access files managed by MediaBeacon. Only to be used for files and folders external to MediaBeacon. Files and folders managed by MediaBeacon should use ManagedFile and ManagedFolder for additional functionality and better performance.

See Also:

Serialized Form

Field Summary

Fields

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

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
File() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	jsConstructor(java.lang.String thePathName) Deprecated. JavaScript constructor by file path name.
boolean	(JavaScript Function) createNewFile() Deprecated.
boolean	(JavaScript Function) createNewFolder() Deprecated.
BufferedReader	(JavaScript Function) deepFileCount() Deprecated. Returns a BufferedReader for reading the file contents.
int	(JavaScript Function) deepFileCount(boolean theIncludeFolders) Deprecated. Gets number of files in the given directory or returns one if this File object represents single file.
void	(JavaScript Function) forceRemove() Deprecated. Removes the folder including subfolders.
BufferedWriter	(JavaScript Function) getBufferedWriter(boolean theAppend, java.lang.String theEncoding) Deprecated. Returns a BufferedWriter for writing the file contents.
java.lang.String[]	(JavaScript Function) getFilesByDirectory() Deprecated. Gets all files that are located in the current directory (including subdirectories).
void	(JavaScript Function) writeContents(java.lang.String theFileContent) Deprecated.
boolean	(JavaScript Function) writeXmp() Deprecated. Saves xmp changes to physical file.
java.lang.String	(JavaScript Getter) absolute() Deprecated.
File	(JavaScript Getter) absolutePath() Deprecated. Returns the absolute path to this file.
java.lang.String	(JavaScript Getter) colorprofile() Deprecated.
java.lang.String	(JavaScript Getter) colorspace() Deprecated.
java.lang.String	(JavaScript Getter) customName() Deprecated. Javascript method to get the custom name applied to the uploaded file on the upload target.
boolean	(JavaScript Getter) exists() Deprecated.
java.lang.String	(JavaScript Getter) fileNameExtension() Deprecated. Returns the file name extension by parsing the file's name.
java.lang.String	(JavaScript Getter) format() Deprecated.
java.lang.String	(JavaScript Getter) getFileContents() Deprecated.
java.lang.String	(JavaScript Getter) getFileNames() Deprecated.
int	(JavaScript Getter) height() Deprecated.
long	(JavaScript Getter) length() Deprecated.
java.lang.String	(JavaScript Getter) name() Deprecated.
File	(JavaScript Getter) parent() Deprecated.
java.lang.String	(JavaScript Getter) path() Deprecated.
java.lang.Double	(JavaScript Getter) resolution() Deprecated. Get image resolution.
boolean	(JavaScript Getter) valid() Deprecated. Is this file valid, according to M3TAForms Desktop validation?
int	(JavaScript Getter) width() Deprecated.
Xmp	(JavaScript Getter) xmp() Deprecated. Gets XMP block from the file.
void	(JavaScript Setter) customName(java.lang.String theNewName) Deprecated. Javascript method which sets the custom name for the file to be applied on upload.
void	(JavaScript Setter) valid(boolean theFlag) Deprecated. Set that this file is valid, according to M3TAForms Desktop validation.

Methods inherited from class org.mozilla.javascript.ScriptableObject

associateValue, avoidObjectDetection, callMethod, callMethod, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassName, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasInstance, hasProperty, hasProperty, isConst, isEmpty, isExtensible, isSealed, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

kServerTypeAttribute

public static final java.lang.String kServerTypeAttribute

Deprecated.

Server type variable name in the global scope.

See Also:

Constant Field Values

Constructor Detail

File

public File()

Deprecated.

Method Detail

jsConstructor

public void jsConstructor(java.lang.String thePathName)

Deprecated.

JavaScript constructor by file path name.

Parameters:

thePathName - the file path name

(JavaScript Getter) valid

public boolean (JavaScript Getter) valid()

Deprecated.

Is this file valid, according to M3TAForms Desktop validation?

Returns:

true if valid

(JavaScript Setter) valid

public void (JavaScript Setter) valid(boolean theFlag)

Deprecated.

Set that this file is valid, according to M3TAForms Desktop validation.

Parameters:

theFlag - true if valid

(JavaScript Getter) exists

public boolean (JavaScript Getter) exists()

Deprecated.

See Also:

File.exists()

(JavaScript Getter) name

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

Deprecated.

See Also:

File.getName()

(JavaScript Getter) fileNameExtension

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

Deprecated.

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

Returns:

the file name extension.

(JavaScript Getter) path

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

Deprecated.

See Also:

File.getPath()

(JavaScript Getter) parent

public File (JavaScript Getter) parent()

Deprecated.

See Also:

File.getParent()

(JavaScript Function) createNewFile

public boolean (JavaScript Function) createNewFile()

Deprecated.

See Also:

File.createNewFile()

(JavaScript Function) createNewFolder

public boolean (JavaScript Function) createNewFolder()

Deprecated.

See Also:

File.mkdirs()

(JavaScript Getter) absolutePath

public File (JavaScript Getter) absolutePath()

Deprecated.

Returns the absolute path to this file.

See Also:

File.getAbsolutePath()

(JavaScript Getter) absolute

public java.lang.String (JavaScript Getter) absolute()

Deprecated.

See Also:

File.getAbsolutePath()

(JavaScript Getter) length

public long (JavaScript Getter) length()

Deprecated.

See Also:

File.length()

(JavaScript Getter) xmp

public Xmp (JavaScript Getter) xmp()

Deprecated.

Gets XMP block from the file.

(JavaScript Function) deepFileCount

public int (JavaScript Function) deepFileCount(boolean theIncludeFolders)

Deprecated.

Gets number of files in the given directory or returns one if this File object represents single file.

Parameters:

theIncludeFolders - include folder in the count or not

Returns:

number of files

(JavaScript Getter) getFileContents

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

Deprecated.

Returns the file contents as a string. Deprecated: Use getBufferedReader instead.

Returns:

file contents as a string

(JavaScript Function) deepFileCount

public BufferedReader (JavaScript Function) deepFileCount()
                                        throws java.io.IOException

Deprecated.

Returns a BufferedReader for reading the file contents.

Returns:

a BufferedReader

Throws:

java.io.IOException

See Also:

BufferedReader

(JavaScript Function) getBufferedWriter

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

Deprecated.

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) writeContents

@Deprecated
public void (JavaScript Function) writeContents(java.lang.String theFileContent)

Deprecated.

Write the given string to this file. Note: This will overwite the existing file.

Parameters:

theFileContent - The text to write to the file.

(JavaScript Getter) getFileNames

public java.lang.String (JavaScript Getter) getFileNames()

Deprecated.

(JavaScript Function) getFilesByDirectory

public java.lang.String[] (JavaScript Function) getFilesByDirectory()

Deprecated.

Gets all files that are located in the current directory (including subdirectories).

Returns:

the array that contains absolute pathes of the internal files

(JavaScript Function) forceRemove

public void (JavaScript Function) forceRemove()

Deprecated.

Removes the folder including subfolders.

(JavaScript Function) writeXmp

public boolean (JavaScript Function) writeXmp()

Deprecated.

Saves xmp changes to physical file.

Returns:

written successully?

(JavaScript Getter) width

public int (JavaScript Getter) width()

Deprecated.

Returns:

image width

(JavaScript Getter) height

public int (JavaScript Getter) height()

Deprecated.

Returns:

image height

(JavaScript Getter) format

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

Deprecated.

(JavaScript Getter) colorspace

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

Deprecated.

(JavaScript Getter) colorprofile

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

Deprecated.

(JavaScript Getter) resolution

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

Deprecated.

Get image resolution.

Returns:

The image resolution, as a Double.

(JavaScript Getter) customName

public java.lang.String (JavaScript Getter) customName()

Deprecated.

Javascript method to get the custom name applied to the uploaded file on the upload target.

Returns:

the custom name

(JavaScript Setter) customName

public void (JavaScript Setter) customName(java.lang.String theNewName)

Deprecated.

Javascript method which sets the custom name for the file to be applied on upload. This applies to the name of the file as it will appear on the upload target, but not on the local machine.

Parameters:

theNewName - the name to be applied