|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
---|---|
void |
addPerspectiveListener(SpoonPerspectiveListener listener)
Allows outside code to register to for activation events for this perspective. |
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. |
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 Detail |
---|
String getId()
Composite getUI()
String getDisplayName(Locale l)
l
- current Locale
InputStream getPerspectiveIcon()
void setActive(boolean active)
active
- List<org.pentaho.ui.xul.XulOverlay> getOverlays()
List<org.pentaho.ui.xul.impl.XulEventHandler> getEventHandlers()
void addPerspectiveListener(SpoonPerspectiveListener listener)
listener
- EngineMetaInterface getActiveMeta()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |