Class EditorTerminalProps

All Implemented Interfaces:
IPropDesigner, IPropRenameable, EventListener, IGProp<GProp<?>[]>, IPropCnr, Cloneable, IAdaptable

public class EditorTerminalProps extends TerminalProps implements IPropDesigner, IPropRenameable
This Terminal property container holds terminal settings.
  • Constructor Details

    • EditorTerminalProps

      public EditorTerminalProps()
      Creates the screen property container without a name. The name must be set in all cases using the setPropertyAtom call.
    • EditorTerminalProps

      public EditorTerminalProps(Atom propertyAtom)
      Creates the screen property container with the specified name. All system-reserved names for components begins with "$".
      Parameters:
      propertyAtom - the name of the component, unique within it's parent.
  • Method Details

    • getTerminalProps

      public static EditorTerminalProps getTerminalProps(Shell shell, String sessionName) throws IOException
      Attempts to get a terminal properties instance from a session name.
      Parameters:
      shell - The shell.
      sessionName - The session name.
      Returns:
      null If this failed.
      Throws:
      IOException - If connect failed or file I/O errors occurred.
    • getDesigner

      public TerminalDesignerProp getDesigner()
      Gets the Designer Extension for Properties.
      Specified by:
      getDesigner in interface IPropDesigner
      Returns:
      The instance of the Designer Extension.
    • clone

      public EditorTerminalProps clone()
      Clone must be overridden.
      Overrides:
      clone in class TerminalProps
    • isSessionConfigurable

      public boolean isSessionConfigurable()
      Checks if this terminal session can be configured.
      Returns:
      false when this terminal session is EE and it's a captured file.
    • setEESession

      public void setEESession(EESession s)
      Assigns the EESession to the properties. This is a volatile setting.
      Parameters:
      s - The EE session.
    • getSessionName

      public String getSessionName()
      Gets the session name of this property for the screen editor.
      Returns:
      The session name.
    • getEESession

      public EESession getEESession()
      Gets the EESession for saving captures/recording.
      Returns:
      The EE session, or null for live terminal.