DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR
{column:width=80px|padding=0px}{column}{column}{column}
Method Summary
createNewFile()
Creates the file on disk if needed.
deleteFile()
Deletes the file from the disk if possible.
getAbsoluteFile()
Returns a JSFile instance that corresponds to the absolute form of this pathname - works on remote files too.
getAbsolutePath()
Returns a String representation of the absolute form of this pathname - works on remote files too.
byte[]
getBytes()
Gets the contents (bytes) for the file data.
getContentType()
Returns the contenttype of this file, like for example 'application/pdf' - works on remote files too.
getParentFile()
Returns a JSFile instance that corresponds to the parent of this file - works on remote files too.
isAbsolute()
Returns true if the path is absolute.
isDirectory()
Returns true if the file is a directory - works on remote files too.
lastModified()
Returns the time/date of the last modification on the file - works on remote files too.
setLastModified(date)
Sets the date/time of the last modification on the file.
setReadOnly()
Sets the readonly attribute of the file/directory.
{column:width=100%|padding=0px}{column}
Method Details
canRead
()
Sample
var f = plugins.file.convertToJSFile('./big.jpg'); // or for a remote file: // var f = plugins.convertToRemoteJSFile('/images/big.jpg'); if (f && f.exists()) { application.output('is absolute: ' + f.isAbsolute()); application.output('is dir: ' + f.isDirectory()); application.output('is file: ' + f.isFile()); application.output('is hidden: ' + f.isHidden()); application.output('can read: ' + f.canRead()); application.output('can write: ' + f.canWrite()); application.output('last modified: ' + f.lastModified()); application.output('name: ' + f.getName()); application.output('path: ' + f.getPath()); application.output('absolute path: ' + f.getAbsolutePath()); application.output('content type: ' + f.getContentType()); application.output('size: ' + f.size()); } else { application.output('File/folder not found.'); }
canWrite
()
Sample
var f = plugins.file.convertToJSFile('./big.jpg'); // or for a remote file: // var f = plugins.convertToRemoteJSFile('/images/big.jpg'); if (f && f.exists()) { application.output('is absolute: ' + f.isAbsolute()); application.output('is dir: ' + f.isDirectory()); application.output('is file: ' + f.isFile()); application.output('is hidden: ' + f.isHidden()); application.output('can read: ' + f.canRead()); application.output('can write: ' + f.canWrite()); application.output('last modified: ' + f.lastModified()); application.output('name: ' + f.getName()); application.output('path: ' + f.getPath()); application.output('absolute path: ' + f.getAbsolutePath()); application.output('content type: ' + f.getContentType()); application.output('size: ' + f.size()); } else { application.output('File/folder not found.'); }
createNewFile
()
Sample
var f = plugins.file.convertToJSFile('story.txt'); if (!f.exists()) f.createNewFile();
deleteFile
()
Sample
var f = plugins.file.convertToJSFile('story.txt'); // or for a remote file: // var f = plugins.convertToRemoteJSFile('/story.txt'); if (f && f.exists()) f.deleteFile();
exists
()
Sample
var f = plugins.file.convertToJSFile('./big.jpg'); // or for a remote file: // var f = plugins.convertToRemoteJSFile('/images/big.jpg'); if (f && f.exists()) { application.output('is absolute: ' + f.isAbsolute()); application.output('is dir: ' + f.isDirectory()); application.output('is file: ' + f.isFile()); application.output('is hidden: ' + f.isHidden()); application.output('can read: ' + f.canRead()); application.output('can write: ' + f.canWrite()); application.output('last modified: ' + f.lastModified()); application.output('name: ' + f.getName()); application.output('path: ' + f.getPath()); application.output('absolute path: ' + f.getAbsolutePath()); application.output('content type: ' + f.getContentType()); application.output('size: ' + f.size()); } else { application.output('File/folder not found.'); }
getAbsoluteFile
()
Sample
var f = plugins.file.convertToJSFile('story.txt'); // or for a remote file: // var f = plugins.file.convertToRemoteJSFile('/story.txt'); application.output('parent folder: ' + f.getAbsoluteFile().getParent()); application.output('parent folder has ' + f.getAbsoluteFile().getParentFile().listFiles().length + ' entries');
getAbsolutePath
()
Sample
var f = plugins.file.convertToJSFile('./big.jpg'); // or for a remote file: // var f = plugins.convertToRemoteJSFile('/images/big.jpg'); if (f && f.exists()) { application.output('is absolute: ' + f.isAbsolute()); application.output('is dir: ' + f.isDirectory()); application.output('is file: ' + f.isFile()); application.output('is hidden: ' + f.isHidden()); application.output('can read: ' + f.canRead()); application.output('can write: ' + f.canWrite()); application.output('last modified: ' + f.lastModified()); application.output('name: ' + f.getName()); application.output('path: ' + f.getPath()); application.output('absolute path: ' + f.getAbsolutePath()); application.output('content type: ' + f.getContentType()); application.output('size: ' + f.size()); } else { application.output('File/folder not found.'); }
byte[]
getBytes
()
Returns
byte[]
Sample
var theFile = plugins.file.showFileOpenDialog(); application.output('The file size in bytes: ' + theFile.getBytes());
getContentType
()
Sample
var f = plugins.file.convertToJSFile('./big.jpg'); // or for a remote file: // var f = plugins.convertToRemoteJSFile('/images/big.jpg'); if (f && f.exists()) { application.output('is absolute: ' + f.isAbsolute()); application.output('is dir: ' + f.isDirectory()); application.output('is file: ' + f.isFile()); application.output('is hidden: ' + f.isHidden()); application.output('can read: ' + f.canRead()); application.output('can write: ' + f.canWrite()); application.output('last modified: ' + f.lastModified()); application.output('name: ' + f.getName()); application.output('path: ' + f.getPath()); application.output('absolute path: ' + f.getAbsolutePath()); application.output('content type: ' + f.getContentType()); application.output('size: ' + f.size()); } else { application.output('File/folder not found.'); }
getName
()
Sample
var f = plugins.file.convertToJSFile('./big.jpg'); // or for a remote file: // var f = plugins.convertToRemoteJSFile('/images/big.jpg'); if (f && f.exists()) { application.output('is absolute: ' + f.isAbsolute()); application.output('is dir: ' + f.isDirectory()); application.output('is file: ' + f.isFile()); application.output('is hidden: ' + f.isHidden()); application.output('can read: ' + f.canRead()); application.output('can write: ' + f.canWrite()); application.output('last modified: ' + f.lastModified()); application.output('name: ' + f.getName()); application.output('path: ' + f.getPath()); application.output('absolute path: ' + f.getAbsolutePath()); application.output('content type: ' + f.getContentType()); application.output('size: ' + f.size()); } else { application.output('File/folder not found.'); }
getParent
()
Sample
var f = plugins.file.convertToJSFile('story.txt'); // or for a remote file: // var f = plugins.file.convertToRemoteJSFile('/story.txt'); application.output('parent folder: ' + f.getAbsoluteFile().getParent()); application.output('parent folder has ' + f.getAbsoluteFile().getParentFile().listFiles().length + ' entries');
getParentFile
()
Sample
var f = plugins.file.convertToJSFile('story.txt'); // or for a remote file: // var f = plugins.file.convertToRemoteJSFile('/story.txt'); application.output('parent folder: ' + f.getAbsoluteFile().getParent()); application.output('parent folder has ' + f.getAbsoluteFile().getParentFile().listFiles().length + ' entries');
getPath
()
Sample
var f = plugins.file.convertToJSFile('./big.jpg'); // or for a remote file: // var f = plugins.convertToRemoteJSFile('/images/big.jpg'); if (f && f.exists()) { application.output('is absolute: ' + f.isAbsolute()); application.output('is dir: ' + f.isDirectory()); application.output('is file: ' + f.isFile()); application.output('is hidden: ' + f.isHidden()); application.output('can read: ' + f.canRead()); application.output('can write: ' + f.canWrite()); application.output('last modified: ' + f.lastModified()); application.output('name: ' + f.getName()); application.output('path: ' + f.getPath()); application.output('absolute path: ' + f.getAbsolutePath()); application.output('content type: ' + f.getContentType()); application.output('size: ' + f.size()); } else { application.output('File/folder not found.'); }
isAbsolute
()
Sample
var f = plugins.file.convertToJSFile('./big.jpg'); // or for a remote file: // var f = plugins.convertToRemoteJSFile('/images/big.jpg'); if (f && f.exists()) { application.output('is absolute: ' + f.isAbsolute()); application.output('is dir: ' + f.isDirectory()); application.output('is file: ' + f.isFile()); application.output('is hidden: ' + f.isHidden()); application.output('can read: ' + f.canRead()); application.output('can write: ' + f.canWrite()); application.output('last modified: ' + f.lastModified()); application.output('name: ' + f.getName()); application.output('path: ' + f.getPath()); application.output('absolute path: ' + f.getAbsolutePath()); application.output('content type: ' + f.getContentType()); application.output('size: ' + f.size()); } else { application.output('File/folder not found.'); }
isDirectory
()
Sample
var f = plugins.file.convertToJSFile('./big.jpg'); // or for a remote file: // var f = plugins.convertToRemoteJSFile('/images/big.jpg'); if (f && f.exists()) { application.output('is absolute: ' + f.isAbsolute()); application.output('is dir: ' + f.isDirectory()); application.output('is file: ' + f.isFile()); application.output('is hidden: ' + f.isHidden()); application.output('can read: ' + f.canRead()); application.output('can write: ' + f.canWrite()); application.output('last modified: ' + f.lastModified()); application.output('name: ' + f.getName()); application.output('path: ' + f.getPath()); application.output('absolute path: ' + f.getAbsolutePath()); application.output('content type: ' + f.getContentType()); application.output('size: ' + f.size()); } else { application.output('File/folder not found.'); }
isFile
()
Sample
var f = plugins.file.convertToJSFile('./big.jpg'); // or for a remote file: // var f = plugins.convertToRemoteJSFile('/images/big.jpg'); if (f && f.exists()) { application.output('is absolute: ' + f.isAbsolute()); application.output('is dir: ' + f.isDirectory()); application.output('is file: ' + f.isFile()); application.output('is hidden: ' + f.isHidden()); application.output('can read: ' + f.canRead()); application.output('can write: ' + f.canWrite()); application.output('last modified: ' + f.lastModified()); application.output('name: ' + f.getName()); application.output('path: ' + f.getPath()); application.output('absolute path: ' + f.getAbsolutePath()); application.output('content type: ' + f.getContentType()); application.output('size: ' + f.size()); } else { application.output('File/folder not found.'); }
isHidden
()
Sample
var f = plugins.file.convertToJSFile('./big.jpg'); // or for a remote file: // var f = plugins.convertToRemoteJSFile('/images/big.jpg'); if (f && f.exists()) { application.output('is absolute: ' + f.isAbsolute()); application.output('is dir: ' + f.isDirectory()); application.output('is file: ' + f.isFile()); application.output('is hidden: ' + f.isHidden()); application.output('can read: ' + f.canRead()); application.output('can write: ' + f.canWrite()); application.output('last modified: ' + f.lastModified()); application.output('name: ' + f.getName()); application.output('path: ' + f.getPath()); application.output('absolute path: ' + f.getAbsolutePath()); application.output('content type: ' + f.getContentType()); application.output('size: ' + f.size()); } else { application.output('File/folder not found.'); }
lastModified
()
Sample
var f = plugins.file.convertToJSFile('./big.jpg'); // or for a remote file: // var f = plugins.convertToRemoteJSFile('/images/big.jpg'); if (f && f.exists()) { application.output('is absolute: ' + f.isAbsolute()); application.output('is dir: ' + f.isDirectory()); application.output('is file: ' + f.isFile()); application.output('is hidden: ' + f.isHidden()); application.output('can read: ' + f.canRead()); application.output('can write: ' + f.canWrite()); application.output('last modified: ' + f.lastModified()); application.output('name: ' + f.getName()); application.output('path: ' + f.getPath()); application.output('absolute path: ' + f.getAbsolutePath()); application.output('content type: ' + f.getContentType()); application.output('size: ' + f.size()); } else { application.output('File/folder not found.'); }
String[]
list
()
Sample
var d = plugins.file.convertToJSFile('plugins'); // or for a remote file: // var d = plugins.convertToRemoteJSFile('/plugins'); var names = d.list(); application.output('Names:'); for (var i=0; i<names.length; i++) application.output(names[i]); var files = d.listFiles(); application.output('Absolute paths:'); for (var i=0; i<files.length; i++) application.output(files[i].getAbsolutePath());
JSFile[]
listFiles
()
Sample
var d = plugins.file.convertToJSFile('plugins'); // or for a remote file: // var d = plugins.convertToRemoteJSFile('/plugins'); var names = d.list(); application.output('Names:'); for (var i=0; i<names.length; i++) application.output(names[i]); var files = d.listFiles(); application.output('Absolute paths:'); for (var i=0; i<files.length; i++) application.output(files[i].getAbsolutePath());
mkdir
()
Sample
var f = plugins.file.convertToJSFile('one/two/three/four'); f.mkdirs(); // Create all four levels of folders in one step. var g = plugins.file.convertToJSFile('one/two/three/four/five'); g.mkdir(); // This will work because all parent folders are already created.
mkdirs
()
Sample
var f = plugins.file.convertToJSFile('one/two/three/four'); f.mkdirs(); // Create all four levels of folders in one step. var g = plugins.file.convertToJSFile('one/two/three/four/five'); g.mkdir(); // This will work because all parent folders are already created.
renameTo
(destination)
Sample
var f = plugins.file.convertToJSFile('story.txt'); f.renameTo('otherstory.txt'); // or for a remote file: // var f = plugins.convertToRemoteJSFile('/story.txt'); // f.renameTo('/otherstory.txt');
setBytes
(bytes)
Since
5.2.5
Parameters
{byte[]} bytes – the data
Sample
var file = plugins.file.convertToJSFile('/pathTo/file.jpg'); // or for a remote file: // var file = plugins.file.convertToRemoteJSFile('/remotePathTo/file.jpg'); var success = file.setBytes(blobDataProvider, true);
setBytes
(bytes, createFile)
Since
5.2.5
Parameters
{byte[]} bytes – the data
{Boolean} createFile – true to create a file if it doesn't exist
Sample
var file = plugins.file.convertToJSFile('/pathTo/file.jpg'); // or for a remote file: // var file = plugins.file.convertToRemoteJSFile('/remotePathTo/file.jpg'); var success = file.setBytes(blobDataProvider, true);
setLastModified
(date)
Sample
var f = plugins.file.convertToJSFile('story.txt'); f.createNewFile(); // Make the file look old. f.setLastModified(new Date(1999, 5, 21));
setReadOnly
()
Sample
var f = plugins.file.convertToJSFile('invoice.txt'); plugins.file.writeTXTFile(f, 'important data that should not be changed'); f.setReadOnly();
Sample
var f = plugins.file.convertToJSFile('./big.jpg'); // or for a remote file: // var f = plugins.convertToRemoteJSFile('/images/big.jpg'); if (f && f.exists()) { application.output('is absolute: ' + f.isAbsolute()); application.output('is dir: ' + f.isDirectory()); application.output('is file: ' + f.isFile()); application.output('is hidden: ' + f.isHidden()); application.output('can read: ' + f.canRead()); application.output('can write: ' + f.canWrite()); application.output('last modified: ' + f.lastModified()); application.output('name: ' + f.getName()); application.output('path: ' + f.getPath()); application.output('absolute path: ' + f.getAbsolutePath()); application.output('content type: ' + f.getContentType()); application.output('size: ' + f.size()); } else { application.output('File/folder not found.'); }