org.netbeans.microedition.svg
Class SVGSplashScreen

java.lang.Object
  extended by javax.microedition.lcdui.Displayable
      extended by javax.microedition.lcdui.Canvas
          extended by org.netbeans.microedition.svg.SVGPlayer
              extended by org.netbeans.microedition.svg.SVGAnimatorWrapper
                  extended by org.netbeans.microedition.svg.SVGSplashScreen
All Implemented Interfaces:
javax.microedition.lcdui.CommandListener

public class SVGSplashScreen
extends SVGAnimatorWrapper

This component represents a splash screen, which is usually being displayed when the application starts. It waits for a specified amount of time (by default 5000 milliseconds) and then calls specified command listener commandAction method with DISMISS_COMMAND as command parameter. It displays an animation of SVG image.


Field Summary
static javax.microedition.lcdui.Command DISMISS_COMMAND
          Command fired when the screen is about to be dismissed
static int FOREVER
          Timeout value which wait forever.
 
Fields inherited from class org.netbeans.microedition.svg.SVGPlayer
BOTTOM, BOTTOM_LEFT, BOTTOM_RIGHT, CENTER, LEFT, PAUSED, PLAYING, RIGHT, STOPPED, TOP, TOP_LEFT, TOP_RIGHT
 
Fields inherited from class javax.microedition.lcdui.Canvas
DOWN, FIRE, GAME_A, GAME_B, GAME_C, GAME_D, KEY_NUM0, KEY_NUM1, KEY_NUM2, KEY_NUM3, KEY_NUM4, KEY_NUM5, KEY_NUM6, KEY_NUM7, KEY_NUM8, KEY_NUM9, KEY_POUND, KEY_STAR, UP
 
Constructor Summary
SVGSplashScreen(javax.microedition.m2g.SVGImage svgImage, javax.microedition.lcdui.Display display)
          Creates a new instance of SVGSplashScreen

Please note, supplied SVGImage shouldn't be reused in other SVGAnimator.

 
Method Summary
 int getTimeout()
          Gets current timeout of the splash screen
 boolean isAllowTimeoutInterrupt()
          Can be the splashscreen interrupted (dismissed) by the user pressing a key?
 void setAllowTimeoutInterrupt(boolean allow)
          Set to true, when the timeout with a specified timeout interval can be interrupted by pressing a key.
 void setTimeout(int timeout)
          Sets the timeout of the splash screen - i.e. the time in milliseconds for how long the splash screen is going to be shown on the display.
 
Methods inherited from class org.netbeans.microedition.svg.SVGPlayer
addCommand, commandAction, computeAnchorTranslate, getAnimator, getAnimatorState, getCommandListener, getDisplay, getDocument, getSafeSVGEventListener, getScreenBBox, getSVGAnimationElementById, getSvgCanvas, getSVGElementById, getSVGEventListener, getSVGImage, getSVGLocatableElementById, getTicker, getTimeIncrement, getTitle, invokeAndWait, invokeAndWaitSafely, invokeLater, invokeLaterSafely, isResetAnimationWhenStopped, paint, pause, play, removeCommand, reset, rotate, rotate, rotateAbout, rotateAbout, rotateAboutSafely, rotateSafely, scale, scale, scaleAbout, scaleAbout, scaleAboutSafely, scaleSafely, screenTranslate, screenTranslate, screenTranslateSafely, setCommandListener, setFloatTrait, setFloatTraitSafely, setFullScreenMode, setResetAnimationWhenStopped, setRGBTrait, setRGBTrait, setRGBTraitSafely, setRGBTraitSafely, setSafeSVGEventListener, setStartAnimationImmediately, setSVGEventListener, setTicker, setTimeIncrement, setTitle, setTrait, setTraitSafely, startAnimation, startAnimation, startAnimationSafely, stop, stopAnimation, stopAnimation, stopAnimationSafely, translate, translate, translateSafely
 
Methods inherited from class javax.microedition.lcdui.Canvas
getGameAction, getKeyCode, getKeyName, hasPointerEvents, hasPointerMotionEvents, hasRepeatEvents, hideNotify, isDoubleBuffered, keyPressed, keyReleased, keyRepeated, pointerDragged, pointerPressed, pointerReleased, repaint, repaint, serviceRepaints, showNotify, sizeChanged
 
Methods inherited from class javax.microedition.lcdui.Displayable
getHeight, getWidth, isShown
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DISMISS_COMMAND

public static final javax.microedition.lcdui.Command DISMISS_COMMAND
Command fired when the screen is about to be dismissed


FOREVER

public static final int FOREVER
Timeout value which wait forever. Value is "0".

See Also:
Constant Field Values
Constructor Detail

SVGSplashScreen

public SVGSplashScreen(javax.microedition.m2g.SVGImage svgImage,
                       javax.microedition.lcdui.Display display)
                throws java.lang.IllegalArgumentException
Creates a new instance of SVGSplashScreen

Please note, supplied SVGImage shouldn't be reused in other SVGAnimator.

Throws:
java.lang.IllegalArgumentException
Method Detail

setTimeout

public void setTimeout(int timeout)
Sets the timeout of the splash screen - i.e. the time in milliseconds for how long the splash screen is going to be shown on the display.

If the supplied timeout is 0, then the splashscreen waits forever (it needs to be dismissed by pressing a key)

Parameters:
timeout - in milliseconds

getTimeout

public int getTimeout()
Gets current timeout of the splash screen

Returns:
timeout value

setAllowTimeoutInterrupt

public void setAllowTimeoutInterrupt(boolean allow)
Set to true, when the timeout with a specified timeout interval can be interrupted by pressing a key.

Parameters:
allow - true if the user can interrupt the screen, false if the user need to wait until timeout.

isAllowTimeoutInterrupt

public boolean isAllowTimeoutInterrupt()
Can be the splashscreen interrupted (dismissed) by the user pressing a key?

Returns:
true if user can interrupt it, false otherwise