ZATS Essentials/Mimic Library/Operation/UploadAgent

Since 1.1.0

ZATS Mimic introduces the UploadAgent to simulate file uploading operation and UploadAgent supports single or multiple file uploading. The following are the usage steps:

1. Obtain a UploadAgent object.

   Depending on your case, you could get it from a Button or from desktop. Note that you should use the same object before calling finish().

2. Upload a file by invoking upload() method.
3. Invoke finish() when there is no more file to upload.

Uploading Files for Components with upload attribute

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

Notes

Upload a Single File

We can cast these components described above as UploadAgent and perform file uploading. Following is a typical example of a 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.

Uploading Multiple Files

Since ZK 6.0.0, components now also support mutiple uploads at once if they have multiple=true flag and users using web browsers supporting HTML5. UploadAgent also supports multiple files uploading at once. Following is a typical example of uploading multiple files:

@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 with ZK version greater than 6.0.0 and components that have multiple=true flag.
• Line 17: Don't forget to invoke finish()method.

Notes

Uploading Files with Fileupload.get()

Another way to implement upload feature is to use the static method Fileupload.get() as an event handler. This static method will open up an uploading dialog and allow users to upload single or multiple files (if configured), as shown in the image below:

			<label id="label1" value="click label1 will invoke fileupload.get()" onClick="Fileupload.get();" />
			<label id="label2" value="click label2 will invoke fileupload.get(3)" onClick="Fileupload.get(3);" />

In this case, we can retrieve UploadAgent from 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 leading to an uploading operation, we can cast DesktopAgent as a UploadAgent for uploading.
• Line 16-17: We can also upload multiple files at once 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, Menuitem, Toolbarbutton	5, 6