JavaPowUpload 2.1
Tutorials 		  Home page
Contact support

JavaPowUpload tutorials 

  1. Data types
  2. Include JavaPowUpload applet on a page
  3. Configure JavaPowUpload using parameters
  4. JavaScript communication
  5. Download mode
  6. Upload modes, chunked upload mode
  7. Upload thumbnails
  8. Compress before upload
  9. Control JavaPowUpload using server response
  10. Internationalization of UI
  11. Upload files directly to Amazon S3

 

  1. Data types

    Here is the list of all data types used by JavaPowUpload:

  2. Include JavaPowUpload applet on a page

    <applet 
	code="com.elementit.JavaPowUpload.Manager"
	archive="lib/JavaPowUpload.jar, lib/skinlf.jar,
	lib/commons-httpclient.jar,	
	lib/commons-net-ftp.jar,
	lib/commons-compress.jar"
	width="600"
	height="400"
	name="JavaPowUpload"
	id="JavaPowUpload"
	mayscript="true"
	alt="JavaPowUpload by www.element-it.com">
   
  <!-- Java Plug-In Options -->
  <param name="progressbar" value="true">
  <param name="boxmessage" value="Loading JavaPowUpload Applet ...">
  <!-- JavaPowUpload parameters -->
  <param name="Common.SerialNumber" value="put your serial number here">
  <param name="Common.UploadMode" value="true">
  <param name="Upload.UploadUrl" value="FileProcessingScripts/ASP.NET/CSharp/uploadfiles.aspx">
  <param name="Common.SkinLF.ThemepackURL" value="lib/themepack.zip">
    Your browser does not support applets. Or you have disabled applets in your options.
    To use this applet, please install the newest version of Sun's java.
    You can get it from <a href="http://www.java.com/">java.com</a>
  </applet>

  3. Configure JavaPowUpload using parameters

    Parameters can be specified using 3 ways:

    1. Using <param> tag of the <applet> tag.

      Example:
      <param name="Common.UploadMode" value="true">

    2. Using external xml file, specified with the Common.PropertiesFile parameter in <applet> tag.

      Example       of properties.xml file: 
      	<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
    <properties>
    <entry key="Common.UploadMode">true</entry>
    <entry key="Common.BackgroundColor">#FFFFFF</entry>
    <entry key="Common.UseLiveConnect">true</entry>
    </properties>
    3. Using JavaScript setParam method.

      Example:

      JavaPowUpload.setParam("Upload.UploadUrl","http://localhost/JavaPowUpload/uploadfiles.php");
      The parameters specified using setParam method have the highest priority, specified using <param> tag of the <applet> tag have the lowest priority.
      Note: not all the parameters can be specified using the setParam method.

  4. JavaScript communication

    Here are several steps to start using the JavaPowUpload events and methods:

    To use the JavaPowUpload events, you should declare appropriate JavaScript functions. The function name format is Common.JavaScriptEventsPrefix+eventName. List of all available JavaPowUpload events is available in the events section.

    Example:

    function JavaPowUpload_onDownloadStart()
    {
     alert("Starting download process");
    }

    To use JavaPowUpload methods, you should init JavaPowUpload object.

    Example:
    //init JavaPowUpload JavaScript object
    var JavaPowUpload;
    JavaPowUpload = document.getElementById("JavaPowUpload");
    //where "javaPowUpload" is id attribute of <applet> tag>
    //Now we can use javaPowUpload methods, for example show browse dialog
    JavaPowUpload.clickBrowse();

  5. Download mode

    JavaPowUpload can be used to download files from FTP/HTTP server. Here are the steps to configure the download mode:

  6. Upload modes, chunked upload mode.

    To enable upload mode, set the value of the Common.UploadMode parameter to true (false by default) .
    Set the value of the Upload.UploadUrl parameter:

    If you would like to upload files to the FTP server, set the value of the Upload.UploadUrl parameter as absolute FTP url to destination directory on FTP server. The url should have the following format:
    ftp://username:password@domainname.com/destination/folder/
    You can omit a username and a password, in this case JavaPowUpload firstly will try to login as an anonymous user and if no success, it will ask for credential to a user. If a user has entered valid credentials, JavaPowUpload will store them on user's computer and will not ask for them next time when a user will upload files to the same url.

    If you would like to upload files to the HTTP server, set a value of the Upload.UploadUrl parameter to point to the server side script which will handle file uploads. The Url may be an absolute or relative to the current web page path (where the applet is placed). Actually JavaPowUpload will use codebase attribute of the <applet> tag as a base path for the relative url. If this attribute is not set in the <applet> tag, its value is set as a base path of the current web page.

    By default, JavaPowUpload uploads files by the classic (RFC 1867) method. Here are several disadvantages of this method: The main advantage of the classic method is the usage of the standard upload algorithm, which allows you to use regular scripts to save uploaded files on server side.
    JavaPowUpload provides an alternate upload method - chunked upload mode. When this mode is enabled, JavaPowUpload will send files to a server by small chunks.
    Here are several advantages of this method:
    You should also use a special file processing script on server side to save uploaded chunks in one file. To enable this method, set the value of the Upload.HttpUpload.ChunkedUpload.Enabled parameter to true.
    You can configure the chunk size with the Upload.HttpUpload.ChunkedUpload.ChunkSize parameter. By default, the value of this paraneter is set to -1, in this case JavaPowUpload will automatically select the best value for the chunk size during the upload process. To limit maximum value for the chunk size, when it is controlled by JavaPowUpload, you can use the Upload.HttpUpload.ChunkedUpload.ChunkSize parameter. The value of this parameter should be less than the upload file size limitation on server side. For example, by default, php limit of the upload file size is 2 Mb.

  7. Upload thumbnails

    JavaPowUpload can generate image thumbails on the client side and upload them to a server. Supported image formats are JPEG, PNG, GIF. Here are the steps to configure the thumbnails upload feature:

  8. Compress before upload

    JavaPowUpload can compress files into archive before upload. It may greatly decrease network traffic and upload time for some file types. Supported compression formats are ZIP, JAR, TAR, TAR-GZIP, TAR-BZIP2. Here are the steps to configure the compression before upload feature: Please note: if chunked (http) upload mode enabled, each file chunk will be compressed before upload and it should be properly uncompressed on server side. It allow to save time (taken by compression of whole file before upload) and space on user hard drive (taken by temp archive file).

  9. Control JavaPowUpload using server response.

    Starting from version 2.0.5, JavaPowUpload supports the execution of some commands received from a server in an http response.
    To use this feature, you should write a special xml structure at any place of the response. JavaPowUpload will search for <JavaPowUpload> and </JavaPowUpload> tags in the server response and, if they are found, will try execute a command between these 2 tags.
    Below is the valid xml structure with all commands that are supported in the current version: 
    <JavaPowUpload>
//display message with caption "Warning" message from tag
    <message>Uploaded</message>
    //set value of parameter
    <param name="clearButtonVisible">false</param>
    //display message with specified caption and message
    <function name="showAlert" param1="warning" param2="error message"/>
    //cancell upload
    <callfunction name="cancelUpload"/>
    </JavaPowUpload>
    Here is the description of all available tags (commands):

  10. Internationalization of UI.

    Starting from version 2.0.5, JavaPowUpload provides the feature to detect a user's language automatically and load a necessary file with the translation. This feature can be enabled/disabled using the Common.Language.AutoDetect parameter (false by deafult). If the parameter is set to true, JavaPowUpload will try to detect the user's language using the following JavaScript statement: (navigator.language) ? navigator.language : navigator.userLanguage. When the language is detected, the 2-letter language code will replace <LANGUAGE_CODE> placeholder in the Common.InternationalFile parameter. If the value of Common.InternationalFile parameter does not contain <LANGUAGE_CODE> placeholder, the language detection will not be performed. If the value of the Common.Language.AutoDetect parameter is set to false and the value of the Common.InternationalFile parameter contains <LANGUAGE_CODE> placeholder, the language detection will not be performed and the Common.InternationalFile parameter will be ignored.
    The JavaPowUpload distribution package contains a lot of translation files in the Extra/Languages/ subfolder.
    If you would like to set the translation manually, you should set the value of the Common.Language.AutoDetect parameter to false and remove the <LANGUAGE_CODE> placeholder from the Common.InternationalFile parameter.
    Changing the value of the Common.InternationalFile parameter at runtime using the setParam method will result the reload of the translation file from the new location and the reinitialization of JavaPowUpload.

  11. Upload files directly to amazon S3

    Starting from version 2.1 JavaPowUpload allow upload files directly to Amazon S3 servers.
    To upload files to your own Amazon S3 bucket you need to generate required parameters. Please use amazons3generator.html page from distribtiuon package to generate needed parameters. Open amazons3generator.html page in a browser and follow instructions. Your secret key will not be transferred by wire. All calculations done on your computer using JavaScript.
    When done, open uploadtoamazons3.html page in editor , find <applet tag and put into it parameters (replace existing) generated on amazons3generator.html page.