UploadAgent"

From Documentation
(Created page with " {{Template:UnderConstruction}} {{ZATSEssentialsPageHeader}} __TOC__ Since 1.1.0 ZATS Mimic introduces the <tt>UploadAgent</tt> to simulate file uploading operation with consis...")
 
Line 1: Line 1:
 
 
{{Template:UnderConstruction}}
 
{{Template:UnderConstruction}}
 
{{ZATSEssentialsPageHeader}}
 
{{ZATSEssentialsPageHeader}}
Line 18: Line 17:
 
We can cast these components as a <tt>UploadAgent</tt> and perform file uploading. Following is a typical example of single file uploading:
 
We can cast these components as a <tt>UploadAgent</tt> and perform file uploading. Following is a typical example of single file uploading:
  
<source lang="java" start="10" high="13, 14, 15, 16, 19, 21">
+
<source lang="java" start="10" high="14, 15, 16,17, 20, 22">
 
@Test
 
@Test
 
public void test(File file) throws Exception {
 
public void test(File file) throws Exception {
 +
File file = getFile();
 
DesktopAgent desktop = Zats.newClient().connect("/upload.zul");
 
DesktopAgent desktop = Zats.newClient().connect("/upload.zul");
 
UploadAgent agent = desktop.query("#btn").as(UploadAgent.class);
 
UploadAgent agent = desktop.query("#btn").as(UploadAgent.class);
Line 33: Line 33:
 
}
 
}
 
</source>
 
</source>
* '''Line 13''': Cast component to <tt>UploadAgent</tt> and keep its reference.
+
* '''Line 14''': Cast component to <tt>UploadAgent</tt> and keep its reference.
* '''Line 14''': Invoke <tt>upload()</tt> 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''': Invoke <tt>upload()</tt> 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 <tt>finish()</tt>method.
+
* '''Line 16''': Don't forget to invoke <tt>finish()</tt>method.
* '''Line 16''': It specifies the content of file is a plain text. For more type definitions, please refer to [http://en.wikipedia.org/wiki/Internet_media_type Internet media type]
+
* '''Line 17''': It specifies the content of file is a plain text. For more type definitions, please refer to [http://en.wikipedia.org/wiki/Internet_media_type Internet media type]
* '''Line 19, 21''': The <tt>upload(String, InputStream, String)</tt> method  won't close the input stream, we should close it manually.
+
* '''Line 20, 22''': The <tt>upload(String, InputStream, String)</tt> method  won't close the input stream, we should close it manually.
  
 
'''Notes'''
 
'''Notes'''
Line 50: Line 50:
 
In this kind of case, we can retrieve <tt>UploadAgent</tt> from casting <javadoc>org.zkoss.zk.ui.DesktopAgent</javadoc>. Following is a typical example of file uploading with the static method:
 
In this kind of case, we can retrieve <tt>UploadAgent</tt> from casting <javadoc>org.zkoss.zk.ui.DesktopAgent</javadoc>. Following is a typical example of file uploading with the static method:
  
<source lang="java" start="10" high="13, 14, 15, 16, 19, 20">
+
<source lang="java" start="10" high="14, 15, 16,17, 20, 21">
 
@Test
 
@Test
public void test(File[] files) throws Exception {
+
public void test() throws Exception {
 +
File[] files = getFiles();
 
DesktopAgent desktop = Zats.newClient().connect("/upload.zul");
 
DesktopAgent desktop = Zats.newClient().connect("/upload.zul");
 
desktop.query("#label1").click();
 
desktop.query("#label1").click();
Line 65: Line 66:
 
}
 
}
 
</source>
 
</source>
* '''Line 13-15''': After triggering an event led to upload operation, we can cast <javadoc>org.zkoss.zk.ui.DesktopAgent</javadoc> as a <tt>UploadFile</tt> for uploading.
+
* '''Line 14-16''': After triggering an event led to upload operation, we can cast <javadoc>org.zkoss.zk.ui.DesktopAgent</javadoc> as a <tt>UploadFile</tt> for uploading.
* '''Line 16''': Don't forget to invoke <tt>finish()</tt>method.
+
* '''Line 17''': Don't forget to invoke <tt>finish()</tt>method.
* '''Line 19-20''': If you invoke the static method of <javadoc>org.zkoss.zul.Fileupload</javadoc> and specify maximal allowed number, we can upload multiple files at once.
+
* '''Line 20-21''': If you invoke the static method of <javadoc>org.zkoss.zul.Fileupload</javadoc> and specify maximal allowed number, we can upload multiple files at once.
  
 
'''Notes'''
 
'''Notes'''
Line 74: Line 75:
 
= Upload Multiple Files with HTML5 Supported Browsers =
 
= Upload Multiple Files with HTML5 Supported Browsers =
  
 +
Since ZK 6.0.0, the components allowed uploading file support uploading multiple files at once if they have <tt>multiple=true</tt> flag and users use the web browsers supported HTML5. <ref>for more detail, please refer to [[ZK_Component_Reference/Essential_Components/Button#Upload]]</ref> Following is a typical example of multiple files uploading:
  
Since ZK 6.0.0
+
<source lang="java" start="10" high="15, 16, 17">
 
 
The components allowed uploading file also support uploading multiple files at once if these components have <tt>multiple=true</tt> falg and users use the web browsers supported HTML5. <ref>for more detail, please refer to [[ZK_Component_Reference/Essential_Components/Button#Upload]]</ref> Following is a typical example of multiple files uploading:
 
 
 
<source lang="java" start="10" high="14, 15, 16">
 
 
@Test
 
@Test
public void test(File[] files) throws Exception {
+
public void test() throws Exception {
 +
File[] files = getFiles();
 
DesktopAgent desktop = Zats.newClient().connect("/upload.zul");
 
DesktopAgent desktop = Zats.newClient().connect("/upload.zul");
 
UploadAgent agent = desktop.query("#btn").as(UploadAgent.class);
 
UploadAgent agent = desktop.query("#btn").as(UploadAgent.class);
Line 89: Line 88:
 
}
 
}
 
</source>
 
</source>
* '''Line 14-15''': We can upload multiple files at once.  
+
* '''Line 15-16''': We can upload multiple files at once.  
* '''Line 16''': Don't forget to invoke <tt>finish()</tt>method.
+
* '''Line 17''': Don't forget to invoke <tt>finish()</tt>method.
  
  

Revision as of 06:40, 2 July 2012

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 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 by invoking upload() method. 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 {
	File file = getFile();
	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 14: Cast component to UploadAgent and keep its reference.
  • Line 15: 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 16: Don't forget to invoke finish()method.
  • Line 17: It specifies the content of file is a plain text. For more type definitions, please refer to Internet media type
  • Line 20, 22: 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 to invoke 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

In this kind of case, we can retrieve UploadAgent from casting DesktopAgent. Following is a typical example of file uploading with the static method:

@Test
public void test() throws Exception {
	File[] files = getFiles();
	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 14-16: After triggering an event led to upload operation, we can cast DesktopAgent as a UploadFile for uploading.
  • Line 17: Don't forget to invoke finish()method.
  • Line 20-21: 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 support uploading multiple files at once if they have multiple=true flag and users use the web browsers supported HTML5. [1] 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 15-16: We can upload multiple files at once.
  • Line 17: 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.