Page History

Divcache

Div

id	description

HTML Table

id

class

servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)canRead()

styleindex	display:none

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.

true
refresh	100d
showRefresh	true
id	doc
title	Refresh page
showDate	true
retry	Enable

id

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Methods SummaryReturns true if the file exists and is readable (has access to it) - works on remote files too. 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 Row (tr)

Table Cell (td)
Boolean

Table Cell (td)createNewFile()

Creates the file on disk if needed.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)deleteFile()
Deletes the file from the

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)exists()

Deletes the file from the disk if possible.

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

Table Row (tr)

Table Cell (td)
JSFile

Table Cell (td)getAbsoluteFile()

Table Row (tr)

Table Cell (td)
String

Table Cell (td)getAbsolutePath()

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

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

Table Row (tr)

Table Cell (td)
byte[]

Table Cell (td)getBytes()

Table Row (tr)

Table Cell (td)
String

Table Cell (td)getContentType()

Gets the contents (bytes) for the file data.

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()
Returns the

Table Row (tr)

Table Cell (td)
String

Table Cell (td)getParent()

Returns the name of the file.

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

Table Row (tr)

Table Cell (td)
JSFile

Table Cell (td)getParentFile()

Table Row (tr)

Table Cell (td)
String

Table Cell (td)getPath()

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

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

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)isAbsolute()

Table Cell (td)
Boolean

Table Cell (td)isDirectory()

Returns true if the path is absolute.

Table Row (tr)

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

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)isFile()
Returns true if

Table Cell (td)
Boolean

Table Cell (td)isHidden()

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

Table Row (tr)

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

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

Table Row (tr)

Table Cell (td)
String[]

Table Cell (td)list()

Table Cell (td)listFiles()

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)

Table Cell (td)
JSFile[]

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

Creates a directory on disk if possible.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)mkdirs()
Creates

renameTo(destination)

Creates a directory on disk, together with all its parent directories, if possible.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)

Renames the file to a different name.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)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(bytes, createFile)

Table Cell (td)setLastModified(date)

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

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)setReadOnly()
Sets the readonly attribute of the

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

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)size()

Sets the readonly attribute of the file/directory.

Table Row (tr)

Table Cell (td)
Number

Returns the size in bytes of the file.

HTML Table

functionclass Colgroup Tag Colcolspanservoy sDetail2width100%

Col

Table Head (thead) Table Row (tr)style

height:30px

;

Table Head (th)

colspan	2

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)

2

Methods Details

canRead

name

canRead()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

canWrite

name

canWrite()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

createNewFile

name

createNewFile()

des

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

deleteFile

name

deleteFile()

des

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

exists

name

exists()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getAbsoluteFile

name

getAbsoluteFile()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getAbsolutePath

name

getAbsolutePath()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getBytes

name

getBytes()

des

sIndent

Gets the contents (bytes) for the file data.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getContentType

name

getContentType()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getName

name

getName()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getParent

name

getParent()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getParentFile

name

getParentFile()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getPath

name

getPath()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

isAbsolute

name

isAbsolute()

des

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

isDirectory

name

isDirectory()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

isFile

name

isFile()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

isHidden

name

isHidden()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

lastModified

name

lastModified()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

list

name

list()

des

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

listFiles

name

listFiles()

des

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

mkdir

name

mkdir()

des

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

mkdirs

name

mkdirs()

des

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

renameTo

name

renameTo(destination)

des

sIndent

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

prs

Parameters

sIndent

destination

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setBytes

name

setBytes(bytes)

des

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

prs

Parameters

sIndent

bytes

the data

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setBytes

name

setBytes(bytes, createFile)

des

sIndent

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

prs

Parameters

sIndent

bytes

the data

createFile

true to create a file if it doesn't exist

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setLastModified

name

setLastModified(date)

des

sIndent

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

prs

Parameters

sIndent

date

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setReadOnly

name

setReadOnly()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

size

name

size()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

Child pages

Page History

Versions Compared

Old Version 27

New Version 28

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

canRead()

canWrite()

createNewFile()

deleteFile()

exists()

getAbsoluteFile()

getAbsolutePath()

getBytes()

getContentType()

getName()

getParent()

getParentFile()

getPath()

isAbsolute()

isDirectory()

isFile()

isHidden()

lastModified()

list()

listFiles()

mkdir()

mkdirs()

renameTo(destination)

setBytes(bytes)

setBytes(bytes, createFile)

setLastModified(date)

setReadOnly()

size()