|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ui.splash.AbstractSplashHandler
public abstract class AbstractSplashHandler
Base class for splash implementations. Please note that methods on this class
will be invoked while the Workbench is being instantiated. As such, any
resource provided by the workbench plug-in cannot be guaranteed to be
available to this class while executing. No attempt should be made to access
IWorkbench
or any subordinate interfaces or resources.
Constructor Summary | |
---|---|
AbstractSplashHandler()
|
Method Summary | |
---|---|
void |
dispose()
Signal the handler to end the splash and dispose of any resources. |
IProgressMonitor |
getBundleProgressMonitor()
Return the progress monitor responsible for showing bundle loading. |
Shell |
getSplash()
Get the Shell associated with this splash screen. |
void |
init(Shell splash)
Initialize this splash implementation. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AbstractSplashHandler()
Method Detail |
---|
public void init(Shell splash)
Calls to this method will be made from the UI thread.
splash
- the splash shellpublic void dispose()
Calls to this method will be made from the UI thread.
public IProgressMonitor getBundleProgressMonitor()
Calls made to methods on this progress monitor may be made from non-UI threads so implementors must take care to ensure proper synchronization with the UI thread if necessary.
Please note that progress will only be shown if the
"org.eclipse.ui/SHOW_PROGRESS_ON_STARTUP" property has been set to
true
. Because this property defaults to false
RCP developers must set this property via a
plugin_customization.ini
file or by setting the preference
on the Platform UI preference store in the
WorkbenchAdvisor.initialize(org.eclipse.ui.application.IWorkbenchConfigurer)
method if they wish to have progress reported on startup.
NullProgressMonitor
,
PlatformUI.getPreferenceStore()
,
IWorkbenchPreferenceConstants.SHOW_PROGRESS_ON_STARTUP
,
WorkbenchAdvisor.initialize(org.eclipse.ui.application.IWorkbenchConfigurer)
public Shell getSplash()
Shell
associated with this splash screen. If this method
returns a non-null
value prior to the
init(Shell)
being invoked then this shell will be used for the
splash shell and it will subsequently be passed to the
init(Shell)
method. In this way a splash handler may participate
in splash processes prior to the workbench startup.
Calls to this method may be made from any thread. Implementors must take care to ensure proper synchronization with the UI thread if necessary.
|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.