Class AbstractSplashHandler

  • Direct Known Subclasses:
    BasicSplashHandler

    public abstract class AbstractSplashHandler
    extends Object
    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.
    Since:
    3.3
    • Constructor Detail

      • AbstractSplashHandler

        public AbstractSplashHandler()
    • Method Detail

      • init

        public void init​(Shell splash)
        Initialize this splash implementation. This is called very early in the workbench lifecycle before any window is created. The provided shell will already have a background image provided to it but subclasses are free to customize the shell in whatever way they see fit. Subclasses should ensure that they call the base implementation of this method at some point after their own method is invoked.

        Calls to this method will be made from the UI thread.

        Parameters:
        splash - the splash shell
      • dispose

        public void dispose()
        Signal the handler to end the splash and dispose of any resources. Subclasses should ensure that they call the base implementation of this method at some point after their own method is invoked.

        Calls to this method will be made from the UI thread.

      • getSplash

        public Shell getSplash()
        Get the 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.

        Returns:
        the splash shell