Package com.iizigo.term

Class TerminalView

java.lang.Object
org.eclipse.core.commands.common.EventManager
org.eclipse.ui.part.WorkbenchPart
org.eclipse.ui.part.ViewPart
com.iizigo.term.TerminalView
All Implemented Interfaces:
IActivationListener, IWorkbenchPartIZ, ITerminalStateListener, org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.ui.IPersistable, org.eclipse.ui.IViewPart, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.IWorkbenchPartOrientation
public class TerminalView extends org.eclipse.ui.part.ViewPart implements ITerminalStateListener, IActivationListener, IWorkbenchPartIZ
The Terminal View Part shows one terminal session.
Author:
Christopher Mindus

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ID
    The Terminal Sessions View Part ID "com.iizigo.term.TerminalView".

    Fields inherited from interface org.eclipse.ui.IWorkbenchPart

    PROP_TITLE

  • Constructor Summary

    Constructors
    Constructor
    Description
    TerminalView()
    Eclipse constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    createOrShow(org.eclipse.swt.widgets.Shell shell, EditorTerminalProps props)
    Creates a TerminalView for properties, or shows an existing one.
    void
    createPartControl(org.eclipse.swt.widgets.Composite parent)
    Create contents of the view part.
    void
    dispose()
    Disposes of the view part.
    IPartExtensionIZ
    getExtension()
    Gets the extensions framework.
    SelectionEnabler
    getSelectionEnabler()
    Gets the selection enabler instance.
    IPropUndoRedo
    getUndoRedo()
    Gets the undo context.
    boolean
    hasHostSession()
    Checks if a host session is created.
    void
    init(org.eclipse.ui.IViewSite site)
    Initializes this view with the given view site.
    void
    init(org.eclipse.ui.IViewSite site, org.eclipse.ui.IMemento memento)
    Initializes this view with the given view site.
    boolean
    isDisposed()
    Checks if the part is disposed of.
    void
    onActivated(boolean on)
    Called when activator or deactivated.
    void
    onClose()
    Called when about to close, but SWT is still there.
    void
    onTerminalFieldChanged(HostSession hostSession, TerminalWindow tw)
    Called when the screen needs updates due to field change.
    void
    onTerminalStateUpdate(HostSession hostSession, TerminalWindow tw)
    Called when state probably needs update or check.
    void
    saveState(org.eclipse.ui.IMemento memento)
    Saves the object state within a memento.
    void
    setFocus()
    Sets focus to the terminal.
    void
    updateStates()
    Called when states needs to be updated.

    Methods inherited from class org.eclipse.ui.part.ViewPart

    checkSite, getViewSite, setContentDescription, setInitializationData, setPartName

    Methods inherited from class org.eclipse.ui.part.WorkbenchPart

    addPartPropertyListener, addPropertyListener, firePartPropertyChanged, firePropertyChange, getAdapter, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, getTitleToolTip, removePartPropertyListener, removePropertyListener, setPartProperty, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy

    Methods inherited from class org.eclipse.core.commands.common.EventManager

    addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.eclipse.core.runtime.IAdaptable

    getAdapter

    Methods inherited from interface org.eclipse.ui.IWorkbenchPart

    addPropertyListener, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener

    Methods inherited from interface com.iizigo.editor.IWorkbenchPartIZ

    onComponentFocused

  • Field Details

    • ID

      public static final String ID
      The Terminal Sessions View Part ID "com.iizigo.term.TerminalView".

  • Constructor Details

    • TerminalView

      public TerminalView()
      Eclipse constructor.

  • Method Details

    • createOrShow

      public static void createOrShow(org.eclipse.swt.widgets.Shell shell, EditorTerminalProps props)
      Creates a TerminalView for properties, or shows an existing one.
      Parameters:
      shell - The shell.
      props - The terminal properties.

    • hasHostSession

      public boolean hasHostSession()
      Checks if a host session is created.
      Returns:
      true if there is a session created, false otherwise.

    • init

      public void init(org.eclipse.ui.IViewSite site) throws org.eclipse.ui.PartInitException
      Initializes this view with the given view site.

      This method is automatically called by the workbench shortly after the part is instantiated. It marks the start of the views's life cycle. Clients must not call this method.

      Specified by:
      init in interface org.eclipse.ui.IViewPart
      Overrides:
      init in class org.eclipse.ui.part.ViewPart
      Parameters:
      site - The view site.
      Throws:
      org.eclipse.ui.PartInitException - if this view was not initialized successfully.

    • init

      public void init(org.eclipse.ui.IViewSite site, org.eclipse.ui.IMemento memento) throws org.eclipse.ui.PartInitException
      Initializes this view with the given view site. A memento is passed to the view which contains a snapshot of the views state from a previous session. Where possible, the view should try to recreate that state within the part controls.

      This method is automatically called by the workbench shortly after the part is instantiated. It marks the start of the views's life cycle. Clients must not call this method.

      Specified by:
      init in interface org.eclipse.ui.IViewPart
      Overrides:
      init in class org.eclipse.ui.part.ViewPart
      Parameters:
      site - The view site
      memento - The IViewPart state or null if there is no previous saved state.
      Throws:
      org.eclipse.ui.PartInitException - if this view was not initialized successfully.

    • saveState

      public void saveState(org.eclipse.ui.IMemento memento)
      Saves the object state within a memento.
      Specified by:
      saveState in interface org.eclipse.ui.IPersistable
      Specified by:
      saveState in interface org.eclipse.ui.IViewPart
      Overrides:
      saveState in class org.eclipse.ui.part.ViewPart
      Parameters:
      memento - A memento to receive the object state.

    • createPartControl

      public void createPartControl(org.eclipse.swt.widgets.Composite parent)
      Create contents of the view part.
      Specified by:
      createPartControl in interface org.eclipse.ui.IWorkbenchPart
      Specified by:
      createPartControl in class org.eclipse.ui.part.WorkbenchPart
      Parameters:
      parent - The parent composite.

    • dispose

      public void dispose()
      Disposes of the view part.
      Specified by:
      dispose in interface org.eclipse.ui.IWorkbenchPart
      Overrides:
      dispose in class org.eclipse.ui.part.WorkbenchPart

    • getExtension

      public IPartExtensionIZ getExtension()
      Gets the extensions framework.
      Specified by:
      getExtension in interface IWorkbenchPartIZ

    • getSelectionEnabler

      public SelectionEnabler getSelectionEnabler()
      Gets the selection enabler instance.
      Specified by:
      getSelectionEnabler in interface IWorkbenchPartIZ

    • isDisposed

      public boolean isDisposed()
      Checks if the part is disposed of.
      Specified by:
      isDisposed in interface IActivationListener
      Specified by:
      isDisposed in interface IWorkbenchPartIZ
      Returns:
      true if disposed of, false otherwise.

    • setFocus

      public void setFocus()
      Sets focus to the terminal.
      Specified by:
      setFocus in interface org.eclipse.ui.IWorkbenchPart
      Specified by:
      setFocus in class org.eclipse.ui.part.WorkbenchPart

    • onTerminalStateUpdate

      public void onTerminalStateUpdate(HostSession hostSession, TerminalWindow tw)
      Called when state probably needs update or check.
      Specified by:
      onTerminalStateUpdate in interface ITerminalStateListener
      Parameters:
      hostSession - The host session, may be null.
      tw - The TerminalWindow, may be null when hostSession is null, not otherwise.

    • onTerminalFieldChanged

      public void onTerminalFieldChanged(HostSession hostSession, TerminalWindow tw)
      Called when the screen needs updates due to field change.
      Specified by:
      onTerminalFieldChanged in interface ITerminalStateListener
      Parameters:
      hostSession - The host session, may be null.
      tw - The TerminalWindow, may be null when hostSession is null, not otherwise.

    • updateStates

      public void updateStates()
      Called when states needs to be updated.
      Specified by:
      updateStates in interface IActivationListener

    • onActivated

      public void onActivated(boolean on)
      Called when activator or deactivated.
      Specified by:
      onActivated in interface IActivationListener

    • onClose

      public void onClose()
      Called when about to close, but SWT is still there.
      Specified by:
      onClose in interface IActivationListener

    • getUndoRedo

      public IPropUndoRedo getUndoRedo()
      Gets the undo context.
      Specified by:
      getUndoRedo in interface IWorkbenchPartIZ