Package com.flowingcode.vaadin.addons.xterm

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:

• Serialized Form

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

Constructor	Description
XTermBase()	Constructs a new instance of XTerm

Method Summary

Modifier and Type	Method	Description
Registration	addCustomKeyListener(DomEventListener listener, Key key, KeyLocation location, KeyModifier... modifiers)	Add a server-side key listener.
Registration	addCustomKeyListener(DomEventListener listener, Key key, KeyModifier... modifiers)	Add a server-side key listener.
protected void	executeJs(String expression, Serializable... parameters)
<T extends TerminalAddon> T	getAddon(Class<? extends T> clazz)	Retrieves a registered server-side add-on instance of a specific type.
void	setEnabled(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, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled

Methods 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, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods 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, writeln

Methods 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 of XTerm

Method Details

executeJs

protected void executeJs(String expression,
 Serializable... parameters)

addCustomKeyListener

public Registration addCustomKeyListener(DomEventListener listener,
 Key key,
 KeyModifier... modifiers)

Add a server-side key listener. This method is equivalent to calling addCustomKeyListener(DomEventListener, Key, KeyModifier...) with a KeyLocation of null.

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:

setEnabled in interface HasEnabled

getAddon

public <T extends TerminalAddon> T getAddon(Class<? extends T> clazz)

Retrieves a registered server-side add-on instance of a specific type.

Example usage:

 MySpecificAddon addon = terminal.getAddon(MySpecificAddon.class);
 if (addon != null) {
   addon.doSomethingSpecific();
 }
 

Type Parameters:

T - the type of the add-on to retrieve. This is inferred from the clazz parameter.

Parameters:

clazz - the Class object representing the type of the add-on to retrieve. Must not be null.

Returns:

the registered add-on instance that is of the specified Class<T>, or null if no such add-on is found

Throws:

NullPointerException - if clazz is null