Package org.pentaho.di.ui.spoon

Interface SpoonPerspective

All Known Subinterfaces:
SpoonPerspectiveImageProvider
All Known Implementing Classes:
MainSpoonPerspective
public interface SpoonPerspective
A SpoonPerspective is able to modify the look of the application and display it's own UI. Only one perspective can be active at a time though they can run concurrently. SpoonPerspectives are most likely to be registered as part of a SpoonPlugin.
Author:
nbaker

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addPerspectiveListener(SpoonPerspectiveListener listener)
    Allows outside code to register to for activation events for this perspective.
    org.pentaho.di.core.EngineMetaInterface
    getActiveMeta()
    Return the active EngineMeta in the case of perspectives with save-able content.
    String
    getDisplayName(Locale l)
    Returns a localized name for the perspective
    List<org.pentaho.ui.xul.impl.XulEventHandler>
    getEventHandlers()
    Returns a list of Xul Event Handlers (controllers) to be added to Xul Containers in Spoon.
    String
    getId()
    Returns a unique identifier for this perspective
    List<org.pentaho.ui.xul.XulOverlay>
    getOverlays()
    A list of Xul Overlays to be applied and removed when the perspective is loaded or unloaded
    InputStream
    getPerspectiveIcon()
    Perspectives will be represented in spoon by an icon on the main toolbar.
    org.eclipse.swt.widgets.Composite
    getUI()
    Returns the main UI for the perspective.
    void
    setActive(boolean active)
    Called by Spoon whenever the active state of a perspective changes.

  • Method Details

    • getId

      String getId()
      Returns a unique identifier for this perspective
      Returns:
      unique ID

    • getUI

      org.eclipse.swt.widgets.Composite getUI()
      Returns the main UI for the perspective.
      Returns:
      UI Composite

    • getDisplayName

      String getDisplayName(Locale l)
      Returns a localized name for the perspective
      Parameters:
      l - current Locale
      Returns:
      localized name

    • getPerspectiveIcon

      InputStream getPerspectiveIcon()
      Perspectives will be represented in spoon by an icon on the main toolbar. This method returns the InputStream for that icon.
      Returns:
      icon InputStream

    • setActive

      void setActive(boolean active)
      Called by Spoon whenever the active state of a perspective changes.
      Parameters:
      active -

    • getOverlays

      List<org.pentaho.ui.xul.XulOverlay> getOverlays()
      A list of Xul Overlays to be applied and removed when the perspective is loaded or unloaded
      Returns:
      List of XulOverlays.

    • getEventHandlers

      List<org.pentaho.ui.xul.impl.XulEventHandler> getEventHandlers()
      Returns a list of Xul Event Handlers (controllers) to be added to Xul Containers in Spoon. Perspectives may overwrite existing event handlers by registering one with the same ID.
      Returns:
      list of XulEventHandlers

    • addPerspectiveListener

      void addPerspectiveListener(SpoonPerspectiveListener listener)
      Allows outside code to register to for activation events for this perspective.
      Parameters:
      listener -

    • getActiveMeta

      org.pentaho.di.core.EngineMetaInterface getActiveMeta()
      Return the active EngineMeta in the case of perspectives with save-able content.
      Returns:
      active EngineMetaInterface