Class EditorActiveTerminalSession

All Implemented Interfaces:
IPropDesigner, ITooltipPropList, IVirtualizedMonitorPanelProvider, IVirtualizedMonitorProp, EventListener, IGProp<GProp<?>[]>, IPropCnr, ITerminalStateListener, Cloneable, IAdaptable

public class EditorActiveTerminalSession extends ActiveTerminalSession implements IVirtualizedMonitorProp, IVirtualizedMonitorPanelProvider
The container for an active terminal session for the terminal monitor of each client end-point.
Author:
Christopher Mindus
  • Field Details Link icon

    • HEADERS Link icon

      protected static final String[] HEADERS
      The list of terminal properties copied from TerminalProps.
  • Constructor Details Link icon

    • EditorActiveTerminalSession Link icon

      public EditorActiveTerminalSession()
      Constructor.
  • Method Details Link icon

    • getDesigner Link icon

      public VirtualizedMonitorDesignerProp getDesigner()
      Gets the Designer Extension for Properties.
      Specified by:
      getDesigner in interface IPropDesigner
      Specified by:
      getDesigner in interface IVirtualizedMonitorProp
      Returns:
      The instance of the Designer Extension.
    • getPropertyEditorSetup Link icon

      public PropertyEditorSetup getPropertyEditorSetup()
      Gets the Setup used for iiziGo, subclasses must override and provide their instance.
      Specified by:
      getPropertyEditorSetup in interface IVirtualizedMonitorProp
      Returns:
      null by default, i.e. DesignerProp should be used.
    • clone Link icon

      Clones the instance.
      Overrides:
      clone in class PropCnr
    • getTooltipPropertyList Link icon

      public List<TooltipItem> getTooltipPropertyList()
      Gets the list of property names that should be displayed. The value is a String with a Tab delimiter for the text prompt, i.e. an item "Text prompt\t$text" will take a property named "$text" shown with the text prompt "Text prompt:". The first item indicates the heading. Special values for an item are:
      • "" (only empty string) will add space before next line (4 pixel per empty string),
      • "-" for a separator line,
      • "MMM\t" for full line width of text "MMM",
      • "$" for the property name,
      • "&cnText" for the text.
      • "&cnDescription" for the property getCNDescription() available on Text prompt side (before \t),
      • "&cnDescriptionType" for the property getCNDescriptionType() available on Text prompt side (before \t).
      An item that is preceeded with "#" will use bold font.
      An item that is preceeded with "%" will use bold font and the image for the property.
      Specified by:
      getTooltipPropertyList in interface ITooltipPropList
      Returns:
      The list, or null for no tooltip.
    • getCNCategory Link icon

      public int getCNCategory()
      Gets the category of this Common Navigator object, used for sorting.
      Specified by:
      getCNCategory in interface IVirtualizedMonitorProp
      Returns:
      This method returns zero, i.e. no category.
    • getCNImage Link icon

      public Image getCNImage()
      Gets the image for the Common Navigator.
      Specified by:
      getCNImage in interface IVirtualizedMonitorProp
      Returns:
      Image or null if there is no image.
    • getCNText Link icon

      public String getCNText()
      Gets the label text for the Common Navigator.
      Specified by:
      getCNText in interface IVirtualizedMonitorProp
    • getCNDescriptionType Link icon

      public String getCNDescriptionType()
      Provide a type description for the status bar view, if available.
      Specified by:
      getCNDescriptionType in interface IVirtualizedMonitorProp
      Returns:
      A type description for the status bar view, or null if not available.
    • canShowPanelPart Link icon

      public boolean canShowPanelPart()
      Returns if the right panel part can be shown.
      Specified by:
      canShowPanelPart in interface IVirtualizedMonitorPanelProvider
      Returns:
      false by default, override to handle panel parts.
    • showPanelPart Link icon

      public void showPanelPart(Composite parent)
      Requests to show the panel part. When called, the composite is initialized to a grid layout of 1 column with standard margins.
      Specified by:
      showPanelPart in interface IVirtualizedMonitorPanelProvider
      Parameters:
      parent - The parent composite.
    • onPropDispose Link icon

      protected void onPropDispose()
      Called when property is disposed of.
      Overrides:
      onPropDispose in class ActiveTerminalSession
    • onEventSelf Link icon

      public void onEventSelf(GEvent event)
      Property events go here, and a new terminal session request is received from the monitor (client) side if the HostSessionProps are created. Removal of the remote terminal is also processed here.
      Specified by:
      onEventSelf in interface IGProp<GProp<?>[]>
      Overrides:
      onEventSelf in class ActiveTerminalSession
      Parameters:
      event - The property event.
    • onRemoteEvent Link icon

      public void onRemoteEvent(RemoteEvent event)
      Processes remote events from the server's ActiveTerminalSession instance.
      Specified by:
      onRemoteEvent in interface IGProp<GProp<?>[]>
      Overrides:
      onRemoteEvent in class ActiveTerminalSession
      Parameters:
      event - The remote event.
    • isConnected Link icon

      public boolean isConnected()
      Returns if connected.
      Returns:
      true if connected.
    • doRemoteConnect Link icon

      public void doRemoteConnect()
      Performs a remote connect.
    • doRemoteSuspend Link icon

      public void doRemoteSuspend()
      Performs a remote suspend.
    • doRemoteResume Link icon

      public void doRemoteResume()
      Performs a remote connect.
    • doRemoteDisconnect Link icon

      public void doRemoteDisconnect()
      Performs a remote disconnect.
    • doRemoteCapture Link icon

      public void doRemoteCapture()
      Performs a remote capture of screen.