<td class='ftpFile ftpName'>fileName</td>, but this may be changed
* by overriding the {@link #renderFileName} method and changing it to write something
* else.
* @constructor
* @type FTPRenderer
*/
function FTPRenderer(document)
{
this.document = document;
this.showSeconds = true;
}
FTPRenderer.prototype.renderFileList = FTPRenderer_renderFileList;
FTPRenderer.prototype.renderNameHeading = FTPRenderer_renderNameHeading;
FTPRenderer.prototype.renderSizeHeading = FTPRenderer_renderSizeHeading;
FTPRenderer.prototype.renderDateHeading = FTPRenderer_renderDateHeading;
FTPRenderer.prototype.renderFile = FTPRenderer_renderFile;
FTPRenderer.prototype.renderFileName = FTPRenderer_renderFileName;
FTPRenderer.prototype.renderFileSize = FTPRenderer_renderFileSize;
FTPRenderer.prototype.renderFileDate = FTPRenderer_renderFileDate;
FTPRenderer.prototype.renderDirectory = FTPRenderer_renderDirectory;
FTPRenderer.prototype.renderDirectoryName = FTPRenderer_renderDirectoryName;
FTPRenderer.prototype.renderDirectoryDate = FTPRenderer_renderDirectoryDate;
FTPRenderer.prototype.renderNameFooter = FTPRenderer_renderNameFooter;
FTPRenderer.prototype.renderSizeFooter = FTPRenderer_renderSizeFooter;
FTPRenderer.prototype.renderDateFooter = FTPRenderer_renderDateFooter;
/**
* Writes the given file list to the FTPRenderer's document as a table.
* The table will have the CSS style ftpList
* @param {FTPFileList} fileList File-list to be renderered
* @see FTPFileList
*/
function FTPRenderer_renderFileList(fileList)
{
this.document.writeln("");
this.document.write("");
this.document.writeln("
");
for (var i=0; i");
this.renderNameFooter();
this.document.writeln("");
this.document.writeln("
");
}
/**
* Called when writing the heading of the Name column.
* The cell will have the CSS styles ftpHead ftpNameHead.
*/
function FTPRenderer_renderNameHeading()
{
this.document.write("Name | ");
}
/**
* Called when writing the heading of the Size column.
* The cell will have the CSS styles ftpHead ftpSizeHead.
*/
function FTPRenderer_renderSizeHeading()
{
this.document.write("Size | ");
}
/**
* Called when writing the heading of the Date column.
* The cell will have the CSS styles ftpHead ftpDateHead.
*/
function FTPRenderer_renderDateHeading()
{
this.document.write("Date | ");
}
/**
* Called when rendering a file.
* This method calls {@link #renderFileName}, {@link #renderFileSize}
* and {@link #renderFileDate}.
* @param {FTPFile} file File to render.
*/
function FTPRenderer_renderFile(file)
{
this.document.writeln("");
this.renderFileName(file.name, file.path, file.isTextFile);
this.document.writeln("
");
}
/**
* Called when rendering a file-name.
* @param {FTPFile} file File to render.
*/
function FTPRenderer_renderFileName(fileName, filePath, isTextFile)
{
this.document.writeln("" + fileName + " | ");
}
/**
* Called when rendering a file-size.
* @param {FTPFileSize} fileSize File-size to render.
*/
function FTPRenderer_renderFileSize(fileSize)
{
this.document.writeln("" + fileSize.numberString + " | ");
this.document.writeln("" + fileSize.units + " | ");
}
/**
* Called when rendering a file-date.
* @param {Date} fileDate Date to render.
*/
function FTPRenderer_renderFileDate(fileDate)
{
this.document.write("" + fileDate.toFTPString(this.showSeconds) + " | ");
}
/**
* Called when rendering a directory.
* @param {FTPFile} directory Directory to render.
*/
function FTPRenderer_renderDirectory(directory)
{
this.document.writeln("");
this.renderDirectoryName(directory.name, directory.path);
this.document.writeln("
");
}
/**
* Called when rendering a directory-name.
* @param {string} directoryName Name of the directory.
* @param {string} directoryPath Path of the directory.
*/
function FTPRenderer_renderDirectoryName(directoryName, directoryPath)
{
this.document.writeln("" + directoryName + " | ");
}
/**
* Called when rendering a directory's date.
* @param {Date} directoryDate Date of the directory.
*/
function FTPRenderer_renderDirectoryDate(directoryDate)
{
this.document.write("");
if (directoryDate!==null) {
this.document.write(directoryDate.toFTPString(this.showSeconds));
}
this.document.writeln(" | ");
}
/**
* Called when rendering the Name column's footer.
*/
function FTPRenderer_renderNameFooter()
{
this.document.write("");
}
/**
* Called when rendering the Size column's footer.
*/
function FTPRenderer_renderSizeFooter()
{
this.document.write("");
}
/**
* Called when rendering the Date column's footer.
*/
function FTPRenderer_renderDateFooter()
{
this.document.write("");
}
// FTPFile ================================================================================
/**
* Constructs an FTPFile object.
* @class FTPFile contains the information describing the attributes of a
* particular file, namely its path, name, size, last-modified date,
* whether or not it's a directory and whether or not it's likely to be
* a text-file.
* @param {string} filePath Full path of the file.
* @param {string} fileName Name of the file.
* @param {FTPFileSize} size Size of the file.
* @param {Date} modifiedDate Date when the file was last modified.
* @param {boolean} isDirectory True if the object represents a directory.
* @param {boolean} isTextFile True if the file is likely to be a text-file.
* @constructor
*/
function FTPFile(filePath, fileName, size, modifiedDate, isDirectory, isTextFile)
{
/**
* Full path of the file.
* @type string
*/
this.path = filePath!==null ? (""+filePath) : null; // convert from Java to JS
/**
* Name of the file.
* @type string
*/
this.name = fileName!==null ? (""+fileName) : null; // convert from Java to JS
/**
* Size of the file.
* @type FTPFileSize
*/
this.size = size;
/**
* Date when the file was last modified.
* @type Date
*/
this.modifiedDate = modifiedDate;
/**
* True if the object represents a directory.
* @type boolean
*/
this.isDirectory = (isDirectory===true);
/**
* True if the file is likely to be a text-file.
* @type boolean
*/
this.isTextFile = isTextFile;
}
// FTPEndPoint ===========================================================================
/**
* @ignore
*/
function FTPEndPoint(text) {
text = text.trim();
if (text.length===0) {
throw "No server address supplied.";
}
var invalidMessage = "Invalid server address: must be of the form 'address[:port]'";
var tokens = text.split(':');
if (tokens.length>2) {
throw invalidMessage;
}
var port = tokens.length>1 ? parseInt(tokens[1]): null;
/**
* @ignore
*/
this.hostName = tokens[0];
/**
* @ignore
*/
this.portNumber = port!==NaN ? port : null;
}
// FTPFileList ===========================================================================
/**
* Constructs a file-list object.
* @class An instance of this class represents a collection of files - usually
* those in a particular directory. It's important to note that FTPFileList
* is not itself an array - the member {@link #files} is an array of {@link FTPFile}s.
* @constructor
*/
function FTPFileList()
{
/**
* An array of files.
* @type FTPFile
*/
this.files = [];
/**
* Add a file to the end of the {@link #files} array.
* @param {string} filePath Full path of the file.
* @param {string} fileName Name of the file.
* @param {FTPFileSize} size Size of the file.
* @param {Date} modifiedDate Date when the file was last modified.
* @param {boolean} isDirectory True if the object represents a directory.
* @param {boolean} isTextFile True if the file is likely to be a text-file.
*/
this.add = function(path, name, size, date, isDirectory, isTextFile) {
var file = new FTPFile(path, name, size, date, isDirectory, isTextFile);
this.files.push(file);
};
/**
* Inserts a file at the given index of the {@link #files} array.
* @param {int} index Index at which to insert the file.
* @param {string} filePath Full path of the file.
* @param {string} fileName Name of the file.
* @param {FTPFileSize} size Size of the file.
* @param {Date} modifiedDate Date when the file was last modified.
* @param {boolean} isDirectory True if the object represents a directory.
* @param {boolean} isTextFile True if the file is likely to be a text-file.
*/
this.insert = function(index, path, name, size, date, isDirectory, isTextFile) {
var file = new FTPFile(path, name, size, date, isDirectory, isTextFile);
this.files.splice(0, 0, file);
};
/**
* Returns true of a file with the give path is in the list.
* @param {string} path Path to search for.
* @return True if the list contains a file with the given path.
* @type boolean
*/
this.containsFilePath = function(path) {
for (file in this.files) {
if (this.files[i].path==path) {
return true;
}
}
return false;
};
/**
* Returns true of a file with the give name is in the list.
* @param {string} name Name to search for.
* @return True if the list contains a file with the given name.
* @type boolean
*/
this.containsFileName = function(name) {
return this.findByFileName(name)!==null;
};
/**
* Returns the file with the give name or null if there isn't one in the list.
* @param {string} name Name to search for.
* @return The file or null.
* @type FTPFile
*/
this.findByFileName = function(name) {
for (i in this.files) {
if (this.files[i].name==name) {
return this.files[i];
}
}
return null;
};
}
// FTPTagItem ---------------------------------------------------------------------
/**
* @ignore
*/
function FTPTagItem(taskID, tag) {
this.taskID = taskID;
this.tag = tag;
}
// String methods -----------------------------------------------------------------
/**
* @ignore
*/
String.prototype.trim = function() {
return this.replace(/^\s+|\s+$/, '');
};
/**
* @ignore
*/
String.prototype.startsWith = function(sub) {
return sub!==null && this.substring(0, sub.length)===sub;
};
// Date methods -----------------------------------------------------------------
/**
* @ignore
*/
Date.prototype.toFTPString = function(showSeconds) {
var dateString = this.getFullYear() +
"-" + this._pad(this.getMonth()+1, "0", 2, true) +
"-" + this._pad(this.getDate(), "0", 2, true) +
" " + this._pad(this.getHours(), "0", 2, true) +
":" + this._pad(this.getMinutes(), "0", 2, true);
if (showSeconds) {
dateString = dateString + ":" + this._pad(this.getSeconds(), "0", 2, true);
}
return dateString;
};
Date.prototype.setFromJavaDateString = function(javaDateString) {
this.setTime(Date.parse(javaDateString));
};
Date.prototype.setFromJavaDate = function(javaDate) {
this.setFromJavaDateString(javaDate.toGMTString());
};
/**
* @ignore
*/
Date.prototype._pad = function(obj, padChar, width, padLeft) {
var text = (""+obj);
for (var i=text.length; i