UploadAgent"

From Documentation
Line 3: Line 3:
 
  Since 1.1.0
 
  Since 1.1.0
  
ZATS Mimic introduces the <tt>UploadAgent</tt> to simulate 2 file uploading operations with consistent usage. <tt>UploadAgent</tt> supports single or multiple file uploading like ZK components.  The following are the usage steps:
+
ZATS Mimic introduces the <tt>UploadAgent</tt> to simulate file uploading operation and <tt>UploadAgent</tt> supports single or multiple file uploading.  The following are the usage steps:
 
# Obtain a <tt>UploadAgent</tt> object.
 
# Obtain a <tt>UploadAgent</tt> object.
#: Depending on your case, you could get it from a ''Button'' or from desktop. '''Note that you should use the same object in one uploading duration.'''
+
#: Depending on your case, you could get it from a ''Button'' or from desktop. '''Note that you should use the same object before calling <tt>finish()</tt>.'''
 
# Upload a file by invoking <tt>upload()</tt> method.
 
# Upload a file by invoking <tt>upload()</tt> method.
# Invoke <tt>finish()</tt>method when there is no more file to upload.
+
# Invoke <tt>finish()</tt> when there is no more file to upload.
  
= Uploading Files =
 
  
To set up an uploading feature, you can simply use the <javadoc>org.zkoss.zul.Fileupload</javadoc> component. Alternatively, you can choose to use any button components such as <javadoc>org.zkoss.zul.Button</javadoc>, <javadoc>org.zkoss.zul.Menuitem</javadoc>, <javadoc>org.zkoss.zul.Toolbarbutton</javadoc> and so on.<ref>For more details, please refer to [[ZK Developer's Reference/UI Patterns/File Upload and Download]] and [[ZK Component Reference/Essential Components/Fileupload]]</ref> 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:  
+
= Uploading Files for Components with <tt>upload</tt> attribute=
 +
 
 +
To implement an uploading feature, you can simply use the <javadoc>org.zkoss.zul.Fileupload</javadoc> component. Alternatively, you can choose to use a button components such as <javadoc>org.zkoss.zul.Button</javadoc>, <javadoc>org.zkoss.zul.Menuitem</javadoc>, <javadoc>org.zkoss.zul.Toolbarbutton</javadoc> and so on.<ref>For more details, please refer to [[ZK Developer's Reference/UI Patterns/File Upload and Download]] and [[ZK Component Reference/Essential Components/Fileupload]]</ref> then set <tt>true</tt> to <tt>upload</tt> attribute of these components; users can then click and select a file to upload through a browser dialog, as illustrated below:  
  
 
[[File:Zats_upload_button.png]]
 
[[File:Zats_upload_button.png]]

Revision as of 02:55, 23 April 2013


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.[1] 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:

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 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.[1] 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 upload files is to invoke the static method Fileupload.get().[1] 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.

Zats upload dialog.png

In this 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 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




Last Update : 2013/04/23

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