IMainUI

All Known Implementing Classes:: MainFrame

public interface IMainUI

The interface for all VStar main UI components, e.g. desktop window, applet UI component.

Method Summary

Modifier and Type

Method

Description

void

addTab(String name, ViewModeType viewMode, Component component, boolean canClose)

Add a tab to the main VStar UI that can optionally be closed.

Component

getComponent()

Container

getContentPane()

StatusPane

getStatusPane()

UIType

getUiType()

boolean

isScriptingMode()

Are we in scripting mode?

void

setCursor(Cursor cursor)

Set the cursor for this UI.

void

setScriptingStatus(boolean status)

Set the status of scripting mode.

Method Details
- getUiType
  
  UIType getUiType()
  
  Returns:
  
  the uiType
- getComponent
  
  Component getComponent()
  
  Returns:
  
  the UI component
- getContentPane
  
  Container getContentPane()
  
  Returns:
  
  the UI's content pane.
- getStatusPane
  
  StatusPane getStatusPane()
  
  Returns:
  
  the statusPane
- setCursor
  
  void setCursor(Cursor cursor)
  
  Set the cursor for this UI.
  
  Parameters:
  
  cursor - The cursor to set.
- setScriptingStatus
  
  void setScriptingStatus(boolean status)
  
  Set the status of scripting mode.
  
  Parameters:
  
  status - true or false to indicate whether we are in scripting mode.
- isScriptingMode
  
  boolean isScriptingMode()
  
  Are we in scripting mode?
  
  Returns:
  
  true or false
- addTab
  
  void addTab(String name, ViewModeType viewMode, Component component, boolean canClose)
  
  Add a tab to the main VStar UI that can optionally be closed.
  
  Parameters:
  
  name - The tab's name.
  
  viewMode - The view mode (e.g. plot).
  
  component - The UI component that will be contained within the tabbed pane.
  
  canClose - Whether or not the tab can be closed by the user.