vertx-lang-scala-docs_2.12 3.4.2 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package ext
  Definition Classes
    scala
-  package shell
  Definition Classes
    ext
-  package term
  Definition Classes
    shell
- HttpTermOptions
- Pty
- SSHTermOptions
- SignalHandler
- SockJSTermHandler
- TelnetTermOptions
- Term
- TermServer
- Tty

c

io.vertx.scala.ext.shell.term

# Term 

###
Companion object Term

#### class Term extends Tty

The terminal.

Linear Supertypes
Tty, AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. Term
2. Tty
3. AnyRef
4. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new Term(_asJava: AnyRef)

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##(): Int
   Definition Classes
     AnyRef → Any
3.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
4.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
5.  def asJava: AnyRef
   Definition Classes
     Tty
6.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( ... )
7.  def close(): Unit

   Close the connection to terminal.

8.  def closeHandler(handler: Handler[Unit]): Term

   Set a handler that will be called when the terminal is closed.

   Set a handler that will be called when the terminal is closed.

   handler

     the handler

   returns

     a reference to this, so the API can be used fluently

9.  def echo(text: String): Term

   Echo some text in the terminal, escaped if necessary.

   Echo some text in the terminal, escaped if necessary.

   text

     the text to echo

   returns

     a reference to this, so the API can be used fluently

10.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
11.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
12.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
13.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
14.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
15.  def height(): Int

    returns

      the current height, i.e the number of columns or `-1` if unknown

    Definition Classes
      Tty
16.  def interruptHandler(handler: SignalHandler): Term

    Set an interrupt signal handler on the term.

    Set an interrupt signal handler on the term.

    handler

      the interrupt handler

    returns

      a reference to this, so the API can be used fluently

17.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
18.  def lastAccessedTime(): Long

    returns

      the last time this term received input

19.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
20.  final def notify(): Unit
    Definition Classes
      AnyRef
21.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
22.  def readline(prompt: String, lineHandler: Handler[String], completionHandler: Handler[Completion]): Unit

    Prompt the user a line of text, providing a completion handler to handle user's completion.

    Prompt the user a line of text, providing a completion handler to handle user's completion.

    prompt

      the displayed prompt

    lineHandler

      the line handler called with the line

    completionHandler

      the completion handler

23.  def readline(prompt: String, lineHandler: Handler[String]): Unit

    Prompt the user a line of text.

    Prompt the user a line of text.

    prompt

      the displayed prompt

    lineHandler

      the line handler called with the line

24.  def resizehandler(handler: Handler[Unit]): Term

    Set a resize handler, the handler is called when the tty size changes.

    Set a resize handler, the handler is called when the tty size changes.

    handler

      the resize handler

    returns

      this object

    Definition Classes
      Term → Tty
25.  def setSession(session: Session): Term

    Associate the term with a session.

    Associate the term with a session.

    session

      the session to set

    returns

      a reference to this, so the API can be used fluently

26.  def stdinHandler(handler: Handler[String]): Term

    Set a stream handler on the standard input to read the data.

    Set a stream handler on the standard input to read the data.

    handler

      the standard input

    returns

      this object

    Definition Classes
      Term → Tty
27.  def suspendHandler(handler: SignalHandler): Term

    Set a suspend signal handler on the term.

    Set a suspend signal handler on the term.

    handler

      the suspend handler

    returns

      a reference to this, so the API can be used fluently

28.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
29.  def toString(): String
    Definition Classes
      AnyRef → Any
30.  def type(): String

    returns

      the declared tty type, for instance `vt100`, `xterm-256`, etc... it can be null when the tty does not have declared its type.

    Definition Classes
      Tty
31.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
32.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
33.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
34.  def width(): Int

    returns

      the current width, i.e the number of rows or `-1` if unknown

    Definition Classes
      Tty
35.  def write(data: String): Term

    Write data to the standard output.

    Write data to the standard output.

    data

      the data to write

    returns

      this object

    Definition Classes
      Term → Tty

### Inherited from Tty

### Inherited from AnyRef

### Inherited from Any

### Ungrouped