« Inform.Ant Initial Design Steps | Main | Inform.Ant: Splash Task »

Inform.Ant: instsplash drill down

Time to drill down onto the <image> and <htmlPage> sub elements of the <instSplash> task.

<image> - href, file, or resource are required and mutually exclusive.

  • href [java.net.URL] - A URL to the image to use.
  • file [java.io.File] - A File containing the image to use.
  • resource [String] - A java class resource resolved via ClassLoader.getResource().
  • classpathref [String] - A ref to a named classpath element. This classpath will be used to get the image if the resource attribute specifies the source.
  • <classpath> - As per the standard classpath element. First the classpathref, then each of these in document order will be used to find an image specified by a resource attribute.
  • resize [String] - One of "center", "stretch", or "tile". If the splash panel is not the same size as the image this is how the size discrepancy will be addressed.
  • backgroundcolor [String] - The background color of the splash screen for this image. Useful for images with transparency and center resize policies. The value must return a color from either java.awt.Color.getColor(String) or java.awt.Color.decode(String) (in that order) or the default panel color will be used.
  • #PCDATA - Will be used if the installer is run in "Headless" mode (either by a future configuration or a java.awt.HeadlessException). Contents will be output to the console. (this will need another look for i18n).

<htmlPage> - href, file, or resource are required and mutually exclusive.

  • href [java.net.URL] - A URL to the HTML Page to use.
  • file [java.io.File] - A File containing the HTML Page to use.
  • resource [String] - A java class resource resolved via ClassLoader.getResource(). There are implications with relative URI references here, so it will definitely be addressed later rather than sooner.
  • classpathref [String] - A ref to a named classpath element. This classpath will be used to get the HTML Page if the resource attribute specifies the source.
  • <classpath> - As per the standard classpath element. First the classpathref, then each of these in document order will be used to find a HTML Page specified by a resource attribute.
  • <html> - The actual content of the HTML page in XHTML(may be cut out). This seems to be a pipe dream since Ant does hardcore parsing of all of the elements and I cannot just pass in the children as a org.w3c.dom.Node or NodeList and flatten it to text. But this is what I would like to do.
  • #PCDATA - Will be used if the installer is run in "Headless" mode (either by a future configuration or a java.awt.HeadlessException). Contents will be output to the console. (This will need another look for i18n).

Those are the end-user use case for the instSplash task. The design would need to use a factory to handle whether it is being run in Swing, console, SWT, or AWT mode. I'll address that later should I start writing code for this.

About

This page contains a single entry from the blog posted on October 8, 2002 3:37 AM.

The previous post in this blog was Inform.Ant Initial Design Steps.

The next post in this blog is Inform.Ant: Splash Task.

Many more can be found on the main index page or by looking through the archives.

Powered by
Movable Type 3.33