net.sf.taverna.perspectives
Interface PerspectiveSPI

All Known Subinterfaces:
WorkflowPerspective
All Known Implementing Classes:
AbstractPerspective, CustomPerspective, DesignPerspective, EnactPerspective

public interface PerspectiveSPI

SPI representing UI perspectives

Author:
Stuart Owen

Method Summary
 javax.swing.ImageIcon getButtonIcon()
           
 java.io.InputStream getLayoutInputStream()
           
 java.lang.String getText()
           
 boolean isVisible()
          returns true if the perspective is set to be visible
 int positionHint()
          Provides a hint for the position of perspective in the toolbar and menu.
 void setVisible(boolean visible)
          sets whether the perspective should be visible or not.
 void update(org.jdom.Element layoutElement)
          Store internally any changes to the layout xml
 

Method Detail

getLayoutInputStream

java.io.InputStream getLayoutInputStream()
Returns:
the input stream to the layout XML

getButtonIcon

javax.swing.ImageIcon getButtonIcon()
Returns:
the icon image for the toolbar button

getText

java.lang.String getText()
Returns:
the text for the perspective

update

void update(org.jdom.Element layoutElement)
Store internally any changes to the layout xml


positionHint

int positionHint()
Provides a hint for the position of perspective in the toolbar and menu. The lower the value the earlier it will appear in the list. Custom plugins are recommended to start with a value > 100 (allowing for a whopping 100 built in plugins!)


isVisible

boolean isVisible()
returns true if the perspective is set to be visible

Returns:
boolean

setVisible

void setVisible(boolean visible)
sets whether the perspective should be visible or not.