Package org.eclnt.workplace

Interface IWorkpageStarter

All Superinterfaces:
Serializable
All Known Implementing Classes:
WorkpageDefaultStarter
public interface IWorkpageStarter extends Serializable
Starts a workpage with the information specified in the startInfo parameter within the workplace environment provided by "workplaceDispatcher" and "workpageContainer".

This is the central interface for starting workpages: any place in the workplace management where workpages are started from (e.g. workplace function tree, favorite icons, ...) do so by using this interface.

The class WorkpageStarterFactory is the one that serves as factory for managing the instance of IWorkpageStarter.

  • Method Details

    • startWorkpage

      IWorkpage startWorkpage(IWorkpageDispatcher workpageDispatcher, IWorkpageContainer workpageContainer, WorkpageStartInfo startInfo)
      Default method for starting workpages.
      Parameters:
      workpageDispatcher - The dispatcher of the caller. By default: getOwningDispatcher().
      workapgeContainer - The workpage container of the caller. By default getWorkpageContainer().
      startInfo - Definition of the workpage to be started.

    • startWorkpage

      IWorkpage startWorkpage(IWorkpageDispatcher workpageDispatcher, IWorkpageContainer workpageContainer, WorkpageStartInfo startInfo, ICreatePageBeanInstance beanCreator)
      Method for creating a page bean and opening it in a new workpage. Problem is: the page bean needs to be created in the context of the new workpage - which is created as part of the method. Ar consequence the page bean is created in a callback by implementing the interface ICreatePageBeanInstance.

      The typical sequence is:
      1. In the startInfo Parameter you define to start a certain page bean by defining WorkpageStartInfo.setPageBeanName(String).
      2. In the call back implementation that you pass via parameter startInfo you create exactly this instance which is then correctly registered within the context of the new workpage.
      Parameters:
      workpageDispatcher - The dispatcher of the caller. By default: getOwningDispatcher().
      workapgeContainer - The workpage container of the caller. By default getWorkpageContainer().
      startInfo - Definition of the workpage to be started.
      callback - for creating the page bean.