at.mug.iqm.api.gui

Class ScriptEditor

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

at.mug.iqm.api.gui.ScriptEditor

All Implemented Interfaces:

ActionListener, WindowListener, ImageObserver, MenuContainer, PropertyChangeListener, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants

public class ScriptEditor
extends JFrame
implements ActionListener, PropertyChangeListener, WindowListener

This class represents the script editor for editing Groovy scripts in IQM.

Since:

3.1

Author:

Philipp Kainz

See Also:

Serialized Form

Nested Class Summary

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

JFrame.AccessibleJFrame

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

Frame.AccessibleAWTFrame

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

Window.AccessibleAWTWindow, Window.Type

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 and Description
private ArrayList<ScriptEditorTab>	allTabs The list holding all ScriptEditorTabs.
private JButton	btnConsole
private JPanel	contentPane
private static ScriptEditor	currentInstance
private String	defaultTitle
private SwingWorker<Void,Void>	executor The executing thread.
private org.fife.rsta.ui.search.FindDialog	findDialog
private GroovyScriptConsoleFrame	frame
private Component	horizontalStrut
private JLabel	lblInfo
private JLabel	lblProcessingIcon
private static org.apache.log4j.Logger	logger
private JMenuItem	mntmClose
private JMenuItem	mntmCopy
private JMenuItem	mntmCut
private JMenuItem	mntmExit
private JMenuItem	mntmFind
private JMenuItem	mntmGoToLine
private JMenuItem	mntmNew
private JMenuItem	mntmOpen
private JMenuItem	mntmPaste
private JMenuItem	mntmRedo
private JMenuItem	mntmReplace
private JMenuItem	mntmSave
private JMenuItem	mntmSaveAll
private JMenuItem	mntmSaveAs
private JMenuItem	mntmUndo
private OutputStreamInterceptor	osi
private PropertyManager	pm
private org.fife.rsta.ui.search.ReplaceDialog	replaceDialog
private static long	serialVersionUID The UID for serialization.
private PrintStream	stdOut
private JTabbedPane	tabbedPane

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ScriptEditor() Create the frame.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e)
void	closeFile() Closes the current file and waits for edits
protected void	disableCancellation() Don't let the user cancel the script using Ctrl+C.
private void	disableF5Running() Disables running a script using the F5 key.
protected void	enableCancellation() Let the user cancel the script using Ctrl+C.
private void	enableF5Running() Enables running the script using the F5 key.
private File	getCurDir()
static ScriptEditor	getInstance() Gets the current instance of the script editor.
ScriptEditorTab	getSelectedTab() Returns the currently selected tab.
int	getTabIndexForFile(File f) Searches for an index in the tabbed pane where the file may already be loaded.
private void	handleRedoAction()
private void	handleUndoAction()
void	initDialogs() Creates the Find and Replace dialogs.
static void	main(String[] args) Launch the application.
int	newTab() Add a new tab.
void	openFile(boolean viaDialog) Opens a file selected by a file chooser, or sets the tab visible, which contains the script
void	openInNewTab(File f) Opens a script file in a new editor tab.
void	propertyChange(PropertyChangeEvent evt)
int	removeTab(ScriptEditorTab tab) Removes the specified tab object.
protected void	runScript() Kicks off the script engine for the selected tab.
private void	save(ScriptEditorTab tab)
void	saveAll() Saves all open tabs either to their specified files or to a new file, if they contain any content
private void	saveAs() Choose a location and save the file as new one in the same tab.
private void	setInitialMenuState()
private void	validateMenuState() Sets the menu state according to the editing state of the text in the currently selected tab.
void	windowActivated(WindowEvent e)
void	windowClosed(WindowEvent e)
void	windowClosing(WindowEvent e)
void	windowDeactivated(WindowEvent e)
void	windowDeiconified(WindowEvent e)
void	windowIconified(WindowEvent e)
void	windowOpened(WindowEvent e)

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, 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.awt.MenuContainer

getFont, postEvent

Field Detail

logger

private static final org.apache.log4j.Logger logger

serialVersionUID

private static final long serialVersionUID

The UID for serialization.

See Also:

Constant Field Values

currentInstance

private static ScriptEditor currentInstance

contentPane

private JPanel contentPane

findDialog

private org.fife.rsta.ui.search.FindDialog findDialog

replaceDialog

private org.fife.rsta.ui.search.ReplaceDialog replaceDialog

pm

private PropertyManager pm

allTabs

private ArrayList<ScriptEditorTab> allTabs

The list holding all ScriptEditorTabs.

defaultTitle

private String defaultTitle

lblInfo

private JLabel lblInfo

mntmSave

private JMenuItem mntmSave

mntmSaveAs

private JMenuItem mntmSaveAs

mntmOpen

private JMenuItem mntmOpen

mntmClose

private JMenuItem mntmClose

mntmExit

private JMenuItem mntmExit

mntmUndo

private JMenuItem mntmUndo

mntmRedo

private JMenuItem mntmRedo

mntmCut

private JMenuItem mntmCut

mntmCopy

private JMenuItem mntmCopy

mntmPaste

private JMenuItem mntmPaste

mntmFind

private JMenuItem mntmFind

mntmReplace

private JMenuItem mntmReplace

mntmGoToLine

private JMenuItem mntmGoToLine

lblProcessingIcon

private JLabel lblProcessingIcon

frame

private GroovyScriptConsoleFrame frame

osi

private OutputStreamInterceptor osi

stdOut

private PrintStream stdOut

executor

private SwingWorker<Void,Void> executor

The executing thread.

btnConsole

private JButton btnConsole

horizontalStrut

private Component horizontalStrut

tabbedPane

private JTabbedPane tabbedPane

mntmNew

private JMenuItem mntmNew

mntmSaveAll

private JMenuItem mntmSaveAll

Constructor Detail

ScriptEditor

private ScriptEditor()

Create the frame.

Method Detail

main

public static void main(String[] args)

Launch the application.

validateMenuState

private void validateMenuState()

Sets the menu state according to the editing state of the text in the currently selected tab.

enableF5Running

private void enableF5Running()

Enables running the script using the F5 key.

disableF5Running

private void disableF5Running()

Disables running a script using the F5 key.

initDialogs

public void initDialogs()

Creates the Find and Replace dialogs.

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

getTabIndexForFile

public int getTabIndexForFile(File f)

Searches for an index in the tabbed pane where the file may already be loaded.

Parameters:

f - the file to search for

Returns:

the index of the tab, where the file is loaded in, or -1, if the file is not yet loaded

openFile

public void openFile(boolean viaDialog)

Opens a file selected by a file chooser, or sets the tab visible, which contains the script

getCurDir

private File getCurDir()

runScript

protected void runScript()

Kicks off the script engine for the selected tab.

disableCancellation

protected void disableCancellation()

Don't let the user cancel the script using Ctrl+C.

enableCancellation

protected void enableCancellation()

Let the user cancel the script using Ctrl+C.

closeFile

public void closeFile()

Closes the current file and waits for edits

save

private void save(ScriptEditorTab tab)

saveAs

private void saveAs()

Choose a location and save the file as new one in the same tab.

setInitialMenuState

private void setInitialMenuState()

getInstance

public static ScriptEditor getInstance()

Gets the current instance of the script editor.

Returns:

the singleton instance

handleUndoAction

private void handleUndoAction()

handleRedoAction

private void handleRedoAction()

openInNewTab

public void openInNewTab(File f)

Opens a script file in a new editor tab.

Parameters:

f - the file to open

newTab

public int newTab()

Add a new tab.

Returns:

the index of the newly constructed tab.

removeTab

public int removeTab(ScriptEditorTab tab)

Removes the specified tab object.

Parameters:

tab - the tab to be removed

Returns:

the integer of the selected tab after removal

getSelectedTab

public ScriptEditorTab getSelectedTab()

Returns the currently selected tab.

Returns:

the ScriptEditorTab

saveAll

public void saveAll()

Saves all open tabs either to their specified files or to a new file, if they contain any content

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener

windowOpened

public void windowOpened(WindowEvent e)

Specified by:

windowOpened in interface WindowListener

windowClosing

public void windowClosing(WindowEvent e)

Specified by:

windowClosing in interface WindowListener

windowClosed

public void windowClosed(WindowEvent e)

Specified by:

windowClosed in interface WindowListener

windowIconified

public void windowIconified(WindowEvent e)

Specified by:

windowIconified in interface WindowListener

windowDeiconified

public void windowDeiconified(WindowEvent e)

Specified by:

windowDeiconified in interface WindowListener

windowActivated

public void windowActivated(WindowEvent e)

Specified by:

windowActivated in interface WindowListener

windowDeactivated

public void windowDeactivated(WindowEvent e)

Specified by:

windowDeactivated in interface WindowListener