Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.tools.ant.taskdefs.optional.splash

Class SplashTask

Implemented Interfaces:
Cloneable
public class SplashTask
extends 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...
Since:
Ant1.5

Field Summary

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Method Summary

void
execute()
Execute the task.
void
setImageURL(String imgurl)
A URL pointing to an image to display; optional, default antlogo.gif from the classpath.
void
setPassword(String password)
Proxy password; required if user is set.
void
setPort(String port)
Proxy port; optional, default 80.
void
setProxy(String proxy)
name of proxy; optional.
void
setShowduration(int duration)
how long to show the splash screen in milliseconds, optional; default 5000 ms.
void
setUseproxy(boolean useProxy)
Deprecated. since 1.5.x.
void
setUser(String user)
Proxy user; optional, default =none.

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject

Method Details

execute

public void execute()
            throws BuildException
Execute the task.
Overrides:
execute in interface Task
Throws:
BuildException - on error

setImageURL

public void setImageURL(String imgurl)
A URL pointing to an image to display; optional, default antlogo.gif from the classpath.
Parameters:
imgurl - the url string pointing to the image

setPassword

public void setPassword(String password)
Proxy password; required if user is set.
Parameters:
password - the proxy password

setPort

public void setPort(String port)
Proxy port; optional, default 80.
Parameters:
port - the proxy port

setProxy

public void setProxy(String proxy)
name of proxy; optional.
Parameters:
proxy - the name of the proxy host

setShowduration

public void setShowduration(int duration)
how long to show the splash screen in milliseconds, optional; default 5000 ms.
Parameters:
duration - the spash duration in milliseconds

setUseproxy

public void setUseproxy(boolean useProxy)

Deprecated. since 1.5.x. Use org.apache.tools.ant.taskdefs.optional.SetProxy

flag to enable proxy settings; optional, deprecated : consider using <setproxy> instead
Parameters:
useProxy - if ture, enable proxy settings

setUser

public void setUser(String user)
Proxy user; optional, default =none.
Parameters:
user - the proxy user

Overview Package Tree Index Deprecated About