Integral FTP

Class FTPRenderer

Object
   |
   +--FTPRenderer

class FTPRenderer


An FTPRenderer may be used to produce an HTML representation of an FTPFileList. The main method is renderFileList, which will write the entire list to HTML. If changes are required for particular elements of the list then the FTPRenderer method that corresponds to that element may be overridden. For example, by default names are rendered as <td class='ftpFile ftpName'>fileName</td>, but this may be changed by overriding the renderFileName() method and changing it to write something else.
Defined in ftpclient.js


Field Summary
 Object document
          
 Object showSeconds
          
 
Constructor Summary
FTPRenderer(document)
            Constructs an FTPRenderer object that may be used to write HTML to the given document.
 
Method Summary
 void renderDateFooter()
           Called when rendering the Date column's footer.
 void renderDateHeading()
           Called when writing the heading of the Date column.
 void renderDirectory(<FTPFile> directory)
           Called when rendering a directory.
 void renderDirectoryDate(<Date> directoryDate)
           Called when rendering a directory's date.
 void renderDirectoryName(<string> directoryName, <string> directoryPath)
           Called when rendering a directory-name.
 void renderFile(<FTPFile> file)
           Called when rendering a file.
 void renderFileDate(<Date> fileDate)
           Called when rendering a file-date.
 void renderFileList(<FTPFileList> fileList)
           Writes the given file list to the FTPRenderer's document as a table.
 void renderFileName(fileName, filePath, isTextFile)
           Called when rendering a file-name.
 void renderFileSize(<FTPFileSize> fileSize)
           Called when rendering a file-size.
 void renderNameFooter()
           Called when rendering the Name column's footer.
 void renderNameHeading()
           Called when writing the heading of the Name column.
 void renderSizeFooter()
           Called when rendering the Size column's footer.
 void renderSizeHeading()
           Called when writing the heading of the Size column.

Field Detail

document

Object document

showSeconds

Object showSeconds

Constructor Detail

FTPRenderer

FTPRenderer(document)

Method Detail

renderDateFooter

void renderDateFooter()

renderDateHeading

void renderDateHeading()

renderDirectory

void renderDirectory(<FTPFile> directory)

renderDirectoryDate

void renderDirectoryDate(<Date> directoryDate)

renderDirectoryName

void renderDirectoryName(<string> directoryName, <string> directoryPath)

renderFile

void renderFile(<FTPFile> file)

renderFileDate

void renderFileDate(<Date> fileDate)

renderFileList

void renderFileList(<FTPFileList> fileList)

renderFileName

void renderFileName(fileName, filePath, isTextFile)

renderFileSize

void renderFileSize(<FTPFileSize> fileSize)

renderNameFooter

void renderNameFooter()

renderNameHeading

void renderNameHeading()

renderSizeFooter

void renderSizeFooter()

renderSizeHeading

void renderSizeHeading()

Integral FTP

Documentation generated by JSDoc on Tue Jan 24 10:46:49 2012