Package xyz.cofe.term.win

Class InputMode

  • public class InputMode
extends Object
    Возвращает флаги управляюще вводом

    • Constructor Summary

      Constructors 
      Constructor Description
      InputMode​(int inputFlags)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      InputMode echo​(boolean switchOn)
      switch flag InputModeFlags.ENABLE_ECHO_INPUT
      Символы, прочитанные функцией ReadFile или ReadConsole, записываются в активный экранный буфер по мере ввода в консоль.
      int getInputFlags()  
      InputMode insert​(boolean switchOn)
      switch flag InputModeFlags.ENABLE_INSERT_MODE
      Если этот параметр включен, текст, введенный в окне консоли, будет вставлен в текущее местоположение курсора и весь текст после этого местоположения не будут перезаписаны.
      boolean isEcho()
      read flag InputModeFlags.ENABLE_ECHO_INPUT
      Символы, прочитанные функцией ReadFile или ReadConsole, записываются в активный экранный буфер по мере ввода в консоль.
      boolean isInsert()
      read flag InputModeFlags.ENABLE_INSERT_MODE
      Если этот параметр включен, текст, введенный в окне консоли, будет вставлен в текущее местоположение курсора и весь текст после этого местоположения не будут перезаписаны.
      boolean isLine()
      read flag InputModeFlags.ENABLE_LINE_INPUT
      Функция ReadFile или ReadConsole возвращает значение только тогда, когда читается символ возврата каретки.
      boolean isMouse()
      read flag InputModeFlags.ENABLE_MOUSE_INPUT
      Если указатель мыши находится в пределах границ окна консоли и окно имеет фокус клавиатуры, события мыши генерируются движением мыши и нажатия кнопок помещаются в буфер ввода.
      boolean isProcessing()
      read flag InputModeFlags.ENABLE_PROCESSED_INPUT
      CTRL+C обрабатывается системой и не помещается в буфер ввода.
      boolean isQuickEdit()
      read flag InputModeFlags.ENABLE_QUICK_EDIT_MODE
      Этот флаг позволяет пользователю использовать мышь для выбора и редактирования текста.
      boolean isVirtualTerminal()
      read flag InputModeFlags.ENABLE_VIRTUAL_TERMINAL_INPUT
      Установка этого флага направляет механизм обработки виртуального терминала.
      boolean isWindow()
      read flag InputModeFlags.ENABLE_WINDOW_INPUT
      Взаимодействия с пользователем, которые изменяют размер экранного буфера консоли, сообщается в буфере ввода консоли.
      InputMode line​(boolean switchOn)
      switch flag InputModeFlags.ENABLE_LINE_INPUT
      Функция ReadFile или ReadConsole возвращает значение только тогда, когда читается символ возврата каретки.
      InputMode mouse​(boolean switchOn)
      switch flag InputModeFlags.ENABLE_MOUSE_INPUT
      Если указатель мыши находится в пределах границ окна консоли и окно имеет фокус клавиатуры, события мыши генерируются движением мыши и нажатия кнопок помещаются в буфер ввода.
      InputMode processing​(boolean switchOn)
      switch flag InputModeFlags.ENABLE_PROCESSED_INPUT
      CTRL+C обрабатывается системой и не помещается в буфер ввода.
      InputMode quickEdit​(boolean switchOn)
      switch flag InputModeFlags.ENABLE_QUICK_EDIT_MODE
      Этот флаг позволяет пользователю использовать мышь для выбора и редактирования текста.
      String toString()  
      InputMode virtualTerminal​(boolean switchOn)
      switch flag InputModeFlags.ENABLE_VIRTUAL_TERMINAL_INPUT
      Установка этого флага направляет механизм обработки виртуального терминала.
      InputMode window​(boolean switchOn)
      switch flag InputModeFlags.ENABLE_WINDOW_INPUT
      Взаимодействия с пользователем, которые изменяют размер экранного буфера консоли, сообщается в буфере ввода консоли.

    • Constructor Detail

      • InputMode

        public InputMode​(int inputFlags)

    • Method Detail

      • getInputFlags

        public int getInputFlags()

      • isEcho

        public boolean isEcho()
        read flag InputModeFlags.ENABLE_ECHO_INPUT
        Символы, прочитанные функцией ReadFile или ReadConsole, записываются в активный экранный буфер по мере ввода в консоль.
        Этот режим можно использовать, только если также включен режим ENABLE_LINE_INPUT.
        Returns:
        value

      • echo

        public InputMode echo​(boolean switchOn)
        switch flag InputModeFlags.ENABLE_ECHO_INPUT
        Символы, прочитанные функцией ReadFile или ReadConsole, записываются в активный экранный буфер по мере ввода в консоль.
        Этот режим можно использовать, только если также включен режим ENABLE_LINE_INPUT.
        Parameters:
        switchOn - value
        Returns:
        new mode with switched flag

      • isInsert

        public boolean isInsert()
        read flag InputModeFlags.ENABLE_INSERT_MODE
        Если этот параметр включен, текст, введенный в окне консоли, будет вставлен в текущее местоположение курсора и весь текст после этого местоположения не будут перезаписаны.
        Когда отключено, весь последующий текст будет перезаписан.
        Returns:
        value

      • insert

        public InputMode insert​(boolean switchOn)
        switch flag InputModeFlags.ENABLE_INSERT_MODE
        Если этот параметр включен, текст, введенный в окне консоли, будет вставлен в текущее местоположение курсора и весь текст после этого местоположения не будут перезаписаны.
        Когда отключено, весь последующий текст будет перезаписан.
        Parameters:
        switchOn - value
        Returns:
        new mode with switched flag

      • isLine

        public boolean isLine()
        read flag InputModeFlags.ENABLE_LINE_INPUT
        Функция ReadFile или ReadConsole возвращает значение только тогда, когда читается символ возврата каретки.
        Если этот режим отключен, функции возвращаются, когда доступны один или несколько символов.
        Returns:
        value

      • line

        public InputMode line​(boolean switchOn)
        switch flag InputModeFlags.ENABLE_LINE_INPUT
        Функция ReadFile или ReadConsole возвращает значение только тогда, когда читается символ возврата каретки.
        Если этот режим отключен, функции возвращаются, когда доступны один или несколько символов.
        Parameters:
        switchOn - value
        Returns:
        new mode with switched flag

      • isMouse

        public boolean isMouse()
        read flag InputModeFlags.ENABLE_MOUSE_INPUT
        Если указатель мыши находится в пределах границ окна консоли и окно имеет фокус клавиатуры, события мыши генерируются движением мыши и нажатия кнопок помещаются в буфер ввода.
        Эти события отбрасываются ReadFile или ReadConsole, даже если этот режим включен.
        Функцию ReadConsoleInput можно использовать для чтения входных записей MOUSE_EVENT из входного буфера.
        Returns:
        value

      • mouse

        public InputMode mouse​(boolean switchOn)
        switch flag InputModeFlags.ENABLE_MOUSE_INPUT
        Если указатель мыши находится в пределах границ окна консоли и окно имеет фокус клавиатуры, события мыши генерируются движением мыши и нажатия кнопок помещаются в буфер ввода.
        Эти события отбрасываются ReadFile или ReadConsole, даже если этот режим включен.
        Функцию ReadConsoleInput можно использовать для чтения входных записей MOUSE_EVENT из входного буфера.
        Parameters:
        switchOn - value
        Returns:
        new mode with switched flag

      • isProcessing

        public boolean isProcessing()
        read flag InputModeFlags.ENABLE_PROCESSED_INPUT
        CTRL+C обрабатывается системой и не помещается в буфер ввода.
        Если входной буфер считывается с помощью ReadFile или ReadConsole, другие клавиши управления обрабатываются системой и не возвращаются в буфер ReadFile или ReadConsole.
        Если также включен режим ENABLE_LINE_INPUT, Backspace, возврат каретки, и символы перевода строки обрабатываются системой.
        Returns:
        value

      • processing

        public InputMode processing​(boolean switchOn)
        switch flag InputModeFlags.ENABLE_PROCESSED_INPUT
        CTRL+C обрабатывается системой и не помещается в буфер ввода.
        Если входной буфер считывается с помощью ReadFile или ReadConsole, другие клавиши управления обрабатываются системой и не возвращаются в буфер ReadFile или ReadConsole.
        Если также включен режим ENABLE_LINE_INPUT, Backspace, возврат каретки, и символы перевода строки обрабатываются системой.
        Parameters:
        switchOn - value
        Returns:
        new mode with switched flag

      • isQuickEdit

        public boolean isQuickEdit()
        read flag InputModeFlags.ENABLE_QUICK_EDIT_MODE
        Этот флаг позволяет пользователю использовать мышь для выбора и редактирования текста.
        Чтобы включить этот режим, используйте ENABLE_QUICK_EDIT_MODE | ENABLE_EXTENDED_FLAGS.
        Чтобы отключить этот режим, используйте ENABLE_EXTENDED_FLAGS без этого флага.
        Returns:
        value

      • quickEdit

        public InputMode quickEdit​(boolean switchOn)
        switch flag InputModeFlags.ENABLE_QUICK_EDIT_MODE
        Этот флаг позволяет пользователю использовать мышь для выбора и редактирования текста.
        Чтобы включить этот режим, используйте ENABLE_QUICK_EDIT_MODE | ENABLE_EXTENDED_FLAGS.
        Чтобы отключить этот режим, используйте ENABLE_EXTENDED_FLAGS без этого флага.
        Parameters:
        switchOn - value
        Returns:
        new mode with switched flag

      • isWindow

        public boolean isWindow()
        read flag InputModeFlags.ENABLE_WINDOW_INPUT
        Взаимодействия с пользователем, которые изменяют размер экранного буфера консоли, сообщается в буфере ввода консоли.
        Информация об этих событиях может быть прочитана из входного буфера приложениями, использующими функцию ReadConsoleInput, но не теми, кто использует ReadFile или ReadConsole.
        Returns:
        value

      • window

        public InputMode window​(boolean switchOn)
        switch flag InputModeFlags.ENABLE_WINDOW_INPUT
        Взаимодействия с пользователем, которые изменяют размер экранного буфера консоли, сообщается в буфере ввода консоли.
        Информация об этих событиях может быть прочитана из входного буфера приложениями, использующими функцию ReadConsoleInput, но не теми, кто использует ReadFile или ReadConsole.
        Parameters:
        switchOn - value
        Returns:
        new mode with switched flag

      • isVirtualTerminal

        public boolean isVirtualTerminal()
        read flag InputModeFlags.ENABLE_VIRTUAL_TERMINAL_INPUT
        Установка этого флага направляет механизм обработки виртуального терминала. для преобразования пользовательского ввода, полученного окном консоли, в последовательности виртуального терминала консоли, которые может быть получен вспомогательным приложением с помощью функций ReadFile или ReadConsole.
        Типичное использование этого флага предполагается в сочетании с ENABLE_VIRTUAL_TERMINAL_PROCESSING на дескриптор вывода для подключения к приложению который общается исключительно через последовательности виртуальных терминалов.
        Returns:
        value

      • virtualTerminal

        public InputMode virtualTerminal​(boolean switchOn)
        switch flag InputModeFlags.ENABLE_VIRTUAL_TERMINAL_INPUT
        Установка этого флага направляет механизм обработки виртуального терминала. для преобразования пользовательского ввода, полученного окном консоли, в последовательности виртуального терминала консоли, которые может быть получен вспомогательным приложением с помощью функций ReadFile или ReadConsole.
        Типичное использование этого флага предполагается в сочетании с ENABLE_VIRTUAL_TERMINAL_PROCESSING на дескриптор вывода для подключения к приложению который общается исключительно через последовательности виртуальных терминалов.
        Parameters:
        switchOn - value
        Returns:
        new mode with switched flag