Interface UIInstanceFactory

All Known Implementing Classes:
UI, UISWTInstanceImpl

public interface UIInstanceFactory
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    This method will be called by the UI manager when detaching the UI to permit the action to be vetoed/any detach logic to occur.
    void
    This method will be called by the UI manager after the UIInstance is detached.
    getInstance(PluginInterface plugin_interface)
    Some UI instances need to understand which plugin they are associated with.
     
  • Method Details

    • getInstance

      UIInstance getInstance(PluginInterface plugin_interface)
      Some UI instances need to understand which plugin they are associated with. This method gives the opportunity to customise the UIInstance returned to a plugin so that operations on it can take the appropriate actions
    • detach

      void detach() throws UIException
      This method will be called by the UI manager when detaching the UI to permit the action to be vetoed/any detach logic to occur. It should not be directly called by the plugin code
      Throws:
      UIException
    • dispose

      void dispose()
      This method will be called by the UI manager after the UIInstance is detached.
    • getUIType

      String getUIType()