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:

JShellErrorListener, JShellExecListener, com.github.fracpete.processoutput4j.core.StreamingProcessOwner, ImageObserver, MenuContainer, Serializable, Accessible

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

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 javax.swing.JPanel

JPanel.AccessibleJPanel

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_THEME	the default theme.
protected JButton	m_ButtonOutputClear	the button for clearing the output.
protected JButton	m_ButtonOutputSave	the button for saving the output.
protected JButton	m_ButtonScriptLoad	the button for loading a script.
protected JButton	m_ButtonScriptRun	the button for executing a script.
protected JButton	m_ButtonScriptSave	the button for saving as script.
protected JButton	m_ButtonScriptStop	the button for stopping a script.
protected JComboBox<String>	m_ComboBoxThemes	the panel with the themes.
protected List<String>	m_CompilerFlags	additional compiler flags to supply to JShell (-C).
protected JShellExec	m_Exec	for executing 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 Set<JShellPanelListener>	m_JShellPanelListeners	the listeners that listen for changes.
protected List<String>	m_RemoteRuntimeFlags	additional remote runtime flags to supply to JShell (-R).
protected List<String>	m_RuntimeFlags	additional runtime flags to supply to JShell (-J).
protected JSplitPane	m_SplitPane	for splitting code and output.
protected org.fife.ui.rsyntaxtextarea.RSyntaxTextArea	m_TextCode	the text area for the script.
protected JTextArea	m_TextOutput	for the jshell output.
static final String[]	THEMES	the available themes.

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

Constructor Summary

Constructors

Constructor	Description
JShellPanel()

Method Summary

Modifier and Type	Method	Description
void	addJShellExecListener(JShellExecListener l)	Adds the exec listener to the internal list.
void	addJShellPanelListener(JShellPanelListener l)	Adds the panel listener to the internal list.
void	clearScriptOutput()	Clears the output of the script.
protected void	finishInit()	Finishes the initialization.
String	getCode()	Returns the current code.
List<String>	getCompilerFlags()	Returns the compiler flags to supply to JShell (-C).
String	getCurrentTheme()	Returns the currently selected theme.
boolean	getDebug()	Returns the debugging flag.
String	getOutput()	Returns the current output.
com.github.fracpete.processoutput4j.core.StreamingProcessOutputType	getOutputType()	Returns what output from the process to forward.
List<String>	getRemoteRuntimeFlags()	Returns the remote runtime flags to supply to JShell (-R), used by the JVM executing the code (eg -javaagent:...).
List<String>	getRuntimeFlags()	Returns the runtime flags to supply to JShell (-J), used by JShell (eg -verbose).
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	jshellErrorOccurred(JShellErrorEvent e)	Gets called when an error occurred.
void	jshellExecEventOccurred(JShellExecEvent e)	Gets triggered with any event in the JShellPanel.
void	loadScript()	Lets the user select a script to load.
void	loadScript(File script)	Loads the specified file.
static void	main(String[] args)	For testing only.
void	notifyJShellPanelListeners(JShellPanelEvent e)	Notifies all the listeners with the specified panel event.
void	processOutput(String line, boolean stdout)	Processes the incoming line.
void	removeJShellExecListener(JShellExecListener l)	Removes the exec listener to the internal list.
void	removeJShellExecListener(JShellPanelListener l)	Removes the panel 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	setCompilerFlags(List<String> value)	Sets the compiler flags to supply to JShell (-C).
void	setCurrentTheme(String value)	Sets the current theme.
void	setDebug(boolean value)	Sets the debugging flag.
void	setRemoteRuntimeFlags(List<String> value)	Sets the remote runtime flags to supply to JShell (-R), used by the JVM executing the code (eg -javaagent:...).
void	setRuntimeFlags(List<String> value)	Sets the runtime flags to supply to JShell (-J), used by JShell (eg -verbose).
void	stopScript()	Stops a running script.
protected void	updateButtons()	Updates the state of the buttons.
protected boolean	updateTheme()	Updates the theme.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, 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, 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 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, 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.lang.Object

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

Field Details

THEMES

public static final String[] THEMES

the available themes.

DEFAULT_THEME

public static final String DEFAULT_THEME

the default theme.

See Also:

• Constant Field Values

m_SplitPane

protected JSplitPane m_SplitPane

for splitting code and output.

m_ComboBoxThemes

protected JComboBox<String> m_ComboBoxThemes

the panel with the themes.

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 JButton m_ButtonScriptLoad

the button for loading a script.

m_ButtonScriptSave

protected JButton m_ButtonScriptSave

the button for saving as script.

m_ButtonScriptRun

protected JButton m_ButtonScriptRun

the button for executing a script.

m_ButtonScriptStop

protected 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 JButton m_ButtonOutputClear

the button for clearing the output.

m_ButtonOutputSave

protected JButton m_ButtonOutputSave

the button for saving the output.

m_TextOutput

protected JTextArea m_TextOutput

for the jshell output.

m_Exec

protected JShellExec m_Exec

for executing the script.

m_JShellPanelListeners

protected Set<JShellPanelListener> m_JShellPanelListeners

the listeners that listen for changes.

m_RuntimeFlags

protected List<String> m_RuntimeFlags

additional runtime flags to supply to JShell (-J).

m_RemoteRuntimeFlags

protected List<String> m_RemoteRuntimeFlags

additional remote runtime flags to supply to JShell (-R).

m_CompilerFlags

protected List<String> m_CompilerFlags

additional compiler flags to supply to JShell (-C).

Constructor Details

JShellPanel

public JShellPanel()

Method Details

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

updateTheme

protected boolean updateTheme()

Updates the theme.

Returns:

true if successfully applied

setCurrentTheme

public void setCurrentTheme(String value)

Sets the current theme.

Parameters:

value - the theme to use

See Also:

• THEMES

getCurrentTheme

public String getCurrentTheme()

Returns the currently selected theme.

Returns:

the current theme

setDebug

public void setDebug(boolean value)

Sets the debugging flag.

Parameters:

value - true if to turn debugging output on

getDebug

public boolean getDebug()

Returns the debugging flag.

Returns:

true if debugging output on

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(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 String getCode()

Returns the current code.

Returns:

the code

getOutput

public String getOutput()

Returns the current output.

Returns:

the output

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(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

addJShellExecListener

public void addJShellExecListener(JShellExecListener l)

Adds the exec listener to the internal list.

Parameters:

l - the listener to add

removeJShellExecListener

public void removeJShellExecListener(JShellExecListener l)

Removes the exec listener to the internal list.

Parameters:

l - the listener to remove

addJShellPanelListener

public void addJShellPanelListener(JShellPanelListener l)

Adds the panel listener to the internal list.

Parameters:

l - the listener to add

removeJShellExecListener

public void removeJShellExecListener(JShellPanelListener l)

Removes the panel listener to the internal list.

Parameters:

l - the listener to remove

notifyJShellPanelListeners

public void notifyJShellPanelListeners(JShellPanelEvent e)

Notifies all the listeners with the specified panel event.

Parameters:

e - the event to send

jshellErrorOccurred

public void jshellErrorOccurred(JShellErrorEvent e)

Gets called when an error occurred.

Specified by:

jshellErrorOccurred in interface JShellErrorListener

Parameters:

e - the error

jshellExecEventOccurred

public void jshellExecEventOccurred(JShellExecEvent e)

Gets triggered with any event in the JShellPanel.

Specified by:

jshellExecEventOccurred in interface JShellExecListener

Parameters:

e - the event

setRuntimeFlags

public void setRuntimeFlags(List<String> value)

Sets the runtime flags to supply to JShell (-J), used by JShell (eg -verbose).

Parameters:

value - the flags

getRuntimeFlags

public List<String> getRuntimeFlags()

Returns the runtime flags to supply to JShell (-J), used by JShell (eg -verbose).

Returns:

the flags

setRemoteRuntimeFlags

public void setRemoteRuntimeFlags(List<String> value)

Sets the remote runtime flags to supply to JShell (-R), used by the JVM executing the code (eg -javaagent:...).

Parameters:

value - the flags

getRemoteRuntimeFlags

public List<String> getRemoteRuntimeFlags()

Returns the remote runtime flags to supply to JShell (-R), used by the JVM executing the code (eg -javaagent:...).

Returns:

the flags

setCompilerFlags

public void setCompilerFlags(List<String> value)

Sets the compiler flags to supply to JShell (-C).

Parameters:

value - the flags

getCompilerFlags

public List<String> getCompilerFlags()

Returns the compiler flags to supply to JShell (-C).

Returns:

the flags

main

public static void main(String[] args)

For testing only.

Parameters:

args - first argument is interpreted as script