Package com.github.fracpete.jshell

Class JShellPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

nz.ac.waikato.cms.gui.core.BasePanel

com.github.fracpete.jshell.JShellPanel

All Implemented Interfaces:

com.github.fracpete.processoutput4j.core.StreamingProcessOwner, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class JShellPanel
extends nz.ac.waikato.cms.gui.core.BasePanel
implements com.github.fracpete.processoutput4j.core.StreamingProcessOwner

Panel for performing scripting via jshell. Requires Java 9. See https://docs.oracle.com/javase/9/jshell/

Author:

FracPete (fracpete at gmail dot com)

See Also:

Serialized Form

Nested Class Summary

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

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

java.awt.Container.AccessibleAWTContainer

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

javax.swing.JComponent.AccessibleJComponent

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

javax.swing.JPanel.AccessibleJPanel

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.Boolean	m_Available	whether scripting is available.
protected javax.swing.JButton	m_ButtonOutputClear	the button for clearing the output.
protected javax.swing.JButton	m_ButtonOutputSave	the button for saving the output.
protected javax.swing.JButton	m_ButtonScriptLoad	the button for loading a script.
protected javax.swing.JButton	m_ButtonScriptRun	the button for executing a script.
protected javax.swing.JButton	m_ButtonScriptSave	the button for saving as script.
protected javax.swing.JButton	m_ButtonScriptStop	the button for stopping a script.
protected com.github.fracpete.processoutput4j.output.StreamingProcessOutput	m_Execution	executes the script.
protected nz.ac.waikato.cms.gui.core.BaseFileChooser	m_FileChooserOutput	the filechooser for the output.
protected nz.ac.waikato.cms.gui.core.BaseFileChooser	m_FileChooserScript	the filechooser for scripts.
protected java.util.Set<JShellListener>	m_JShellListeners	the listeners that listen for changes.
protected javax.swing.JSplitPane	m_SplitPane	for splitting code and output.
protected org.fife.ui.rsyntaxtextarea.RSyntaxTextArea	m_TextCode	the text area for the script.
protected javax.swing.JTextArea	m_TextOutput	for the jshell output.

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 class javax.swing.JComponent

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

Constructor Summary

Constructors

Constructor	Description
JShellPanel()

Method Summary

Modifier and Type	Method	Description
void	addJShellListener(JShellListener l)	Adds the listener to the internal list.
void	clearScriptOutput()	Clears the output of the script.
protected void	finishInit()	Finishes the initialization.
java.lang.String	getCode()	Returns the current code.
java.lang.String	getExecutable()	Returns the jshell executable.
java.lang.String	getOutput()	Returns the current output.
com.github.fracpete.processoutput4j.core.StreamingProcessOutputType	getOutputType()	Returns what output from the process to forward.
protected void	initGUI()	Initializes the widgets.
protected void	initialize()	Initializes the members.
boolean	isAvailable()	Checks whether jshell executable is available.
boolean	isRunning()	Returns whether a script is currently running.
void	loadScript()	Lets the user select a script to load.
void	loadScript(java.io.File script)	Loads the specified file.
static void	main(java.lang.String[] args)	For testing only.
protected void	notifyJShellListeners(JShellEvent e)	Notifies all the listeners with the specified event.
void	processOutput(java.lang.String line, boolean stdout)	Processes the incoming line.
void	removeJShellListener(JShellListener l)	Removes the listener to the internal list.
void	runScript()	Executes the script.
void	saveScript()	Lets the user save the script to a file.
void	saveScriptOutput()	Lets the user save the script output to a file.
void	stopScript()	Stops a running script.
protected void	updateButtons()	Updates the state of the buttons.

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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, 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.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 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, isValidateRoot, 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, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class java.lang.Object

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

Field Detail

m_Available

protected java.lang.Boolean m_Available

whether scripting is available.

m_SplitPane

protected javax.swing.JSplitPane m_SplitPane

for splitting code and output.

m_TextCode

protected org.fife.ui.rsyntaxtextarea.RSyntaxTextArea m_TextCode

the text area for the script.

m_FileChooserScript

protected nz.ac.waikato.cms.gui.core.BaseFileChooser m_FileChooserScript

the filechooser for scripts.

m_ButtonScriptLoad

protected javax.swing.JButton m_ButtonScriptLoad

the button for loading a script.

m_ButtonScriptSave

protected javax.swing.JButton m_ButtonScriptSave

the button for saving as script.

m_ButtonScriptRun

protected javax.swing.JButton m_ButtonScriptRun

the button for executing a script.

m_ButtonScriptStop

protected javax.swing.JButton m_ButtonScriptStop

the button for stopping a script.

m_FileChooserOutput

protected nz.ac.waikato.cms.gui.core.BaseFileChooser m_FileChooserOutput

the filechooser for the output.

m_ButtonOutputClear

protected javax.swing.JButton m_ButtonOutputClear

the button for clearing the output.

m_ButtonOutputSave

protected javax.swing.JButton m_ButtonOutputSave

the button for saving the output.

m_TextOutput

protected javax.swing.JTextArea m_TextOutput

for the jshell output.

m_Execution

protected transient com.github.fracpete.processoutput4j.output.StreamingProcessOutput m_Execution

executes the script.

m_JShellListeners

protected java.util.Set<JShellListener> m_JShellListeners

the listeners that listen for changes.

Constructor Detail

JShellPanel

public JShellPanel()

Method Detail

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class nz.ac.waikato.cms.gui.core.BasePanel

initGUI

protected void initGUI()

Initializes the widgets.

Overrides:

initGUI in class nz.ac.waikato.cms.gui.core.BasePanel

finishInit

protected void finishInit()

Finishes the initialization.

Overrides:

finishInit in class nz.ac.waikato.cms.gui.core.BasePanel

isRunning

public boolean isRunning()

Returns whether a script is currently running.

Returns:

true if a script is running

updateButtons

protected void updateButtons()

Updates the state of the buttons.

loadScript

public void loadScript()

Lets the user select a script to load.

loadScript

public void loadScript(java.io.File script)

Loads the specified file.

Parameters:

script - the script to load

saveScript

public void saveScript()

Lets the user save the script to a file.

runScript

public void runScript()

Executes the script.

stopScript

public void stopScript()

Stops a running script.

clearScriptOutput

public void clearScriptOutput()

Clears the output of the script.

saveScriptOutput

public void saveScriptOutput()

Lets the user save the script output to a file.

getCode

public java.lang.String getCode()

Returns the current code.

Returns:

the code

getOutput

public java.lang.String getOutput()

Returns the current output.

Returns:

the output

getExecutable

public java.lang.String getExecutable()

Returns the jshell executable.

Returns:

the executable path

isAvailable

public boolean isAvailable()

Checks whether jshell executable is available.

Returns:

true if available

getOutputType

public com.github.fracpete.processoutput4j.core.StreamingProcessOutputType getOutputType()

Returns what output from the process to forward.

Specified by:

getOutputType in interface com.github.fracpete.processoutput4j.core.StreamingProcessOwner

Returns:

the output type

processOutput

public void processOutput(java.lang.String line,
                          boolean stdout)

Processes the incoming line.

Specified by:

processOutput in interface com.github.fracpete.processoutput4j.core.StreamingProcessOwner

Parameters:

line - the line to process

stdout - whether stdout or stderr

addJShellListener

public void addJShellListener(JShellListener l)

Adds the listener to the internal list.

Parameters:

l - the listener to add

removeJShellListener

public void removeJShellListener(JShellListener l)

Removes the listener to the internal list.

Parameters:

l - the listener to remove

notifyJShellListeners

protected void notifyJShellListeners(JShellEvent e)

Notifies all the listeners with the specified event.

Parameters:

e - the event to send

main

public static void main(java.lang.String[] args)

For testing only.

Parameters:

args - first argument is interpreted as script