jline
Enum WindowsTerminal.ConsoleMode

java.lang.Object
  extended by java.lang.Enum<WindowsTerminal.ConsoleMode>
      extended by jline.WindowsTerminal.ConsoleMode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<WindowsTerminal.ConsoleMode>
Enclosing class:
WindowsTerminal

public static enum WindowsTerminal.ConsoleMode
extends java.lang.Enum<WindowsTerminal.ConsoleMode>

Console mode

Constants copied wincon.h.


Enum Constant Summary
ENABLE_ECHO_INPUT
          Characters read by the ReadFile or ReadConsole function are written to the active screen buffer as they are read.
ENABLE_LINE_INPUT
          The ReadFile or ReadConsole function returns only when a carriage return character is read.
ENABLE_MOUSE_INPUT
          If the mouse pointer is within the borders of the console window and the window has the keyboard focus, mouse events generated by mouse movement and button presses are placed in the input buffer.
ENABLE_PROCESSED_INPUT
          CTRL+C is processed by the system and is not placed in the input buffer.
ENABLE_PROCESSED_OUTPUT
          When enabled, text entered in a console window will be inserted at the current cursor location and all text following that location will not be overwritten.
ENABLE_WINDOW_INPUT
          User interactions that change the size of the console screen buffer are reported in the console's input buffee.
ENABLE_WRAP_AT_EOL_OUTPUT
          This flag enables the user to use the mouse to select and edit text.
 
Field Summary
 int code
           
 
Method Summary
static WindowsTerminal.ConsoleMode valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static WindowsTerminal.ConsoleMode[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ENABLE_LINE_INPUT

public static final WindowsTerminal.ConsoleMode ENABLE_LINE_INPUT
The ReadFile or ReadConsole function returns only when a carriage return character is read. If this mode is disable, the functions return when one or more characters are available.


ENABLE_ECHO_INPUT

public static final WindowsTerminal.ConsoleMode ENABLE_ECHO_INPUT
Characters read by the ReadFile or ReadConsole function are written to the active screen buffer as they are read. This mode can be used only if the ENABLE_LINE_INPUT mode is also enabled.


ENABLE_PROCESSED_INPUT

public static final WindowsTerminal.ConsoleMode ENABLE_PROCESSED_INPUT
CTRL+C is processed by the system and is not placed in the input buffer. If the input buffer is being read by ReadFile or ReadConsole, other control keys are processed by the system and are not returned in the ReadFile or ReadConsole buffer. If the ENABLE_LINE_INPUT mode is also enabled, backspace, carriage return, and linefeed characters are handled by the system.


ENABLE_WINDOW_INPUT

public static final WindowsTerminal.ConsoleMode ENABLE_WINDOW_INPUT
User interactions that change the size of the console screen buffer are reported in the console's input buffee. Information about these events can be read from the input buffer by applications using theReadConsoleInput function, but not by those using ReadFile orReadConsole.


ENABLE_MOUSE_INPUT

public static final WindowsTerminal.ConsoleMode ENABLE_MOUSE_INPUT
If the mouse pointer is within the borders of the console window and the window has the keyboard focus, mouse events generated by mouse movement and button presses are placed in the input buffer. These events are discarded by ReadFile or ReadConsole, even when this mode is enabled.


ENABLE_PROCESSED_OUTPUT

public static final WindowsTerminal.ConsoleMode ENABLE_PROCESSED_OUTPUT
When enabled, text entered in a console window will be inserted at the current cursor location and all text following that location will not be overwritten. When disabled, all following text will be overwritten. An OR operation must be performed with this flag and the ENABLE_EXTENDED_FLAGS flag to enable this functionality.


ENABLE_WRAP_AT_EOL_OUTPUT

public static final WindowsTerminal.ConsoleMode ENABLE_WRAP_AT_EOL_OUTPUT
This flag enables the user to use the mouse to select and edit text. To enable this option, use the OR to combine this flag with ENABLE_EXTENDED_FLAGS.

Field Detail

code

public final int code
Method Detail

values

public static WindowsTerminal.ConsoleMode[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (WindowsTerminal.ConsoleMode c : WindowsTerminal.ConsoleMode.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static WindowsTerminal.ConsoleMode valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null