|
Parameters - MyFTPUploader
|
Below you will find a list of parameters. With these parameters MyFTPUploader can be configured. Put the parameters
in the HTML (upload) page inside the applet tag.
|
|
| description: |
This parameter needs to be used with parameter 'transferType'. If 'transferType'
is 'automatic' than the files will be uploaded as ascii, if the file extension
is defined in this parameter. Files needs to be uploaded as ascii if the file is a plain text file. |
| since: |
version 1.1 |
| format: |
file extensions (comma separated) |
| default: |
no default |
| example: |
txt, html, htm, xml |
| tag example: |
<param name="asciiFileExtensions" value="txt, html, htm, xml"> |
|
| description: |
Set this param to true if the login dialog doesn't need to appear and MyFTPUploader will login in automatically. This will only work in combination with the params host, passsword
and userName. It is recommended to encrypt the login credentials.
See for more information: http://www.jaavatwork.com/ftp-java-upload-applet/encrypt.html
|
| format: |
true or false |
| default: |
true |
| example: |
true |
| tag example: |
<param name="automaticLogin" value="false"> |
|
| description: |
Defines the applet's background color. The color must be given in hexidecimal format. |
| format: |
hexidecimal |
| default: |
#ffffff (white) |
| example: |
#ffffff |
| tag example: |
<param name="backgroundColor" value="#ffffff"> |
|
| description: |
Defines the charset. This parameter is necessary if non ISO-8859-1 characters are uploaded |
| since: |
version 1.5 |
| format: |
String |
| default: |
ISO-8859-1 |
| example: |
UTF-8 |
| tag example: |
<param name="charset" value="UTF-8"> |
|
| description: |
Defines the compression quality for a jpeg image in case the image has been resized. For resizing an image see the parameter maxImageSize. The compressionQuality can have a value between 0 and 100. |
| since: |
version 1.2 |
| format: |
integer between 0 and 100 |
| default: |
75 |
| example: |
100 |
| tag example: |
<param name="compressionQuality" value="100"> |
|
| description: |
Shows the ftp commands in the Java console. |
| format: |
true or false |
| default: |
true |
| example: |
false |
| tag example: |
<param name="debug" value="false"> |
|
| description: |
When you cancel an upload the files which already have been uploaded are stored on the server. With this parameter the files will be deleted if the user has sufficient rights (rollback). |
| format: |
true or false |
| default: |
false |
| example: |
true |
| tag example: |
<param name="deleteOnCancel" value="true"> |
|
| description: |
The FileDialog contains FileFilters. FileFilters are components for filtering particular files e.g. *.pdf's.
The FileDialog contains by default a DefaultFileFilter (*.*). This FileFilter shows all files in the FileDialog. For
disabling this FileFilter use this param tag. |
| format: |
true or false |
| default: |
false |
| example: |
true |
| tag example: |
<param name="disableDefaultFileFilter" value="true"> |
|
| description: |
The FileDialog contains FileFilters. FileFilters are components for filtering particular files e.g. *.pdf's. With this param you can
create your own FileFilter. |
| format: |
description + semicolon + extensions (comma separated) |
| default: |
no default |
| example: |
Image files (*.jpg, *.jpeg, *.png, *.gif): jpg, jpeg, png, gif |
| tag example: |
<param name="fileFilter" value="Image files (*.jpg, *.jpeg, *.png, *.gif): jpg, jpeg, png, gif"> |
|
| description: |
The domain name or ip-address of the FTP server. When used the host will be prefilled in the login dialog. |
| format: |
domain name or ip-address |
| default: |
no default |
| example: |
ftp.mycompany.com |
| tag example: |
<param name="host" value="ftp.mycompany.com"> |
|
| description: |
Adds an icon to the add button. |
| format: |
An absolute or relative URL. |
| default: |
no default |
| example: |
http://www.mycompany.com/images/add.gif |
| tag example: |
<param name="iconAdd" value="http://www.mycompany.com/images/add.gif"> |
|
| description: |
Adds an icon to the remove button. |
| format: |
An absolute or relative URL. |
| default: |
no default |
| example: |
http://www.mycompany.com/images/remove.gif |
| tag example: |
<param name="iconRemove" value="http://www.mycompany.com/images/remove.gif"> |
|
| description: |
Adds an icon to the upload button. |
| format: |
An absolute or relative URL. |
| default: |
no default |
| example: |
http://www.mycompany.com/images/upload.gif |
| tag example: |
<param name="iconUpload" value="http://www.mycompany.com/images/upload.gif"> |
|
| description: |
Defines the resize algorithm. Possible values are:
1 awt (default, more sharp than 3 and more smooth than 5, requires low memory, slow)
2 one-step bilinear (poor quality, requires more memory than 1, very fast)
3 multiple-step bilinear (smooth images, requires more memory than 1, 2 and 4)
4 one step bicubic (poor quality, requires more memory than 1, very fast)
5 multiple-step bicubic (sharp images, requires more memory than 1, 2 and 4)
|
| since: |
version 1.4 |
| format: |
integer |
| default: |
1 |
| example: |
1 |
| tag example: |
<param name="imageInterpolation" value="1"> |
|
| description: |
Key for encrypting and decrypting the login credentials. See for more information: http://www.jaavatwork.com/ftp-java-upload-applet/encrypt.html |
| since: |
version 1.2 |
| format: |
Base64 encoded. |
| default: |
no default |
| example: |
nlTZjwX004i60gFWx54BwC== |
| tag example: |
<param name="key" value="nlTZjwX004i60gFWx54BwC=="> |
|
| description: |
MyFTPUploader is available in Danish(da), Dutch(nl), English(en), Italian(it), French(fr), German(de), Norwegian(no), Portugues(pt), Spanish(es) and Swedish(sv). If this parameter is not used the language of the operating system will be used. If this language is not available then English will be used. |
| format: |
da, de, en, it, fr, nl, no, pt, es, sv |
| default: |
en |
| example: |
de |
| tag example: |
<param name="language" value="de"> |
|
| description: |
Defines the look and feel. Possible values are '1' (default Java Metal look and feel) and '2' (Windows look and feel).
|
| since: |
version 1.4 |
| format: |
1 or 2 |
| default: |
1 |
| example: |
2 |
| tag example: |
<param name="lookAndFeel" value="2"> |
|
| description: |
Defines the maximum number of files that can be uploaded in one request. |
| format: |
integer |
| default: |
free edition: 3, standard edition: unlimited |
| example: |
10 |
| tag example: |
<param name="maxFileSize" value="10"> |
|
| description: |
Defines the maximum number of bytes (MB) that can be uploaded in one request. |
| format: |
integer |
| default: |
free edition: 3, standard edition: unlimited |
| example: |
10 |
| tag example: |
<param name="maxByteSize" value="10"> |
|
| description: |
Defines the maximum height of a resized image. See also the parameters maxImageWidth and maxImageSize. |
| since: |
version 1.4 |
| format: |
integer |
| default: |
no default |
| example: |
500 |
| tag example: |
<param name="maxImageHeight" value="500"> |
|
| description: |
Resizes an image (jpeg and png) to the maxImageSize. If an original image has the size 1000 X 600 and the value of maxImageSize is 500 than the image will be scaled down to 500 x 300. See also the parameter compressionQuality.
The parameter maxImageSize is a shorthand for maxImageHeight and maxImageWidth, for example maxImageSize="100" is the same as maxImageHeight="100" and maxImageWidth="100", See also the parameters maxImageHeight and maxImageWidth.
|
| since: |
version 1.2 |
| format: |
integer |
| default: |
no default |
| example: |
500 |
| tag example: |
<param name="maxImageSize" value="500"> |
|
| description: |
Defines the maximum width of a resized image. See also the parameters maxImageHeight and maxImageSize. |
| since: |
version 1.4 |
| format: |
integer |
| default: |
no default |
| example: |
500 |
| tag example: |
<param name="maxImageWidth" value="500"> |
|
| description: |
Checks if the file already exists on the server. The value 'overwrite' will overwrite the file, the value 'makeUnique' creates an unique name (a number will be appended to file name). |
| since: |
version 1.2 |
| format: |
overwrite or makeUnique |
| default: |
overwrite |
| example: |
makeUnique |
| tag example: |
<param name="nameConflict" value="makeUnique"> |
|
| description: |
Part of the login credentials. |
| format: |
String |
| default: |
no default |
| example: |
my_password |
| tag example: |
<param name="password" value="my_password"> |
|
| description: |
The port of the FTP Server. |
| format: |
integer |
| default: |
21 |
| example: |
900 |
| tag example: |
<param name="port" value="900"> |
|
| description: |
Reject files with a specific file extension. |
| format: |
extension + comma + extension + et cetera |
| default: |
no default |
| example: |
exe, bat |
| tag example: |
<param name="rejectFileFilter" value="exe, bat"> |
|
| description: |
Defines the connection type to the FTP server. Possible values are ftp (unsecure) and ftps (secure: ftp over explicit ssl). |
| format: |
ftp or ftps |
| default: |
ftp |
| example: |
ftp |
| tag example: |
<param name="serverType" value="ftps"> |
|
| description: |
Shows the hidden files in the filedialog. |
| since: |
version 1.5 |
| format: |
true or false |
| default: |
false |
| example: |
true |
| tag example: |
<param name="showHiddenFilesInFileDialog" value="true"> |
|
| description: |
Shows thumbnails of images in the main window. |
| since: |
version 1.2 |
| format: |
true or false |
| default: |
false |
| example: |
true |
| tag example: |
<param name="showThumbNailsInApplet" value="true"> |
|
| description: |
Shows thumbnails of images in the file dialog. |
| since: |
version 1.2 |
| format: |
true or false |
| default: |
false |
| example: |
true |
| tag example: |
<param name="showThumbNailsInFileDialog" value="true"> |
|
| description: |
Shows a tooltip when the mouse is over a file name. |
| since: |
version 1.2 |
| format: |
true or false |
| default: |
true |
| example: |
false |
| tag example: |
<param name="showToolTip" value="false"> |
|
| description: |
After a successful upload a dialog will be displayed as default with the message 'upload completed'. When you use successURL the user
will be redirected to a success page. |
| format: |
An absolute or relative URL |
| default: |
no default |
| example: |
http://www.mycompany.com/upload/successpage.html |
| tag example: |
<param name="successURL" value="http://www.mycompany.com/upload/successpage.html"> |
|
| description: |
As default you can change in the applet the transfer type (ascii or
binary). When you use this parameter this option will be removed.
The possible values are 'ascii', 'binary' or 'automatic'. If the
value is 'ascii' all files will be uploaded as ascii files. If the
value is 'binary' all files will be uploaded as binary files. If
the value is 'automatic' than it depends on the parameter
'asciiFileExtensions'. This parameter is required if transferType
is 'automatic'. Files will be uploaded as ascii if the file
extension is defined in 'asciiFileExtensions'. |
| since: |
version 1.1 (automatic) |
| format: |
ascii, binary or automatic |
| default: |
no default |
| example: |
ascii |
| tag example: |
<param name="transferType" value="ascii"> |
|
| description: |
Defines the upload directory on the ftp server. |
| format: |
String |
| default: |
no default |
| example: |
myfiles |
| tag example: |
<param name="uploadDirectory" value="myfiles"> |
|
| description: |
Disables the upload of directories. |
| since: |
version 1.2 |
| format: |
true or false |
| default: |
true |
| example: |
false |
| tag example: |
<param name="uploadDirectories" value="false"> |
|
| description: |
Part of the login credentials. When used the username will be prefilled in the login dialog. |
| format: |
String |
| default: |
no default |
| example: |
my_name |
| tag example: |
<param name="userName" value="my_name"> |
|
| description: |
Creates a zip file of the selected files. This zip file will be uploaded. |
| since: |
version 1.2 |
| format: |
name of the zip file |
| default: |
no default |
| example: |
myname.zip |
| tag example: |
<param name="zipFile" value="myname.zip"> |
|
