com.dpsframework.util

Class JadeConsole

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JScrollPane

com.dpsframework.util.JadeConsole

All Implemented Interfaces:

bsh.ConsoleInterface, bsh.util.GUIConsoleInterface, java.awt.event.ActionListener, java.awt.event.KeyListener, java.awt.event.MouseListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable, java.lang.Runnable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.ScrollPaneConstants

public class JadeConsole
extends javax.swing.JScrollPane
implements bsh.util.GUIConsoleInterface, java.lang.Runnable, java.awt.event.KeyListener, java.awt.event.MouseListener, java.awt.event.ActionListener, java.beans.PropertyChangeListener

A JFC/Swing Based Console for the BeanShell desktop.

This is a descendant of the old AWTConsole. Improvements by: Mark Donszelmann {Mark.Donszelmann@cern.ch} including Cut and Paste

Improvements by: Daniel Leuck including Color and Image support, key press bug workaround.

Patch by: Francisco Jose Aguayo nameCompletion inside Windows OS.

Since:

2015, update at: 2018-07-15

Version:

1.7 (Build.1814)

Author:

Mark Donszelmann {Mark.Donszelmann@cern.ch}, Daniel Leuck, Adapted by: Francisco J. Aguayo (Leon University / IEEE Power & Energy Systems Society Member)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JadeConsole.BlockingPipedInputStream The overridden read method in this class will not throw "Broken pipe" IOExceptions; It will simply wait for new writers and data.

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

javax.swing.JScrollPane.AccessibleJScrollPane, javax.swing.JScrollPane.ScrollBar

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	asyncMode
int	cmdStart
private static java.lang.String	COPY
private static java.lang.String	CUT
private javax.swing.text.DefaultStyledDocument	doc
private boolean	gotUp
int	histLine
java.util.Vector<java.lang.String>	history
private java.io.InputStream	in
private java.io.InputStream	inPipe
private javax.swing.JPopupMenu	menu
(package private) bsh.util.NameCompletion	nameCompletion
private java.io.PrintStream	out
private java.io.OutputStream	outPipe
private static java.lang.String	PASTE
private static long	serialVersionUID
(package private) int	SHOW_AMBIG_MAX
java.lang.String	startedLine
javax.swing.JTextPane	text
(package private) java.lang.String	ZEROS

Fields inherited from class javax.swing.JScrollPane

columnHeader, horizontalScrollBar, horizontalScrollBarPolicy, lowerLeft, lowerRight, rowHeader, upperLeft, upperRight, verticalScrollBar, verticalScrollBarPolicy, viewport

Fields inherited from class javax.swing.JComponent

accessibleContext, 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

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.ScrollPaneConstants

COLUMN_HEADER, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_ALWAYS, HORIZONTAL_SCROLLBAR_AS_NEEDED, HORIZONTAL_SCROLLBAR_NEVER, HORIZONTAL_SCROLLBAR_POLICY, LOWER_LEADING_CORNER, LOWER_LEFT_CORNER, LOWER_RIGHT_CORNER, LOWER_TRAILING_CORNER, ROW_HEADER, UPPER_LEADING_CORNER, UPPER_LEFT_CORNER, UPPER_RIGHT_CORNER, UPPER_TRAILING_CORNER, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_ALWAYS, VERTICAL_SCROLLBAR_AS_NEEDED, VERTICAL_SCROLLBAR_NEVER, VERTICAL_SCROLLBAR_POLICY, VIEWPORT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
JadeConsole()
JadeConsole(java.io.InputStream cin, java.io.OutputStream cout)

Method Summary

Methods

Modifier and Type	Method and Description
private void	acceptLine(java.lang.String line)
void	actionPerformed(java.awt.event.ActionEvent event)
private void	append(java.lang.String string)
void	clearText()
private void	doCommandCompletion(java.lang.String part)
private void	enter()
void	error(java.lang.Object o)
private void	forceCaretMoveToEnd()
private void	forceCaretMoveToStart()
private java.lang.String	getCmd()
javax.swing.text.DefaultStyledDocument	getDoc()
java.io.PrintStream	getErr()
java.io.Reader	getIn()
java.io.InputStream	getInputStream()
java.io.PrintStream	getOut()
private javax.swing.text.AttributeSet	getStyle()
private void	historyDown()
private void	historyUp()
private void	inPipeWatcher()
private void	invokeAndWait(java.lang.Runnable run) If not in the event thread run via SwingUtilities.invokeAndWait()
boolean	isAsyncMode()
void	keyPressed(java.awt.event.KeyEvent e)
void	keyReleased(java.awt.event.KeyEvent e)
void	keyTyped(java.awt.event.KeyEvent e)
void	mouseClicked(java.awt.event.MouseEvent event)
void	mouseEntered(java.awt.event.MouseEvent event)
void	mouseExited(java.awt.event.MouseEvent event)
void	mousePressed(java.awt.event.MouseEvent event)
void	mouseReleased(java.awt.event.MouseEvent event)
void	print(javax.swing.Icon icon)
void	print(java.lang.Object o)
void	print(java.lang.Object s, java.awt.Color color)
void	print(java.lang.Object s, java.awt.Font font)
void	print(java.lang.Object o, java.awt.Font font, java.awt.Color color)
void	print(java.lang.Object s, java.lang.String fontFamilyName, int size, java.awt.Color color)
void	print(java.lang.Object o, java.lang.String fontFamilyName, int size, java.awt.Color color, boolean bold, boolean italic, boolean underline)
void	println() Prints "\\n" (i.e. newline)
void	println(javax.swing.Icon icon)
void	println(java.lang.Object o)
void	propertyChange(java.beans.PropertyChangeEvent event)
private java.lang.String	replaceRange(java.lang.Object s, int start, int end)
void	requestFocus()
private void	resetCommandStart()
void	run()
void	setAsyncMode(boolean asyncMode)
private javax.swing.text.DefaultStyledDocument	setDoc(javax.swing.text.DefaultStyledDocument doc)
void	setFont(java.awt.Font font)
void	setNameCompletion(bsh.util.NameCompletion nc)
private void	setStyle(javax.swing.text.AttributeSet attributes)
private void	setStyle(javax.swing.text.AttributeSet attributes, boolean overWrite)
private javax.swing.text.AttributeSet	setStyle(java.awt.Color color)
private javax.swing.text.AttributeSet	setStyle(java.awt.Font font)
private javax.swing.text.AttributeSet	setStyle(java.awt.Font font, java.awt.Color color)
private javax.swing.text.AttributeSet	setStyle(java.lang.String fontFamilyName, int size, java.awt.Color color)
private javax.swing.text.AttributeSet	setStyle(java.lang.String fontFamilyName, int size, java.awt.Color color, boolean bold, boolean italic, boolean underline)
void	setWaitFeedback(boolean on)
private void	showHistoryLine()
private int	textLength()
java.lang.String	toString()
private void	type(java.awt.event.KeyEvent e)

Methods inherited from class javax.swing.JScrollPane

createHorizontalScrollBar, createVerticalScrollBar, createViewport, getAccessibleContext, getColumnHeader, getCorner, getHorizontalScrollBar, getHorizontalScrollBarPolicy, getRowHeader, getUI, getUIClassID, getVerticalScrollBar, getVerticalScrollBarPolicy, getViewport, getViewportBorder, getViewportBorderBounds, isValidateRoot, isWheelScrollingEnabled, paramString, setColumnHeader, setColumnHeaderView, setComponentOrientation, setCorner, setHorizontalScrollBar, setHorizontalScrollBarPolicy, setLayout, setRowHeader, setRowHeaderView, setUI, setVerticalScrollBar, setVerticalScrollBarPolicy, setViewport, setViewportBorder, setViewportView, setWheelScrollingEnabled, updateUI

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, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, 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

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, 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, 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, getPeer, 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, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

CUT

private static final java.lang.String CUT

See Also:

Constant Field Values

COPY

private static final java.lang.String COPY

See Also:

Constant Field Values

PASTE

private static final java.lang.String PASTE

See Also:

Constant Field Values

outPipe

private java.io.OutputStream outPipe

inPipe

private java.io.InputStream inPipe

in

private java.io.InputStream in

out

private java.io.PrintStream out

cmdStart

public int cmdStart

history

public java.util.Vector<java.lang.String> history

startedLine

public java.lang.String startedLine

histLine

public int histLine

menu

private javax.swing.JPopupMenu menu

text

public javax.swing.JTextPane text

doc

private javax.swing.text.DefaultStyledDocument doc

nameCompletion

bsh.util.NameCompletion nameCompletion

SHOW_AMBIG_MAX

final int SHOW_AMBIG_MAX

See Also:

Constant Field Values

gotUp

private boolean gotUp

asyncMode

private boolean asyncMode

ZEROS

java.lang.String ZEROS

Constructor Detail

JadeConsole

public JadeConsole()

JadeConsole

public JadeConsole(java.io.InputStream cin,
           java.io.OutputStream cout)

Method Detail

getInputStream

public java.io.InputStream getInputStream()

getIn

public java.io.Reader getIn()

Specified by:

getIn in interface bsh.ConsoleInterface

getOut

public java.io.PrintStream getOut()

Specified by:

getOut in interface bsh.ConsoleInterface

getErr

public java.io.PrintStream getErr()

Specified by:

getErr in interface bsh.ConsoleInterface

requestFocus

public void requestFocus()

Overrides:

requestFocus in class javax.swing.JComponent

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)

Specified by:

keyPressed in interface java.awt.event.KeyListener

keyTyped

public void keyTyped(java.awt.event.KeyEvent e)

Specified by:

keyTyped in interface java.awt.event.KeyListener

keyReleased

public void keyReleased(java.awt.event.KeyEvent e)

Specified by:

keyReleased in interface java.awt.event.KeyListener

type

private void type(java.awt.event.KeyEvent e)

doCommandCompletion

private void doCommandCompletion(java.lang.String part)

resetCommandStart

private void resetCommandStart()

append

private void append(java.lang.String string)

replaceRange

private java.lang.String replaceRange(java.lang.Object s,
                            int start,
                            int end)

forceCaretMoveToEnd

private void forceCaretMoveToEnd()

forceCaretMoveToStart

private void forceCaretMoveToStart()

enter

private void enter()

getCmd

private java.lang.String getCmd()

historyUp

private void historyUp()

historyDown

private void historyDown()

showHistoryLine

private void showHistoryLine()

acceptLine

private void acceptLine(java.lang.String line)

println

public void println(java.lang.Object o)

Specified by:

println in interface bsh.ConsoleInterface

print

public void print(java.lang.Object o)

Specified by:

print in interface bsh.ConsoleInterface

println

public void println()

Prints "\\n" (i.e. newline)

error

public void error(java.lang.Object o)

Specified by:

error in interface bsh.ConsoleInterface

println

public void println(javax.swing.Icon icon)

print

public void print(javax.swing.Icon icon)

print

public void print(java.lang.Object s,
         java.awt.Font font)

print

public void print(java.lang.Object s,
         java.awt.Color color)

Specified by:

print in interface bsh.util.GUIConsoleInterface

print

public void print(java.lang.Object o,
         java.awt.Font font,
         java.awt.Color color)

print

public void print(java.lang.Object s,
         java.lang.String fontFamilyName,
         int size,
         java.awt.Color color)

print

public void print(java.lang.Object o,
         java.lang.String fontFamilyName,
         int size,
         java.awt.Color color,
         boolean bold,
         boolean italic,
         boolean underline)

setStyle

private javax.swing.text.AttributeSet setStyle(java.awt.Font font)

setStyle

private javax.swing.text.AttributeSet setStyle(java.awt.Color color)

setStyle

private javax.swing.text.AttributeSet setStyle(java.awt.Font font,
                                     java.awt.Color color)

setStyle

private javax.swing.text.AttributeSet setStyle(java.lang.String fontFamilyName,
                                     int size,
                                     java.awt.Color color)

setStyle

private javax.swing.text.AttributeSet setStyle(java.lang.String fontFamilyName,
                                     int size,
                                     java.awt.Color color,
                                     boolean bold,
                                     boolean italic,
                                     boolean underline)

setStyle

private void setStyle(javax.swing.text.AttributeSet attributes)

setStyle

private void setStyle(javax.swing.text.AttributeSet attributes,
            boolean overWrite)

getStyle

private javax.swing.text.AttributeSet getStyle()

setFont

public void setFont(java.awt.Font font)

Overrides:

setFont in class javax.swing.JComponent

inPipeWatcher

private void inPipeWatcher()
                    throws java.io.IOException

Throws:

java.io.IOException

run

public void run()

Specified by:

run in interface java.lang.Runnable

toString

public java.lang.String toString()

Overrides:

toString in class java.awt.Component

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent event)

Specified by:

mouseClicked in interface java.awt.event.MouseListener

mousePressed

public void mousePressed(java.awt.event.MouseEvent event)

Specified by:

mousePressed in interface java.awt.event.MouseListener

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent event)

Specified by:

mouseReleased in interface java.awt.event.MouseListener

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent event)

Specified by:

mouseEntered in interface java.awt.event.MouseListener

mouseExited

public void mouseExited(java.awt.event.MouseEvent event)

Specified by:

mouseExited in interface java.awt.event.MouseListener

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent event)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

invokeAndWait

private void invokeAndWait(java.lang.Runnable run)

If not in the event thread run via SwingUtilities.invokeAndWait()

setNameCompletion

public void setNameCompletion(bsh.util.NameCompletion nc)

Specified by:

setNameCompletion in interface bsh.util.GUIConsoleInterface

setWaitFeedback

public void setWaitFeedback(boolean on)

Specified by:

setWaitFeedback in interface bsh.util.GUIConsoleInterface

textLength

private int textLength()

getDoc

public javax.swing.text.DefaultStyledDocument getDoc()

clearText

public void clearText()

setDoc

private javax.swing.text.DefaultStyledDocument setDoc(javax.swing.text.DefaultStyledDocument doc)

isAsyncMode

public boolean isAsyncMode()

setAsyncMode

public void setAsyncMode(boolean asyncMode)