org.java.plugin.boot
Interface SplashHandler

public interface SplashHandler

Interface to control application splash screen.

Version:

$Id$

See Also:

Boot.getSplashHandler()

Method Summary

void	configure(ExtendedProperties config) Configures this handler instance.
java.net.URL	getImage()
java.lang.Object	getImplementation() Useful method to get access to handler internals.
float	getProgress()
java.lang.String	getText()
boolean	isVisible()
void	setImage(java.net.URL value) Sets new image URL and optionally displays it on the splash screen.
void	setProgress(float value) Sets boot progress value and optionally adjust visual progress bar control.
void	setText(java.lang.String value) Sets new text caption and optionally display it on the screen.
void	setVisible(boolean value) Shows/hides splash screen.

Method Detail

configure

void configure(ExtendedProperties config)

Configures this handler instance. This method is called ones immediately after handler instantiation.

Parameters:

config - handler configuration data, here included all configuration parameters which name starts with org.java.plugin.boot.splash. prefix

getProgress

float getProgress()

Returns:

boot progress value that is normalized to [0; 1] interval

setProgress

void setProgress(float value)

Sets boot progress value and optionally adjust visual progress bar control. The value should be in [0; 1] interval.

Parameters:

value - new progress value

getText

java.lang.String getText()

Returns:

current text caption

setText

void setText(java.lang.String value)

Sets new text caption and optionally display it on the screen.

Parameters:

value - new text caption

getImage

java.net.URL getImage()

Returns:

current image URL

setImage

void setImage(java.net.URL value)

Sets new image URL and optionally displays it on the splash screen.

Parameters:

value - new image URL

isVisible

boolean isVisible()

Returns:

true if splash screen is displayed now

setVisible

void setVisible(boolean value)

Shows/hides splash screen.

Parameters:

value - true to show splash screen, false - to hide and dispose it

getImplementation

java.lang.Object getImplementation()

Useful method to get access to handler internals. The actually returned object depends on handler implementation.

Returns:

original implementation of this handler, usually you return this (useful for handler wrappers)