Page History

...

HTML Table

id
class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

tbody

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#canRead canRead() Returns true if the file exists and is readable (has access to it) - works on remote files too.

tbody

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#canWrite canWrite() Returns true if the file exists and can be modified - works on remote files too.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#createNewFile createNewFile() Creates the file on disk if needed.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#deleteFile deleteFile() Deletes the file from the disk if possible.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#exists exists() Returns true if the file/directory exists on the filesystem - works on remote files too.

tbody

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSFile

Table Cell (td)
#getAbsoluteFile getAbsoluteFile() Returns a JSFile instance that corresponds to the absolute form of this pathname - works on remote files too.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getAbsolutePath getAbsolutePath() Returns a String representation of the absolute form of this pathname - works on remote files too.

tbody

Table Body (tbody)

Table Row (tr)

Table Cell (td)
byte[]

Table Cell (td)
#getBytes getBytes() Gets the contents (bytes) for the file data.

tbody

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getContentType getContentType() Returns the contenttype of this file, like for example 'application/pdf' - works on remote files too.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getName getName() Returns the name of the file.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getParent getParent() Returns the String representation of the path of the parent of this file - works on remote files too.

tbody

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSFile

Table Cell (td)
#getParentFile getParentFile() Returns a JSFile instance that corresponds to the parent of this file - works on remote files too.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getPath getPath() Returns a String holding the path to the file - works on remote files too.

tbody

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#isAbsolute isAbsolute() Returns true if the path is absolute.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#isDirectory isDirectory() Returns true if the file is a directory - works on remote files too.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#isFile isFile() Returns true if the file is a file and not a regular file - works on remote files too.

tbody

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#isHidden isHidden() Returns true if the file is hidden (a file system attribute) - works on remote files too.

Table Row (tr)

Table Cell (td)
Date

Table Cell (td)
#lastModified lastModified() Returns the time/date of the last modification on the file - works on remote files too.

tbody

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String[]

Table Cell (td)
#list list() Returns an array of strings naming the files and directories located inside the file, if the file is a directory - works on remote files too.

tbody

Table Row (tr)

Table Cell (td)
JSFile[]

Table Cell (td)
#listFiles listFiles() Returns an array of JSFiles naming the files and directories located inside the file, if the file is a directory - works on remote files too.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#mkdir mkdir() Creates a directory on disk if possible.

tbody

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#mkdirs mkdirs() Creates a directory on disk, together with all its parent directories, if possible.

tbody

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#renameTo renameTo(destination) Renames the file to a different name.

tbody

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#setBytes setBytes(bytes) Set the content of the file (local or remote) to the bytes provided<br/> Will not create a new file if one doesn't exist

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#setBytes setBytes(bytes, createFile) Set the content of the file (local or remote) to the bytes provided

tbody

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#setLastModified setLastModified(date) Sets the date/time of the last modification on the file.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#setReadOnly setReadOnly() Sets the readonly attribute of the file/directory.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#size size() Returns the size in bytes of the file.

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Method Details

Table Body (tbody)

id	canRead

Table Row (tr)

id	name

Table Cell (td)
canRead

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

canRead

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns true if the file exists and is readable (has access to it) - works on remote files too.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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.');
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	canWrite

Table Row (tr)

id	name

Table Cell (td)
canWrite

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

canWrite

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns true if the file exists and can be modified - works on remote files too.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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.');
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createNewFile

Table Row (tr)

id	name

Table Cell (td)
createNewFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

createNewFile

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates the file on disk if needed. Returns true if the file (name) did not already exists and had to be created - for remote, use the streamFilesToServer to stream a file.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

var f = plugins.file.convertToJSFile('story.txt');
if (!f.exists())
	f.createNewFile();

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	deleteFile

Table Row (tr)

id	name

Table Cell (td)
deleteFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

deleteFile

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Deletes the file from the disk if possible. Returns true if the file could be deleted. If the file is a directory, then it must be empty in order to be deleted - works on remote files too.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

var f = plugins.file.convertToJSFile('story.txt');
// or for a remote file:
// var f = plugins.convertToRemoteJSFile('/story.txt');
if (f && f.exists())
	f.deleteFile();

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	exists

Table Row (tr)

id	name

Table Cell (td)
exists

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

exists

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns true if the file/directory exists on the filesystem - works on remote files too.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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.');
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getAbsoluteFile

Table Row (tr)

id	name

Table Cell (td)
getAbsoluteFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile

Span

style	font-weight: bold;

getAbsoluteFile

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns a JSFile instance that corresponds to the absolute form of this pathname - works on remote files too.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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');

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getAbsolutePath

Table Row (tr)

id	name

Table Cell (td)
getAbsolutePath

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getAbsolutePath

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns a String representation of the absolute form of this pathname - works on remote files too.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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.');
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getBytes

Table Row (tr)

id	name

Table Cell (td)
getBytes

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

byte[]

Span

style	font-weight: bold;

getBytes

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets the contents (bytes) for the file data.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

byte[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

var theFile = plugins.file.showFileOpenDialog();
application.output('The file size in bytes: ' + theFile.getBytes());

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getContentType

Table Row (tr)

id	name

Table Cell (td)
getContentType

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getContentType

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the contenttype of this file, like for example 'application/pdf' - works on remote files too.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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.');
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getName

Table Row (tr)

id	name

Table Cell (td)
getName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getName

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the name of the file. The name consists in the last part of the file path - works on remote files too.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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.');
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getParent

Table Row (tr)

id	name

Table Cell (td)
getParent

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getParent

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the String representation of the path of the parent of this file - works on remote files too.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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');

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getParentFile

Table Row (tr)

id	name

Table Cell (td)
getParentFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile

Span

style	font-weight: bold;

getParentFile

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns a JSFile instance that corresponds to the parent of this file - works on remote files too.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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');

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getPath

Table Row (tr)

id	name

Table Cell (td)
getPath

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getPath

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns a String holding the path to the file - works on remote files too.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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.');
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	isAbsolute

Table Row (tr)

id	name

Table Cell (td)
isAbsolute

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

isAbsolute

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns true if the path is absolute. The path is absolute if it starts with '/' on Unix/Linux/MacOS or has a driver letter on Windows - works on remote files too.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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.');
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	isDirectory

Table Row (tr)

id	name

Table Cell (td)
isDirectory

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

isDirectory

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns true if the file is a directory - works on remote files too.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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.');
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	isFile

Table Row (tr)

id	name

Table Cell (td)
isFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

isFile

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns true if the file is a file and not a regular file - works on remote files too.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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.');
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	isHidden

Table Row (tr)

id	name

Table Cell (td)
isHidden

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

isHidden

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns true if the file is hidden (a file system attribute) - works on remote files too.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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.');
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	lastModified

Table Row (tr)

id	name

Table Cell (td)
lastModified

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Date

Span

style	font-weight: bold;

lastModified

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the time/date of the last modification on the file - works on remote files too.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Date

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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.');
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	list

Table Row (tr)

id	name

Table Cell (td)
list

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String[]

Span

style	font-weight: bold;

list

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns an array of strings naming the files and directories located inside the file, if the file is a directory - works on remote files too.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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());

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	listFiles

Table Row (tr)

id	name

Table Cell (td)
listFiles

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile[]

Span

style	font-weight: bold;

listFiles

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns an array of JSFiles naming the files and directories located inside the file, if the file is a directory - works on remote files too.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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());

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	mkdir

Table Row (tr)

id	name

Table Cell (td)
mkdir

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

mkdir

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a directory on disk if possible. Returns true if a new directory was created - for remote, use the streamFilesToServer to create the directory instead.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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.

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	mkdirs

Table Row (tr)

id	name

Table Cell (td)
mkdirs

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

mkdirs

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a directory on disk, together with all its parent directories, if possible. Returns true if the hierarchy of directories is created - for remote, use the streamFilesToServer to create the directories instead.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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.

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	renameTo-Object

Table Row (tr)

id	name

Table Cell (td)
renameTo

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

renameTo

Span
(destination)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Renames the file to a different name. Returns true if the file could be renamed - works on remote files too.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} destination

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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');

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setBytes-byteArray

Table Row (tr)

id	name

Table Cell (td)
setBytes

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

setBytes

Span
(bytes)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set the content of the file (local or remote) to the bytes provided<br/>
Will not create a new file if one doesn't exist

Table Row (tr)

id	snc

Table Cell (td)

Since

Div

class	sIndent

5.2.5

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{byte[]} bytes

...

- the data

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

...

- true if the operation worked

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setBytes-byteArray_Boolean

Table Row (tr)

id	name

Table Cell (td)
setBytes

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

setBytes

Span
(bytes, createFile)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set the content of the file (local or remote) to the bytes provided

Table Row (tr)

id	snc

Table Cell (td)

Since

Div

class	sIndent

5.2.5

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{byte[]} bytes

...

- the data
{Boolean} createFile

...

- true to create a file if it doesn't exist

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

...

- true if the operation worked

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setLastModified-Object

Table Row (tr)

id	name

Table Cell (td)
setLastModified

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

setLastModified

Span
(date)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Sets the date/time of the last modification on the file.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} date

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

var f = plugins.file.convertToJSFile('story.txt');
f.createNewFile();
// Make the file look old.
f.setLastModified(new Date(1999, 5, 21));

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setReadOnly

Table Row (tr)

id	name

Table Cell (td)
setReadOnly

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

setReadOnly

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Sets the readonly attribute of the file/directory. Returns true on success.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

var f = plugins.file.convertToJSFile('invoice.txt');
plugins.file.writeTXTFile(f, 'important data that should not be changed');
f.setReadOnly();

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	size

Table Row (tr)

id	name

Table Cell (td)
size

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

size

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the size in bytes of the file. Returns 0 if the file does not exist on disk - works on remote files too.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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.');
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 23

New Version 24

Key

canRead

canWrite

createNewFile

deleteFile

exists

getAbsoluteFile

getAbsolutePath

getBytes

getContentType

getName

getParent

getParentFile

getPath

isAbsolute

isDirectory

isFile

isHidden

lastModified

list

listFiles

mkdir

mkdirs

renameTo

setBytes

setBytes

setLastModified

setReadOnly

size