Package org.pentaho.di.ui.spoon

Class MainSpoonPerspective

java.lang.Object
org.pentaho.di.ui.spoon.MainSpoonPerspective
All Implemented Interfaces:
SpoonPerspective, SpoonPerspectiveImageProvider
public class MainSpoonPerspective extends Object implements SpoonPerspectiveImageProvider

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ID
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    MainSpoonPerspective(org.eclipse.swt.widgets.Composite ui, TabSet tabfolder)
     

  • 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.
    String
    getPerspectiveIconPath()
    Get the path to the perspective's icon, can be within a jar (classLoader) or file-system.
    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.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

    • MainSpoonPerspective

      public MainSpoonPerspective(org.eclipse.swt.widgets.Composite ui, TabSet tabfolder)

  • Method Details

    • getId

      public String getId()
      Description copied from interface: SpoonPerspective
      Returns a unique identifier for this perspective
      Specified by:
      getId in interface SpoonPerspective
      Returns:
      unique ID

    • getDisplayName

      public String getDisplayName(Locale l)
      Description copied from interface: SpoonPerspective
      Returns a localized name for the perspective
      Specified by:
      getDisplayName in interface SpoonPerspective
      Parameters:
      l - current Locale
      Returns:
      localized name

    • getPerspectiveIcon

      public InputStream getPerspectiveIcon()
      Description copied from interface: SpoonPerspective
      Perspectives will be represented in spoon by an icon on the main toolbar. This method returns the InputStream for that icon.
      Specified by:
      getPerspectiveIcon in interface SpoonPerspective
      Returns:
      icon InputStream

    • getPerspectiveIconPath

      public String getPerspectiveIconPath()
      Description copied from interface: SpoonPerspectiveImageProvider
      Get the path to the perspective's icon, can be within a jar (classLoader) or file-system.
      Specified by:
      getPerspectiveIconPath in interface SpoonPerspectiveImageProvider
      Returns:
      the path to the perspective's icon

    • getUI

      public org.eclipse.swt.widgets.Composite getUI()
      Description copied from interface: SpoonPerspective
      Returns the main UI for the perspective.
      Specified by:
      getUI in interface SpoonPerspective
      Returns:
      UI Composite

    • setActive

      public void setActive(boolean active)
      Description copied from interface: SpoonPerspective
      Called by Spoon whenever the active state of a perspective changes.
      Specified by:
      setActive in interface SpoonPerspective

    • getEventHandlers

      public List<org.pentaho.ui.xul.impl.XulEventHandler> getEventHandlers()
      Description copied from interface: SpoonPerspective
      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.
      Specified by:
      getEventHandlers in interface SpoonPerspective
      Returns:
      list of XulEventHandlers

    • getOverlays

      public List<org.pentaho.ui.xul.XulOverlay> getOverlays()
      Description copied from interface: SpoonPerspective
      A list of Xul Overlays to be applied and removed when the perspective is loaded or unloaded
      Specified by:
      getOverlays in interface SpoonPerspective
      Returns:
      List of XulOverlays.

    • addPerspectiveListener

      public void addPerspectiveListener(SpoonPerspectiveListener listener)
      Description copied from interface: SpoonPerspective
      Allows outside code to register to for activation events for this perspective.
      Specified by:
      addPerspectiveListener in interface SpoonPerspective

    • getActiveMeta

      public org.pentaho.di.core.EngineMetaInterface getActiveMeta()
      Description copied from interface: SpoonPerspective
      Return the active EngineMeta in the case of perspectives with save-able content.
      Specified by:
      getActiveMeta in interface SpoonPerspective
      Returns:
      active EngineMetaInterface