UploadAgent

From Documentation

WarningTriangle-32x32.png This page is under construction, so we cannot guarantee the accuracy of the content!


Since 1.1.0

ZATS Mimic introduces the UploadAgent to simulate file uploading operation with consistent usage. UploadAgent supports single or multiple file uploading like ZK components. Following are the implementation steps:

  1. Obtain a UploadAgent instance according to your case. Note that you should use the same instances in one uploading iteration.
  2. Upload a file by invoking upload() method.
  3. Invoke finish()method when the uploading is done.

Uploading Files

The basic way to upload files is using a component such as Fileupload, Button, Menuitem, Toolbarbutton and so on.[1] If we assign the upload attribute to these components, users can click and select a file to upload through the browser dialog, as illustrated below:

To set up an uploading feature, you can simply use the Fileupload component. Alternatively, you can choose to use any button components such as Button, Menuitem, Toolbarbutton etc. and simply assign the upload attribute to these components; users can then click and select a file to upload through a browser dialog, as illustrated below:

Zats upload button.png

Notes

Upload A Single File

We can cast these components described above as UploadAgent and perform file uploading. Following is a typical example of single file uploading:

@Test
public void test() throws Exception {
	File file = getFile();
	DesktopAgent desktop = Zats.newClient().connect("/upload.zul");
	UploadAgent agent = desktop.query("#btn").as(UploadAgent.class);
	agent.upload(file, "text/plain");
	agent.finish();
}
  • Line 14: Cast component to UploadAgent and keep its reference.
  • Line 15: Invoke upload() method to upload a file.
  • Line 16: Don't forget to invoke finish()method.

Upload Multiple Files

Since ZK 6.0.0, the components allowed uploading file support uploading multiple files at once if they have multiple=true flag and users use the web browsers supported HTML5.[1] UploadAgent also supports multiple files uploading at once. Following is a typical example of multiple files uploading:

@Test
public void test() throws Exception {
	File[] files = getFiles();
	DesktopAgent desktop = Zats.newClient().connect("/upload.zul");
	UploadAgent agent = desktop.query("#btn").as(UploadAgent.class);
	agent.upload(files[0], "text/plain");
	agent.upload(files[1], "image/png");
	agent.finish();
}
  • Line 14: Cast component to UploadAgent and keep its reference.
  • Line 15-16: We can upload multiple files at once when ZK version is greater than 6.0.0 and the component has multiple=true flag.
  • Line 17: Don't forget to invoke finish()method.


Notes

Upload Files with Fileupload.get()

Another way to upload files is to invoke the static method Fileupload.get().[1] This static method will open a uploading dialog and allow users to upload single or multiple files (if configured), as following image shows.

Zats upload dialog.png

In this kind of case, we can retrieve UploadAgent from casting DesktopAgent. Following is a typical example of file uploading with Fileupload.get():

@Test
public void test() throws Exception {
	File[] files = getFiles();
	DesktopAgent desktop = Zats.newClient().connect("/upload.zul");
	desktop.query("#label2").click();
	UploadAgent agent = desktop.as(UploadAgent.class);
	agent.upload(files[0], "text/plain");
	agent.upload(files[1], "image/png");
	agent.finish();
}
  • Line 14-15: After triggering an event led to upload operation, we can cast DesktopAgent as a UploadAgent for uploading.
  • Line 16-17: We can upload multiple files at once when using Fileupload.get().
  • Line 18: Don't forget to invoke finish()method.

Notes

Supported Components

Components
Version
Note
DesktopAgent 5, 6
Fileupload 5, 6
Button 5, 6
Menuitem 5, 6
Toolbarbutton 5, 6




Last Update : 2012/07/02

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.