public abstract class BasicSplashHandler extends AbstractSplashHandler
Constructor and Description |
---|
BasicSplashHandler() |
Modifier and Type | Method and Description |
---|---|
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.
|
protected Composite |
getContent()
Get the composite on which any supplemental controls should be drawn.
|
protected Color |
getForeground()
Get the foreground text color.
|
protected void |
setForeground(RGB foregroundRGB)
Set the foreground text color.
|
protected void |
setMessageRect(Rectangle messageRect)
Set the location of the message text in the splash.
|
protected void |
setProgressRect(Rectangle progressRect)
Set the location of the progress bar in the splash.
|
getSplash, init
public IProgressMonitor getBundleProgressMonitor()
AbstractSplashHandler
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.
getBundleProgressMonitor
in class AbstractSplashHandler
NullProgressMonitor
,
PlatformUI.getPreferenceStore()
,
IWorkbenchPreferenceConstants.SHOW_PROGRESS_ON_STARTUP
,
WorkbenchAdvisor.initialize(org.eclipse.ui.application.IWorkbenchConfigurer)
public void dispose()
AbstractSplashHandler
Calls to this method will be made from the UI thread.
dispose
in class AbstractSplashHandler
protected void setForeground(RGB foregroundRGB)
getBundleProgressMonitor()
has been invoked.foregroundRGB
- the colorprotected Color getForeground()
protected void setMessageRect(Rectangle messageRect)
getBundleProgressMonitor()
has been invoked.messageRect
- the location of the message textprotected void setProgressRect(Rectangle progressRect)
getBundleProgressMonitor()
has been invoked.progressRect
- the location of the progress barprotected Composite getContent()
This method must be called in the
AbstractSplashHandler.init(org.eclipse.swt.widgets.Shell)
method of a subclasses to
ensure proper creation of controls
Please note that the default implementation of this method assumes that
the IProgressMonitor
returned from
getBundleProgressMonitor()
can be safely casted to a
Composite
. If this is not the case this method must be
reimplemented to reflect the new progress controls.
AbstractSplashHandler.init(org.eclipse.swt.widgets.Shell)
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.