Class XTermBase
java.lang.Object
com.vaadin.flow.component.Component
com.flowingcode.vaadin.addons.xterm.XTermBase
- All Implemented Interfaces:
ITerminal,ITerminalOptions,AttachNotifier,DetachNotifier,HasElement,HasEnabled,HasSize,HasStyle,Serializable
- Direct Known Subclasses:
XTerm
@NpmPackage(value="xterm",
version="5.1.0")
@JsModule("./fc-xterm/xterm-element.ts")
@CssImport("xterm/css/xterm.css")
public abstract class XTermBase
extends Component
implements ITerminal, ITerminalOptions, HasSize, HasEnabled
Server-side component for the XTerm component.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
ITerminalOptions.BellStyle, ITerminalOptions.CursorStyle, ITerminalOptions.FastScrollModifier, ITerminalOptions.RendererType -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddCustomKeyListener(DomEventListener listener, Key key, KeyLocation location, KeyModifier... modifiers) Add a server-side key listener.addCustomKeyListener(DomEventListener listener, Key key, KeyModifier... modifiers) Add a server-side key listener.protected voidexecuteJs(String expression, Serializable... parameters) voidsetEnabled(boolean enabled) Methods inherited from class com.vaadin.flow.component.Component
addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisibleMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListenerMethods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListenerMethods inherited from interface com.vaadin.flow.component.HasElement
getElementMethods inherited from interface com.vaadin.flow.component.HasEnabled
isEnabledMethods inherited from interface com.vaadin.flow.component.HasSize
getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFullMethods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassNameMethods inherited from interface com.flowingcode.vaadin.addons.xterm.ITerminal
blur, clear, clearSelection, focus, getSelection, hasSelection, paste, refresh, reset, resize, scrollLines, scrollPages, scrollToBottom, scrollToLine, scrollToTop, select, selectAll, selectLines, write, writelnMethods inherited from interface com.flowingcode.vaadin.addons.xterm.ITerminalOptions
setBellSound, setBellStyle, setCursorBlink, setCursorStyle, setCursorWidth, setDrawBoldTextInBrightColors, setFastScrollModifier, setFastScrollSensitivity, setFontFamily, setFontSize, setFontWeight, setFontWeightBold, setLetterSpacing, setLineHeight, setMacOptionClickForcesSelection, setMacOptionIsMeta, setMinimumContrastRatio, setRendererType, setRightClickSelectsWord, setScreenReaderMode, setScrollback, setScrollSensitivity, setTabStopWidth, setTheme, setWordSeparator
-
Constructor Details
-
XTermBase
public XTermBase()Constructs a new instance ofXTerm
-
-
Method Details
-
executeJs
-
addCustomKeyListener
public Registration addCustomKeyListener(DomEventListener listener, Key key, KeyModifier... modifiers) Add a server-side key listener. This method is equivalent to callingaddCustomKeyListener(DomEventListener, Key, KeyModifier...)with aKeyLocationofnull.- Returns:
- a registration for the listener.
-
addCustomKeyListener
public Registration addCustomKeyListener(DomEventListener listener, Key key, KeyLocation location, KeyModifier... modifiers) Add a server-side key listener.- Returns:
- a registration for the listener.
-
setEnabled
public void setEnabled(boolean enabled) - Specified by:
setEnabledin interfaceHasEnabled
-