Download"
From Documentation
Line 3: | Line 3: | ||
− | We usually | + | We usually implement file downloading through <javadoc>org.zkoss.zul.Filedownload</javadoc> when some events are triggered <ref>For more details, please refer to [[ZK_Component_Reference/Essential_Components/Filedownload]]</ref>. Following is a simple implementation of downloading a file: |
'''download.zul''' | '''download.zul''' | ||
Line 24: | Line 24: | ||
</source> | </source> | ||
− | The download mechanism is a process | + | The download mechanism is a process involving two steps. When you invoke <tt>save()</tt>, the <tt>Filedownload</tt> simply notifies ZK client engine of the download URL. Then, ZK client engine downloads such file according to the referred URL. |
'''Notes''' | '''Notes''' | ||
<references/> | <references/> | ||
− | |||
− | + | = Download Files in a Test Case = | |
− | # perform some operations | + | In order to simulate the behavior of the ZK client engine, ZATS Mimic introduces the <tt>Resource</tt> interface which represents a downloadable resource file saved on the server. General steps for testing a download function are as follows: |
− | # check presence of a downloadable resource through desktop agent | + | |
+ | # perform some operations to trigger the download function, e.g. click a button | ||
+ | # check the presence of a downloadable resource through a desktop agent | ||
# fetch and verify the information or content of the resource | # fetch and verify the information or content of the resource | ||
Line 41: | Line 42: | ||
public void test() throws Exception { | public void test() throws Exception { | ||
DesktopAgent desktop = Zats.newClient().connect("/download.zul"); | DesktopAgent desktop = Zats.newClient().connect("/download.zul"); | ||
− | Assert.assertNull(desktop.getDownloadable()); | + | Assert. assertNull (desktop. getDownloadable ()); |
desktop.query("#btn").click(); | desktop.query("#btn").click(); | ||
Resource resource = desktop.getDownloadable(); | Resource resource = desktop.getDownloadable(); | ||
Assert.assertNotNull(resource); | Assert.assertNotNull(resource); | ||
− | Assert.assertEquals("hello.txt", resource.getName()); | + | Assert.assertEquals("hello..txt", resource.getName()); |
String content = fetchContent(resource.getInputStream()); | String content = fetchContent(resource.getInputStream()); | ||
Assert.assertEquals("Hello world!", content); | Assert.assertEquals("Hello world!", content); | ||
} | } | ||
</source> | </source> | ||
− | * '''Line 14-16''': Since ZATS Mimic handles the response from ZK application automatically, we can retrieve current downloadable resource files from <tt>DesktopAgent.getDownloadable()</tt>. If the method returns a <tt>null</tt> when attempting to retrieve downloadable resources, it indicates that there are no downloadable resources after the previous operation. | + | * '''Line 14''': Click the button to trigger downloading. |
− | * '''Line 17-19''': We can get more information from <tt>Resource</tt>, or fetch the content of resource files in binary through the input stream. | + | * '''Line 15-16''': Since ZATS Mimic handles the response from ZK application automatically, we can retrieve current downloadable resource files from <tt>DesktopAgent.getDownloadable()</tt>. If the method returns a <tt>null</tt> when attempting to retrieve downloadable resources, it indicates that there are no downloadable resources after the previous operation. |
+ | * '''Line 17-19''': We can get more information from <tt>Resource</tt>, or fetch the content of resource files in binary through the input stream to verify the result. | ||
Revision as of 04:05, 23 April 2013
Since 1.1.0
We usually implement file downloading through Filedownload when some events are triggered [1]. Following is a simple implementation of downloading a file:
download.zul
<zk>
<div apply="DownloadComposer">
<button id="btn" label="download" />
</div>
</zk>
DownloadComposer.java
public class DownloadComposer extends GenericForwardComposer {
@Listen("onClick=#btn")
public void download() throws IOException {
Filedownload.save("/hello.txt", "application/octet-stream");
}
}
The download mechanism is a process involving two steps. When you invoke save(), the Filedownload simply notifies ZK client engine of the download URL. Then, ZK client engine downloads such file according to the referred URL.
Notes
- ↑ For more details, please refer to ZK_Component_Reference/Essential_Components/Filedownload
Download Files in a Test Case
In order to simulate the behavior of the ZK client engine, ZATS Mimic introduces the Resource interface which represents a downloadable resource file saved on the server. General steps for testing a download function are as follows:
- perform some operations to trigger the download function, e.g. click a button
- check the presence of a downloadable resource through a desktop agent
- fetch and verify the information or content of the resource
@Test
public void test() throws Exception {
DesktopAgent desktop = Zats.newClient().connect("/download.zul");
Assert. assertNull (desktop. getDownloadable ());
desktop.query("#btn").click();
Resource resource = desktop.getDownloadable();
Assert.assertNotNull(resource);
Assert.assertEquals("hello..txt", resource.getName());
String content = fetchContent(resource.getInputStream());
Assert.assertEquals("Hello world!", content);
}
- Line 14: Click the button to trigger downloading.
- Line 15-16: Since ZATS Mimic handles the response from ZK application automatically, we can retrieve current downloadable resource files from DesktopAgent.getDownloadable(). If the method returns a null when attempting to retrieve downloadable resources, it indicates that there are no downloadable resources after the previous operation.
- Line 17-19: We can get more information from Resource, or fetch the content of resource files in binary through the input stream to verify the result.