Page History

Hidden

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE

HTML Table

class	servoy sSummery

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summery

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSFile

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
byte[]

Table Cell (td)
#getBytes()

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSFile

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#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() Returns true if the file is a file and not a regular file - works on remote files too.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Date

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String[]

Table Cell (td)
#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.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSFile[]

Table Cell (td)
#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 Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#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
class	node

Table Row (tr)

id	name

Table Cell (td)
canRead

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

canRead

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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
class	node

Table Row (tr)

id	name

Table Cell (td)
canWrite

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

canWrite

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

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

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
createNewFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

createNewFile

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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
class	node

Table Row (tr)

id	name

Table Cell (td)
deleteFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

deleteFile

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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
class	node

Table Row (tr)

id	name

Table Cell (td)
exists

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

exists

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

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

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getAbsoluteFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSFile

Span

style	float: left; font-weight: bold;
id	iets

getAbsoluteFile

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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.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
class	node

Table Row (tr)

id	name

Table Cell (td)
getAbsolutePath

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String

Span

style	float: left; font-weight: bold;
id	iets

getAbsolutePath

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getBytes

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

byte[]

Span

style	float: left; font-weight: bold;
id	iets

getBytes

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Replace with description

Table Row (tr)

id	ret

Table Cell (td)
Returns byte[]

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getContentType
class	node

Table Row (tr)

id	name

Table Cell (td)
getContentType

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String

Span

style	float: left; font-weight: bold;
id	iets

getContentType

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String

Span

style	float: left; font-weight: bold;
id	iets

getName

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getParent

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String

Span

style	float: left; font-weight: bold;
id	iets

getParent

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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.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
class	node

Table Row (tr)

id	name

Table Cell (td)
getParentFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSFile

Span

style	float: left; font-weight: bold;
id	iets

getParentFile

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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.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
class	node

Table Row (tr)

id	name

Table Cell (td)
getPath

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String

Span

style	float: left; font-weight: bold;
id	iets

getPath

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

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

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
isAbsolute

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

isAbsolute

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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
class	node

Table Row (tr)

id	name

Table Cell (td)
isDirectory

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

isDirectory

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

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

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
isFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

isFile

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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
class	node

Table Row (tr)

id	name

Table Cell (td)
isHidden

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

isHidden

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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
class	node

Table Row (tr)

id	name

Table Cell (td)
lastModified

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Date

Span

style	float: left; font-weight: bold;
id	iets

lastModified

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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
class	node

Table Row (tr)

id	name

Table Cell (td)
list

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String[]

Span

style	float: left; font-weight: bold;
id	iets

list

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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
class	node

Table Row (tr)

id	name

Table Cell (td)
listFiles

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSFile[]

Span

style	float: left; font-weight: bold;
id	iets

listFiles

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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
class	node

Table Row (tr)

id	name

Table Cell (td)
mkdir

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

mkdir

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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
class	node

Table Row (tr)

id	name

Table Cell (td)
mkdirs

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

mkdirs

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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
class	node

Table Row (tr)

id	name

Table Cell (td)
renameTo

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

renameTo

Span

style	float: left;
id	iets

(destination)

Table Row (tr)

id	des

Table Cell (td)
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 destination

Table Row (tr)

id	ret

Table Cell (td)
Returns 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	setLastModified
class	node

Table Row (tr)

id	name

Table Cell (td)
setLastModified

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

setLastModified

Span

style	float: left;
id	iets

(date)

Table Row (tr)

id	des

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

Table Row (tr)

id	prs

Table Cell (td)
Parameters date

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
setReadOnly

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

setReadOnly

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Sets the readonly attribute of the file/directory. Returns true on success.

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
size

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

size

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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 14

New Version Current

Key

canRead

canWrite

createNewFile

deleteFile

exists

getAbsoluteFile

getAbsolutePath

getBytes

getContentType

getName

getParent

getParentFile

getPath

isAbsolute

isDirectory

isFile

isHidden

lastModified

list

listFiles

mkdir

mkdirs

renameTo

setLastModified

setReadOnly

size