ZATS UploadAgent"

From Documentation
Line 5: Line 5:
  
 
ZATS Mimic introduces the <tt>UploadAgent</tt> to simulate file uploading operation with consistent usage. <tt>UploadAgent</tt> supports single or multiple files uploading as ZK components do. Following is typical steps:
 
ZATS Mimic introduces the <tt>UploadAgent</tt> to simulate file uploading operation with consistent usage. <tt>UploadAgent</tt> supports single or multiple files uploading as ZK components do. Following is typical steps:
# Obtain a <tt>UploadAgent</tt> according to your case. Notice that you should use the same instance in one uploading iteration.
+
# Obtain a <tt>UploadAgent</tt> instance according to your case. Notice that you should use the same instance in one uploading iteration.
 
# Upload a file. While uploading multiple files, repeat step 2.
 
# Upload a file. While uploading multiple files, repeat step 2.
 
# Invoke <tt>finish()</tt>method when the uploading is done.
 
# Invoke <tt>finish()</tt>method when the uploading is done.
Line 49: Line 49:
 
<tt>UploadAgent</tt> also support this kind of case. However, the static method was invoked according to event occurred. Therefore, we can cast <javadoc>org.zkoss.zk.ui.DesktopAgent</javadoc> as a <tt>UploadAgent</tt>. Following is a typical example of file uploading with the static method:
 
<tt>UploadAgent</tt> also support this kind of case. However, the static method was invoked according to event occurred. Therefore, we can cast <javadoc>org.zkoss.zk.ui.DesktopAgent</javadoc> as a <tt>UploadAgent</tt>. Following is a typical example of file uploading with the static method:
  
<source lang="java" start="10" high="13, 14, 15, 19, 20, 21">
+
<source lang="java" start="10" high="13, 14, 15, 16, 19, 20">
 
@Test
 
@Test
 
public void test(File[] files) throws Exception {
 
public void test(File[] files) throws Exception {

Revision as of 10:06, 29 June 2012

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

aowang



Since 1.1.0

ZATS Mimic introduces the UploadAgent to simulate file uploading operation with consistent usage. UploadAgent supports single or multiple files uploading as ZK components do. Following is typical steps:

  1. Obtain a UploadAgent instance according to your case. Notice that you should use the same instance in one uploading iteration.
  2. Upload a file. While uploading multiple files, repeat step 2.
  3. Invoke finish()method when the uploading is done.

Upload File with a Component

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 following image shows: Zats upload button.png


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

@Test
public void test(File file) throws Exception {
	DesktopAgent desktop = Zats.newClient().connect("/upload.zul");
	UploadAgent agent = desktop.query("#btn").as(UploadAgent.class);
	agent.upload(file, null);
	agent.finish();
	agent.upload(file, "text/plain");
	agent.finish();
	FileInputStream is = new FileInputStream(file);
	agent.upload(file.getName(), is, "text/plain");
	agent.finish();
	is.close();
}
  • Line 13: Cast component to UploadAgent and keep its reference.
  • Line 14: Invoke upload() method to upload a file. We can specify content type through the second argument and null value indicates binary form (application/octet-stream).
  • Line 15: Don't forget to invoke finish()method.
  • Line 16: It specifies the content of file is a plain text. For more type definitions, please refer to Internet media type
  • Line 19, 21: The upload(String, InputStream, String) method won't close the input stream, we should close it manually.

Notes

Upload Files with the Static Method

Another way to upload files is that invokes the static method get() of Fileupload.[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

UploadAgent also support this kind of case. However, the static method was invoked according to event occurred. Therefore, we can cast DesktopAgent as a UploadAgent. Following is a typical example of file uploading with the static method:

@Test
public void test(File[] files) throws Exception {
	DesktopAgent desktop = Zats.newClient().connect("/upload.zul");
	desktop.query("#label1").click();
	UploadAgent agent = desktop.as(UploadAgent.class);
	agent.upload(files[0], "text/plain");
	agent.finish();
	desktop.query("#label2").click();
	agent = desktop.as(UploadAgent.class);
	agent.upload(files[0], null);
	agent.upload(files[1], "image/png");
	agent.finish();
}
  • Line 13-15: After performed a event led to upload operation, we can cast DesktopAgent as a UploadFile for uploading.
  • Line 16: Don't forget to invoke finish()method.
  • Line 19-20: If you invoke the static method of Fileupload and specify maximal allowed number, we can upload multiple files at once.

Notes

Upload Multiple Files with HTML5 supported browsers

Since ZK 6.0.0

The components allowed uploading file also support uploading multiple files at once if these components have multiple=true falg and users use the web browsers supported HTML5. [1] Following is a typical example of multiple files uploading:

@Test
public void test(File[] files) throws Exception {
	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-15: We can upload multiple files at once.
  • Line 16: Don't forget to invoke finish()method.


Notes

Supported Components

Components
Version
Note
DesktopAgent 5, 6


aowang



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