blob: e158bd294ddfea57de33030ab70739e852ed44ac (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<title>Apache Ant User Manual</title>
</head>
<body>
<h2><a name="Splash">Splash</a></h2>
<p>by Les Hughes (leslie.hughes@rubus.com)
<h3>Description</h3>
<p>This task creates a splash screen. The splash screen is displayed
for the duration of the build and includes a handy progress bar as
well. Use in conjunction with the sound task to provide interest
whilst waiting for your builds to complete...</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
<td align="center" valign="top"><b>Default</b></td>
</tr>
<tr>
<td valign="top">imageurl</td>
<td valign="top">A URL pointing to an image to display.</td>
<td valign="top" align="center">No</td>
<td valign="top" align="center">antlogo.gif from the classpath</td>
</tr>
<tr>
<td valign="top">showduration</td>
<td valign="top">Initial period to pause the build to show the
splash in milliseconds.</td>
<td valign="top" align="center">No</td>
<td valign="top" align="center">5000 ms</td>
</tr>
<tr>
<td valign="top">progressregexp</td>
<td valign="top">Progress regular expression which is used to
parse the output and dig out current progress. Exactly one group
pattern must exists, and it represents the progress number (0-100)
(i.e "Progress: (.*)%")<br/>
<em>since Apache Ant 1.8.0</em></td>
<td valign="top" align="center">No</td>
<td valign="top" align="center">progress is increased every action
and log output line</td>
</tr>
<tr>
<td valign="top">displaytext</td>
<td valign="top">display text presented in the splash window<br/>
<em>since Ant 1.8.0</em></td>
<td valign="top" align="center">No</td>
<td valign="top" align="center">Building ...</td>
</tr>
</table>
<h3>Deprecated properties</h3>
The following properties can be used to configure the proxy settings to retrieve
an image from behind a firewall. However, the settings apply not just to this
task, but to all following tasks. Therefore they are now deprecated in
preference to the <code><setproxy></code> task, that makes it clear to readers of
the build exactly what is going on.
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top">useproxy</td>
<td valign="top">Use a proxy to access imgurl. Note: Only tested
on JDK 1.2.2 and above</td>
<td valign="top" align="center">No</td>
<td valign="top" align="center">None</td>
</tr>
<tr>
<td valign="top">proxy</td>
<td valign="top">IP or hostname of the proxy server</td>
<td valign="top" align="center">No</td>
<td valign="top" align="center">None</td>
</tr>
<tr>
<td valign="top">port</td>
<td valign="top">Proxy portnumber</td>
<td valign="top" align="center">No</td>
<td valign="top" align="center">None</td>
</tr>
<tr>
<td valign="top">user</td>
<td valign="top">User to authenticate to the proxy as.</td>
<td valign="top" align="center">No</td>
<td valign="top" align="center">None</td>
</tr>
<tr>
<td valign="top">password</td>
<td valign="top">Proxy password</td>
<td valign="top" align="center">No</td>
<td valign="top" align="center">None</td>
</tr>
</table>
<h3>Examples</h3>
<blockquote><pre>
<splash/>
</pre></blockquote>
<p>Splash <code>images/ant_logo_large.gif</code> from the classpath.</p>
<blockquote><pre>
<splash imageurl="http://jakarta.apache.org/images/jakarta-logo.gif"
useproxy="true"
showduration="5000"/>
</pre></blockquote>
<p>Splashes the jakarta logo, for an initial period of 5 seconds.</p>
<p>Splash with controlled progress and nondefault text</p>
<blockquote><pre>
<target name="test_new_features">
<echo>New features</echo>
<splash progressRegExp="Progress: (.*)%" showduration="0" displayText="Test text"/>
<sleep seconds="1"/>
<echo>Progress: 10%</echo>
<sleep seconds="1"/>
<echo>Progress: 20%</echo>
<sleep seconds="1"/>
<echo>Progress: 50%</echo>
<sleep seconds="1"/>
<echo>Progress: 70%</echo>
<sleep seconds="1"/>
<echo>Progress: 100%</echo>
<sleep seconds="3"/>
</target>
</pre></blockquote>
</body>
</html>
|
