Skip navigation links
A B C E F G H I L O P R S T V W X 

A

add(String) - Method in class com.flowingcode.vaadin.addons.xterm.TerminalHistory
Add a line to the history
addCustomKeyListener(DomEventListener, Key, KeyModifier...) - Method in class com.flowingcode.vaadin.addons.xterm.XTermBase
Add a server-side key listener.
addCustomKeyListener(DomEventListener, Key, KeyLocation, KeyModifier...) - Method in class com.flowingcode.vaadin.addons.xterm.XTermBase
Add a server-side key listener.
addLineListener(ComponentEventListener<ITerminalConsole.LineEvent>) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalConsole
Adds a line listener.
apply() - Method in class com.flowingcode.vaadin.addons.xterm.utils.StateMemoizer
Calls all setters again on StateMemoizer.delegate.

B

blur() - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminal
Unfocus the terminal.
blur() - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
 

C

clear() - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminal
Clear the entire buffer, making the prompt line the new first line.
clear() - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
 
clear() - Method in class com.flowingcode.vaadin.addons.xterm.TerminalHistory
Clears the history.
clearSelection() - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminal
Clears the current terminal selection.
clearSelection() - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
 
com.flowingcode.vaadin.addons.xterm - package com.flowingcode.vaadin.addons.xterm
 
com.flowingcode.vaadin.addons.xterm.utils - package com.flowingcode.vaadin.addons.xterm.utils
 

E

executeJs(String, Serializable...) - Method in class com.flowingcode.vaadin.addons.xterm.XTermBase
 
extend(XTerm) - Static method in class com.flowingcode.vaadin.addons.xterm.TerminalHistory
Adds support for command history to the given terminal.

F

fit() - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalFit
 
focus() - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminal
Focus the terminal.
focus() - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
 

G

getCurrentLine() - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalConsole
Returns the text in the current line
getKeyboardSelectionEnabled() - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalSelection
Returns the command line prompt.
getLines() - Method in class com.flowingcode.vaadin.addons.xterm.TerminalHistory
Returns the lines in the history.
getPrompt() - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalConsole
Returns the command line prompt.
getPrompt() - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
getProxy() - Method in class com.flowingcode.vaadin.addons.xterm.utils.StateMemoizer
Setters invoked on this proxy will have the args remembered; the methods invocations will then be passed on to StateMemoizer.delegate.
getScrollbackBuffer() - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
 
getSelection() - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminal
Gets the terminal's current selection, this is useful for implementing copy behavior outside of xterm.js.
getSelection() - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
 
getUseSystemClipboard() - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalClipboard
Return whether copy and paste actions use the system clipboard
getXTerm() - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
 

H

hasSelection() - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminal
Gets whether the terminal has an active selection.
hasSelection() - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
 

I

isCopySelection() - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalClipboard
Return whether text is copied to the clipboard when selected.
isEnabled() - Method in class com.flowingcode.vaadin.addons.xterm.TerminalHistory
Gets the enabled state of the history.
isFitOnResize() - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalFit
 
isPasteWithMiddleClick() - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalClipboard
Return whether mouse middle click is handled as a paste action
isPasteWithRightClick() - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalClipboard
Return whether mouse right click is handled as a paste action
ITerminal - Interface in com.flowingcode.vaadin.addons.xterm
The API that represents an xterm.js terminal.
ITerminalClipboard - Interface in com.flowingcode.vaadin.addons.xterm
Add clipboard support to XTerm.
ITerminalClipboard.UseSystemClipboard - Enum in com.flowingcode.vaadin.addons.xterm
 
ITerminalConsole - Interface in com.flowingcode.vaadin.addons.xterm
Add console support to XTerm.
ITerminalConsole.LineEvent - Class in com.flowingcode.vaadin.addons.xterm
 
ITerminalFit - Interface in com.flowingcode.vaadin.addons.xterm
 
ITerminalOptions - Interface in com.flowingcode.vaadin.addons.xterm
Start up options for the terminal.
ITerminalOptions.BellStyle - Enum in com.flowingcode.vaadin.addons.xterm
 
ITerminalOptions.CursorStyle - Enum in com.flowingcode.vaadin.addons.xterm
 
ITerminalOptions.FastScrollModifier - Enum in com.flowingcode.vaadin.addons.xterm
 
ITerminalOptions.RendererType - Enum in com.flowingcode.vaadin.addons.xterm
 
ITerminalSelection - Interface in com.flowingcode.vaadin.addons.xterm
Add selection support to XTerm using arrow keys.

L

LineEvent(XTerm, boolean, String) - Constructor for class com.flowingcode.vaadin.addons.xterm.ITerminalConsole.LineEvent
 

O

of(T) - Static method in class com.flowingcode.vaadin.addons.xterm.TerminalHistory
Returns the command history of the terminal.

P

paste(String) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminal
Writes text to the terminal, performing the necessary transformations for pasted text.
paste(String) - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
 
PreserveStateAddon - Class in com.flowingcode.vaadin.addons.xterm
Add-on which preserves the client-side state when the component is removed from the UI then reattached later on.
PreserveStateAddon(XTerm) - Constructor for class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
 

R

refresh(int, int) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminal
Tells the renderer to refresh terminal content between two rows (inclusive) at the next opportunity.
refresh(int, int) - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
 
reset() - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminal
Perform a full reset (RIS, aka '\x1bc').
reset() - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
 
resize(int, int) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminal
Resizes the terminal.
resize(int, int) - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
 

S

scrollLines(int) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminal
Scroll the display of the terminal
scrollLines(int) - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
 
scrollPages(int) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminal
Scroll the display of the terminal by a number of pages.
scrollPages(int) - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
 
scrollToBottom() - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminal
Scrolls the display of the terminal to the bottom.
scrollToBottom() - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
 
scrollToLine(int) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminal
Scrolls to a line within the buffer.
scrollToLine(int) - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
 
scrollToTop() - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminal
Scrolls the display of the terminal to the top.
scrollToTop() - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
 
select(int, int, int) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminal
Selects text within the terminal.
select(int, int, int) - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
 
selectAll() - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminal
Selects all text within the terminal.
selectAll() - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
 
selectLines(int, int) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminal
Selects text in the buffer between 2 lines.
selectLines(int, int) - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
 
setBellSound(String) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
A data uri of the sound to use for the bell when `bellStyle = 'sound'`.
setBellStyle(ITerminalOptions.BellStyle) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
The type of the bell notification the terminal will use.
setCopySelection(boolean) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalClipboard
Automatically copy to the clipboard the select text.
setCursorBlink(boolean) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
Whether the cursor blinks.
setCursorStyle(ITerminalOptions.CursorStyle) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
The style of the cursor.
setCursorWidth(int) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
The width of the cursor in CSS pixels when `cursorStyle` is set to 'bar'.
setDrawBoldTextInBrightColors(boolean) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
Whether to draw bold text in bright colors.
setEnabled(boolean) - Method in class com.flowingcode.vaadin.addons.xterm.TerminalHistory
Sets the enabled state of the history.
setEnabled(boolean) - Method in class com.flowingcode.vaadin.addons.xterm.XTermBase
 
setFastScrollModifier(ITerminalOptions.FastScrollModifier) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
The modifier key hold to multiply scroll speed.
setFastScrollSensitivity(int) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
The scroll speed multiplier used for fast scrolling.
setFitOnResize(boolean) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalFit
 
setFontFamily(String) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
The font family used to render text.
setFontSize(int) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
The font size used to render text.
setFontWeight(int) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
The font weight used to render non-bold text.
setFontWeightBold(int) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
The font weight used to render bold text.
setInsertMode(boolean) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalConsole
Set the insert mode.
setKeyboardSelectionEnabled(boolean) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalSelection
Sets the command line prompt.
setLetterSpacing(int) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
The spacing in whole pixels between characters..
setLineHeight(int) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
The line height used to render text.
setMacOptionClickForcesSelection(boolean) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
Whether holding a modifier key will force normal selection behavior, regardless of whether the terminal is in mouse events mode.
setMacOptionIsMeta(boolean) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
Whether to treat option as the meta key.
setMaxSize(Integer) - Method in class com.flowingcode.vaadin.addons.xterm.TerminalHistory
Set the number of elements to retain.
setMinimumContrastRatio(int) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
The minimum contrast ratio for text in the terminal, setting this will change the foreground color dynamically depending on whether the contrast ratio is met.
setPasteWithMiddleClick(boolean) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalClipboard
Handle mouse middle click as a paste action
setPasteWithRightClick(boolean) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalClipboard
Handle mouse right click as a paste action
setPrompt(String) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalConsole
Sets the command line prompt.
setPrompt(String) - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
setRendererType(ITerminalOptions.RendererType) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
The type of renderer to use, this allows using the fallback DOM renderer when canvas is too slow for the environment.
setRightClickSelectsWord(boolean) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
Whether to select the word under the cursor on right click, this is standard behavior in a lot of macOS applications.
setScreenReaderMode(boolean) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
Whether screen reader support is enabled.
setScrollback(int) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
The amount of scrollback in the terminal.
setScrollSensitivity(int) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
The scrolling speed multiplier used for adjusting normal scrolling speed.
setTabStopWidth(int) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
The size of tab stops in the terminal.
setTheme(TerminalTheme) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
The color theme of the terminal.
setUseSystemClipboard(ITerminalClipboard.UseSystemClipboard) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalClipboard
Configure the clipboard to write (and optionally read from) the system clipboard
setWordSeparator(String) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
A string containing all characters that are considered word separated by the double click to select work logic.
StateMemoizer - Class in com.flowingcode.vaadin.addons.xterm.utils
Remembers the values passed to all setters.
StateMemoizer(Object, Class<?>...) - Constructor for class com.flowingcode.vaadin.addons.xterm.utils.StateMemoizer
Creates the memoizer.

T

TerminalHistory - Class in com.flowingcode.vaadin.addons.xterm
Manages a command history buffer for XTerm.
TerminalHistory(T) - Constructor for class com.flowingcode.vaadin.addons.xterm.TerminalHistory
 
TerminalTheme - Class in com.flowingcode.vaadin.addons.xterm
The color theme of the terminal.
TerminalTheme() - Constructor for class com.flowingcode.vaadin.addons.xterm.TerminalTheme
 

V

valueOf(String) - Static method in enum com.flowingcode.vaadin.addons.xterm.ITerminalClipboard.UseSystemClipboard
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.flowingcode.vaadin.addons.xterm.ITerminalOptions.BellStyle
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.flowingcode.vaadin.addons.xterm.ITerminalOptions.CursorStyle
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.flowingcode.vaadin.addons.xterm.ITerminalOptions.FastScrollModifier
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.flowingcode.vaadin.addons.xterm.ITerminalOptions.RendererType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.flowingcode.vaadin.addons.xterm.ITerminalClipboard.UseSystemClipboard
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.flowingcode.vaadin.addons.xterm.ITerminalOptions.BellStyle
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.flowingcode.vaadin.addons.xterm.ITerminalOptions.CursorStyle
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.flowingcode.vaadin.addons.xterm.ITerminalOptions.FastScrollModifier
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.flowingcode.vaadin.addons.xterm.ITerminalOptions.RendererType
Returns an array containing the constants of this enum type, in the order they are declared.

W

write(String) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminal
Write data to the terminal.
write(String) - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
 
writeln(String) - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminal
Writes data to the terminal, followed by a break line character (\n).
writeln(String) - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
 
writePrompt() - Method in interface com.flowingcode.vaadin.addons.xterm.ITerminalConsole
Writes the command line prompt to the terminal.
writePrompt() - Method in class com.flowingcode.vaadin.addons.xterm.PreserveStateAddon
 

X

XTerm - Class in com.flowingcode.vaadin.addons.xterm
Server-side component for the XTerm component.
XTerm() - Constructor for class com.flowingcode.vaadin.addons.xterm.XTerm
 
XTermBase - Class in com.flowingcode.vaadin.addons.xterm
Server-side component for the XTerm component.
XTermBase() - Constructor for class com.flowingcode.vaadin.addons.xterm.XTermBase
Constructs a new instance of XTerm
A B C E F G H I L O P R S T V W X 
Skip navigation links

Copyright © 2020–2024 Flowing Code. All rights reserved.