org.scripthelper.swing.editor

Class EditorScriptWindow

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

org.scripthelper.swing.editor.EditorScriptWindow

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class EditorScriptWindow
extends javax.swing.JFrame

An Editor window which allows to edit a Script.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JFrame.AccessibleJFrame

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

java.awt.Frame.AccessibleAWTFrame

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

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

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

Constructor and Description
EditorScriptWindow(java.io.File scriptFile) Constructor.
EditorScriptWindow(ScriptWrapper wrapper) Constructor.
EditorScriptWindow(java.lang.String title) Constructor.
EditorScriptWindow(java.lang.String title, java.io.File scriptFile) Constructor.
EditorScriptWindow(java.lang.String title, ScriptWrapper wrapper) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addAdditionalEditorActions(javax.swing.JPanel toolbarPane) Add additional editor actions.
void	addScriptEditorListener(ScriptEditorListener listener) Add a ScriptEditorListener.
static void	addSyntaxPack(java.net.URL pack) Add a syntax pack for the code highlighting.
void	dispose()
short	getEditorState() Return the current Editor state.
java.util.List<java.lang.String>	getLines() Return the editor lines.
java.util.List<ScriptEditorListener>	getScriptEditorListeners() Return the list of ScriptEditorListeners.
java.io.File	getScriptFile() Return the script file.
ScriptWrapper	getScriptWrapper() Return the script wrapper.
java.lang.String	getText() Return the text in the editor.
boolean	hasAutoSave() Return the autosave mode.
boolean	save() Save the content of the editor.
void	setAutoSave(boolean autoSave) Set the autosave mode.
void	setScriptFile(java.io.File scriptFile) Set the script file.
void	setScriptWrapper(ScriptWrapper wrapper) Set the script wrapper.

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

Constructor Detail

EditorScriptWindow

public EditorScriptWindow(java.lang.String title)

Constructor.

Parameters:

title - the window title

EditorScriptWindow

public EditorScriptWindow(ScriptWrapper wrapper)

Constructor.

Parameters:

wrapper - the script wrapper

EditorScriptWindow

public EditorScriptWindow(java.lang.String title,
                          ScriptWrapper wrapper)

Constructor.

Parameters:

title - the title

wrapper - the script wrapper

EditorScriptWindow

public EditorScriptWindow(java.lang.String title,
                          java.io.File scriptFile)

Constructor.

Parameters:

title - the title

scriptFile - the script file

EditorScriptWindow

public EditorScriptWindow(java.io.File scriptFile)

Constructor.

Parameters:

scriptFile - the script file

Method Detail

setScriptWrapper

public void setScriptWrapper(ScriptWrapper wrapper)

Set the script wrapper.

Parameters:

wrapper - the script wrapper

setScriptFile

public void setScriptFile(java.io.File scriptFile)

Set the script file.

Parameters:

scriptFile - the script file

setAutoSave

public void setAutoSave(boolean autoSave)

Set the autosave mode.

Parameters:

autoSave - true if the script file will be autosaved if the script has been modified when quitting the editor window.

hasAutoSave

public boolean hasAutoSave()

Return the autosave mode.

Returns:

true if the script file will be autosaved if the script has been modified when quitting the editor window.

addScriptEditorListener

public void addScriptEditorListener(ScriptEditorListener listener)

Add a ScriptEditorListener.

Parameters:

listener - the listener

getScriptEditorListeners

public java.util.List<ScriptEditorListener> getScriptEditorListeners()

Return the list of ScriptEditorListeners.

Returns:

the listeners

dispose

public void dispose()

Overrides:

dispose in class java.awt.Window

getText

public java.lang.String getText()

Return the text in the editor.

Returns:

the text

getScriptFile

public java.io.File getScriptFile()

Return the script file.

Returns:

the script file

getScriptWrapper

public ScriptWrapper getScriptWrapper()

Return the script wrapper.

Returns:

the script wrapper

getEditorState

public short getEditorState()

Return the current Editor state.

Returns:

the editor state

save

public boolean save()

Save the content of the editor.

Returns:

true if the content was saved

addSyntaxPack

public static void addSyntaxPack(java.net.URL pack)

Add a syntax pack for the code highlighting.

Parameters:

pack - the syntax pack (must be a jar file)

getLines

public java.util.List<java.lang.String> getLines()
                                          throws java.io.IOException

Return the editor lines.

Returns:

the lines

Throws:

java.io.IOException - if the source could not be read

addAdditionalEditorActions

protected void addAdditionalEditorActions(javax.swing.JPanel toolbarPane)

Add additional editor actions. Do nothing by default.

Parameters:

toolbarPane - the toolbar