Package org.eclnt.workplace

Class MultiWorkplaceConnector

java.lang.Object
org.eclnt.workplace.MultiWorkplaceConnector
public class MultiWorkplaceConnector extends Object

  • Field Details

  • Method Details

    • instance

      public static MultiWorkplaceConnector instance()

    • getDefaultWorkplaceURL

      public String getDefaultWorkplaceURL()

    • getDefaultWindowFeatures

      public String getDefaultWindowFeatures()

    • startWorkplace

      public void startWorkplace(IWorkpageDispatcher currentDispatcher, String newWorkplaceName, MultiWorkplaceConnector.WorkplaceConfiguration workplaceConfiguration, WorkpageStartInfo wpsi) throws MultiWorkplaceConnector.WorkplaceWithNameAlreadyExistsException
      Starts a second instance of a workplace in an browser instance - using the components that are implicitly created within the ROWWORKPLACE component.
      Parameters:
      currentDispatcher - Workpage container of starting workplace.
      newWorkplaceName - Logical name of the new workplace.
      startWorkplaceBaseURL - The URL to start the workplace, e.g. "/startWorkplace.risc". This is the URL that is used to start the dependent workplace
      wpsi - The workpage that is to be started in the workplace. Optional - if null is passed then an empty workplace is started.
      Throws:
      MultiWorkplaceConnector.WorkplaceWithNameAlreadyExistsException

    • createStartWorkplaceURL

      public String createStartWorkplaceURL(IWorkpageDispatcher currentDispatcher, String newWorkplaceName, String startWorkplaceBaseURL, WorkpageStartInfo wpsi) throws MultiWorkplaceConnector.WorkplaceWithNameAlreadyExistsException
      Create URL that starts a new "dependent" workplace with a certain logical name. The URL that is passed back as result is the original URL, extended by some additional parameters, that are required to bind the second workplace to the processing of the first one.
      Parameters:
      currentDispatcher - Worpage container of starting workplace.
      newWorkplaceName - Locical name of the new workplace.
      startWorkplaceBaseURL - The URL to start the workplace, e.g. "/startWorkplace.risc". This is the URL that is used to start the dependent workplace
      Returns:
      URL to really start the workplace.
      Throws:
      MultiWorkplaceConnector.WorkplaceWithNameAlreadyExistsException

    • getDependentWorkplace

      public IWorkpageDispatcher getDependentWorkplace(IWorkpageDispatcher startingDispatcher, String workplaceName)
      Access the dependent workplace.
      Parameters:
      startingDispatcher - The dispatcher of the workplace from which the dependent workplace was started.

    • startWorkpage

      public void startWorkpage(IWorkpageDispatcher fromWorkplace, String targetWorkplaceName, MultiWorkplaceConnector.WorkplaceConfiguration workplaceConfiguration, WorkpageStartInfo wpsi, boolean openWorkplaceInstanceIfNotExists)
      Start/switch to a workpage in the dependent workplace.
      Parameters:
      fromWorkplace -
      wpsi -
      targetWorkplaceName -
      if - defined with false, then the workpage will be opened in the current workplace if there is no workplace available with value of parameter "targetWorkplaceName". If defined with true then the a new workplace instance will be started.

    • checkIfAlreadyStarted

      public boolean checkIfAlreadyStarted(IWorkpageDispatcher currentDispatcher, String newWorkplaceName)
      Checks if a dependent workplace with a certain name already is available.
      Parameters:
      currentDispatcher -
      newWorkplaceName -
      Returns:

    • getConnectedWorkplaces

      public Set<IWorkpageDispatcher> getConnectedWorkplaces(IWorkpageDispatcher owningDispatcher)
      Finds all workplaces that are connected to the workplace passed in the method.