Interface SplashPanel
-
- All Known Implementing Classes:
BasicComponentSplashScreen,DefaultSplashScreen2012
public interface SplashPanel
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddComponentListener(java.awt.event.ComponentListener cl)voidadjustForSize()InformationElementgetInformationElement()intgetPercentage()returns state of loading progress barjavax.swing.JComponentgetSplashComponent()The plugin splashscreens must be placed into another containers, So must return themselves as JComponent.intgetSplashHeight()Height of the plugin windowintgetSplashWidth()Width of the plugin windowjava.lang.StringgetVersion()booleanisAnimationRunning()voidpaintTo(java.awt.Graphics g)voidsetInformationElement(InformationElement content)voidsetPercentage(int done)how mny percentage loaded is shown in progress bar (if any)voidsetSplashHeight(int pluginHeight)Height of the plugin windowvoidsetSplashWidth(int pluginWidth)Width of the plugin windowvoidsetVersion(java.lang.String version)Version can be printed in splash windowvoidstartAnimation()Methods to start the animation in the splash panel.voidstopAnimation()
-
-
-
Method Detail
-
getSplashComponent
javax.swing.JComponent getSplashComponent()
The plugin splashscreens must be placed into another containers, So must return themselves as JComponent. Mostly your SplashScreen will extend some JComponent, so this method will just return "this"
-
setInformationElement
void setInformationElement(InformationElement content)
-
getInformationElement
InformationElement getInformationElement()
-
setSplashWidth
void setSplashWidth(int pluginWidth)
Width of the plugin window
-
setSplashHeight
void setSplashHeight(int pluginHeight)
Height of the plugin window
-
getSplashWidth
int getSplashWidth()
Width of the plugin window
-
getSplashHeight
int getSplashHeight()
Height of the plugin window
-
adjustForSize
void adjustForSize()
-
addComponentListener
void addComponentListener(java.awt.event.ComponentListener cl)
-
isAnimationRunning
boolean isAnimationRunning()
-
startAnimation
void startAnimation()
Methods to start the animation in the splash panel.This method exits after starting a new thread to do the animation. It is synchronized to prevent multiple startAnimation threads from being created.
-
stopAnimation
void stopAnimation()
-
paintTo
void paintTo(java.awt.Graphics g)
-
setVersion
void setVersion(java.lang.String version)
Version can be printed in splash window- Parameters:
version-
-
getVersion
java.lang.String getVersion()
-
setPercentage
void setPercentage(int done)
how mny percentage loaded is shown in progress bar (if any)- Parameters:
done- - should be in 0-100 inclusive
-
getPercentage
int getPercentage()
returns state of loading progress bar- Returns:
- percentage showed in possible progress bar - should be in 0-100
-
-