Package edu.wisc.ssec.mcidasv.ui

Class JythonEditor

java.lang.Object

edu.wisc.ssec.mcidasv.ui.JythonEditor

All Implemented Interfaces:

EventListener, UndoableEditListener

public class JythonEditor
extends Object
implements UndoableEditListener

A bare-bones text editor that can do relatively robust syntax highlighting of Jython code.

This class relies very heavily upon the wonderful RSyntaxTextArea project.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JythonEditor.McvJythonTextArea

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.slf4j.Logger	logger
private final org.fife.ui.rtextarea.RTextScrollPane	scrollPane	Scroll pane for textArea.
private final JythonEditor.McvJythonTextArea	textArea	Text area that contains the syntax-highlighted text.
private final UndoManager	undo	Undo manager.

Constructor Summary

Constructors

Constructor	Description
JythonEditor()	Creates a new JythonEditor.

Method Summary

Modifier and Type	Method	Description
void	addUndoableEditListener(UndoableEditListener l)	Adds the given undoable edit listener to textArea.
void	copy()	Copies selected text into system clipboard.
JPopupMenu	createPopupMenu()	Returns the default JPopupMenu created by RSyntaxTextArea.createPopupMenu().
JPanel	getLineNumberComponent()	Returns the component (aka "the gutter" that contains optional information like line numbers.
JScrollPane	getScrollPane()	Returns the JScrollPane that contains textArea.
String	getText()	Returns a string containing the text of textArea.
JTextComponent	getTextComponent()	Returns the text area responsible for syntax highlighting.
void	insertText(String textToInsert)	Insert the given text at the caret.
boolean	isEnabled()	Whether or not changes can be made to textArea.
void	removeUndoableEditListener(UndoableEditListener l)	Remove the given undoable edit listener from textArea.
void	setEnabled(boolean enabled)	Controls whether or not changes can be made to the contents of textArea.
void	setText(String text)	Sets the text of this document to the given String.
void	undoableEditHappened(UndoableEditEvent e)	Handles undoable edits

Methods inherited from class java.lang.Object

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

Field Details

logger

private static final org.slf4j.Logger logger

textArea

private final JythonEditor.McvJythonTextArea textArea

Text area that contains the syntax-highlighted text.

scrollPane

private final org.fife.ui.rtextarea.RTextScrollPane scrollPane

Scroll pane for textArea.

undo

private final UndoManager undo

Undo manager.

Constructor Details

JythonEditor

public JythonEditor()

Creates a new JythonEditor.

Method Details

getTextComponent

public JTextComponent getTextComponent()

Returns the text area responsible for syntax highlighting.

Returns:

Reference to textArea.

getScrollPane

public JScrollPane getScrollPane()

Returns the JScrollPane that contains textArea.

Returns:

JScrollPane with the text area. Suitable for adding to a JPanel.

setText

public void setText(String text)

Sets the text of this document to the given String.

Parameters:

text - New text to use in textArea.

getText

public String getText()

Returns a string containing the text of textArea.

Returns:

The current contents of the text area.

setEnabled

public void setEnabled(boolean enabled)

Controls whether or not changes can be made to the contents of textArea.

Parameters:

enabled - true if the editor should be enabled, false otherwise.

getLineNumberComponent

public JPanel getLineNumberComponent()

Returns the component (aka "the gutter" that contains optional information like line numbers.

Returns:

JPanel that contains the line numbers.

copy

public void copy()

Copies selected text into system clipboard.

isEnabled

public boolean isEnabled()

Whether or not changes can be made to textArea.

Returns:

true if changes are allowed, false otherwise.

insertText

public void insertText(String textToInsert)

Insert the given text at the caret.

Parameters:

textToInsert - Text to insert.

undoableEditHappened

public void undoableEditHappened(UndoableEditEvent e)

Handles undoable edits

Specified by:

undoableEditHappened in interface UndoableEditListener

Parameters:

e - Event that represents the undoable edit.

addUndoableEditListener

public void addUndoableEditListener(UndoableEditListener l)

Adds the given undoable edit listener to textArea.

Parameters:

l - Listener to add.

removeUndoableEditListener

public void removeUndoableEditListener(UndoableEditListener l)

Remove the given undoable edit listener from textArea.

Parameters:

l - Listener to remove.

createPopupMenu

public JPopupMenu createPopupMenu()

Returns the default JPopupMenu created by RSyntaxTextArea.createPopupMenu().

Returns:

Popup menu.