Package com.inductiveautomation.snap.swing

Class TextConsole

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.inductiveautomation.snap.swing.TextComponent

com.inductiveautomation.snap.swing.TextArea

com.inductiveautomation.snap.swing.TextConsole

All Implemented Interfaces:

RMTypes, TextTypes, DropTargetListener, ImageObserver, MenuContainer, PropertyChangeListener, Serializable, CharSequence, EventListener, Scrollable

public class TextConsole
extends TextArea

A text area subclass for consoles.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.snap.swing.TextComponent

TextComponent.TextSelection

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Nested classes/interfaces inherited from interface com.inductiveautomation.rm.base.RMTypes

RMTypes.Align, RMTypes.AlignX, RMTypes.AlignY

Nested classes/interfaces inherited from interface com.inductiveautomation.snap.text.TextTypes

TextTypes.TabType

Field Summary

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields inherited from interface com.inductiveautomation.snap.text.TextTypes

TEXT_CHAR_SPACING, TEXT_COLOR, TEXT_FONT, TEXT_FORMAT, TEXT_LINK, TEXT_OUTLINE, TEXT_SCRIPTING, TEXT_UNDERLINE

Constructor Summary

Constructors

Constructor	Description
TextConsole()

Method Summary

Modifier and Type	Method	Description
void	append(String aString)	Appends a string.
void	clearConsole()	Clears the console.
String	executeCommand(String aCommand)	Executes command.
protected String	executeCommandImpl(String aCommand)	Executes command.
String	executeHelp(String aCommand)	Execute a help command.
String	executePrint(String aCommand)	Executes a print command.
String	getInput()	Gets input String from console starting at current input location.
int	getInputLocation()	Returns the location of the end of the last text appended to console.
String	getPrompt()	Returns the prompt.
void	processEnterAction()	Called when enter is hit.
void	processKeyEvent(KeyEvent anEvent)	Handles key events.
void	setCommandHistoryNext()	Sets a command from history.
void	setCommandHistoryPrevious()	Sets a command from history.
void	setPrompt(String aPrompt)	Sets the prompt.

Methods inherited from class com.inductiveautomation.snap.swing.TextArea

appendln, dragEnter, dragExit, dragOver, drop, dropActionChanged, getLineWrap, getPreferredScrollableViewportSize, getPreferredSize, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, setLineWrap, setTextRect

Methods inherited from class com.inductiveautomation.snap.swing.TextComponent

calcPrefHeight, calcPrefWidth, charAt, copy, createText, cut, delete, delete, deleteBackward, deleteForward, deleteToLineEnd, getAlignX, getCharIndex, getCharIndex, getCharSpacing, getColor, getInputLine, getInputStyle, getLine, getLineAt, getLineCount, getLineFor, getLineGap, getLineHeightMax, getLineHeightMin, getLineLast, getLineSpacing, getMargin, getPathForChars, getSel, getSelAnchor, getSelColor, getSelEnd, getSelPath, getSelSize, getSelStart, getString, getText, getTextFont, getTokenAt, getUndoer, getUndoSelection, hideCursor, isSelEmpty, isUnderlined, keyPressed, keyReleased, keyTyped, length, mouseDragged, mousePressed, mouseReleased, paintBackground, paintComponent, paintLine, paintText, paintTextSelection, paintToken, paste, processComponentKeyEvent, processFocusEvent, processMouseEvent, processMouseMotionEvent, propertyChange, redo, replace, replace, selectAll, selectBackward, selectDown, selectForward, selectLineEnd, selectLineStart, selectUp, setAlignX, setBounds, setCharSpacing, setColor, setFont, setInputAttribute, setLineGap, setLineHeightMax, setLineHeightMin, setLineSpacing, setMargin, setRenderingHints, setSel, setSel, setSel, setSource, setString, setSubscript, setSuperscript, setText, setTextFont, setUnderlined, showCursor, subSequence, undo, undoerAddPropertyChange, undoerSaveChanges

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUI, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processKeyBinding, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.CharSequence

chars, codePoints, isEmpty, toString

Constructor Details

TextConsole

public TextConsole()

Method Details

getPrompt

public String getPrompt()

Returns the prompt.

setPrompt

public void setPrompt(String aPrompt)

Sets the prompt.

getInputLocation

public int getInputLocation()

Returns the location of the end of the last text appended to console.

processEnterAction

public void processEnterAction()

Called when enter is hit.

append

public void append(String aString)

Appends a string.

Overrides:

append in class TextArea

getInput

public String getInput()

Gets input String from console starting at current input location.

executeCommand

public String executeCommand(String aCommand)

Executes command.

executeCommandImpl

protected String executeCommandImpl(String aCommand)

Executes command.

executeHelp

public String executeHelp(String aCommand)

Execute a help command.

executePrint

public String executePrint(String aCommand)

Executes a print command.

clearConsole

public void clearConsole()

Clears the console.

setCommandHistoryPrevious

public void setCommandHistoryPrevious()

Sets a command from history.

setCommandHistoryNext

public void setCommandHistoryNext()

Sets a command from history.

processKeyEvent

public void processKeyEvent(KeyEvent anEvent)

Handles key events.

Overrides:

processKeyEvent in class JComponent