org.youscope.uielements.scripteditor

Class ScriptEditor

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JScrollPane

org.youscope.uielements.scripteditor.ScriptEditor

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.UndoableEditListener, javax.swing.ScrollPaneConstants

public class ScriptEditor
extends javax.swing.JScrollPane
implements javax.swing.event.UndoableEditListener

An editor to edit script files of various types. Supports syntax highlighting and undo/redo actions.

Author:

Moritz Lang

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JScrollPane.AccessibleJScrollPane, javax.swing.JScrollPane.ScrollBar

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

javax.swing.JComponent.AccessibleJComponent

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

columnHeader, horizontalScrollBar, horizontalScrollBarPolicy, lowerLeft, lowerRight, rowHeader, upperLeft, upperRight, verticalScrollBar, verticalScrollBarPolicy, viewport

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

COLUMN_HEADER, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_ALWAYS, HORIZONTAL_SCROLLBAR_AS_NEEDED, HORIZONTAL_SCROLLBAR_NEVER, HORIZONTAL_SCROLLBAR_POLICY, LOWER_LEADING_CORNER, LOWER_LEFT_CORNER, LOWER_RIGHT_CORNER, LOWER_TRAILING_CORNER, ROW_HEADER, UPPER_LEADING_CORNER, UPPER_LEFT_CORNER, UPPER_RIGHT_CORNER, UPPER_TRAILING_CORNER, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_ALWAYS, VERTICAL_SCROLLBAR_AS_NEEDED, VERTICAL_SCROLLBAR_NEVER, VERTICAL_SCROLLBAR_POLICY, VIEWPORT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
ScriptEditor() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addUndoRedoListener(UndoRedoListener listener) Adds a listener which gets informed when an undo/redo event happened.
boolean	canRedo() Returns true if an action can be redone.
boolean	canUndo() Returns true if the last action can be undone.
java.lang.String	getRedoPresentationName() Returns a description of the action which can be redone, if available.
java.lang.String	getText() Returns the current text of the editor (without formatting).
java.lang.String	getUndoPresentationName() Returns a description of the last action which can be undone, if available.
void	redo() Redoes the last action which was undone, if available.
void	removeUndoRedoListener(UndoRedoListener listener) Removes a previously added listener.
void	setErrorInLine(int lineNumber) Marks that in the given line number an error occurred.
void	setFileNameExtension(java.lang.String extension) Sets the extension of the file name which is displayed.
void	setScriptStyleID(java.lang.String scriptStyleID) Searches for a script style with the specific ID and sets the source code formatting of the editor to this style, if found.
void	setText(java.lang.String content) Sets the text which is displayed (without formatting).
void	undo() Undoes the last action, if possible.
void	undoableEditHappened(javax.swing.event.UndoableEditEvent e)

Methods inherited from class javax.swing.JScrollPane

createHorizontalScrollBar, createVerticalScrollBar, createViewport, getAccessibleContext, getColumnHeader, getCorner, getHorizontalScrollBar, getHorizontalScrollBarPolicy, getRowHeader, getUI, getUIClassID, getVerticalScrollBar, getVerticalScrollBarPolicy, getViewport, getViewportBorder, getViewportBorderBounds, isValidateRoot, isWheelScrollingEnabled, paramString, setColumnHeader, setColumnHeaderView, setComponentOrientation, setCorner, setHorizontalScrollBar, setHorizontalScrollBarPolicy, setLayout, setRowHeader, setRowHeaderView, setUI, setVerticalScrollBar, setVerticalScrollBarPolicy, setViewport, setViewportBorder, setViewportView, setWheelScrollingEnabled, 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, 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, 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, getPeer, 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, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, 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

Constructor Detail

ScriptEditor

public ScriptEditor()

Constructor.

Method Detail

undoableEditHappened

public void undoableEditHappened(javax.swing.event.UndoableEditEvent e)

Specified by:

undoableEditHappened in interface javax.swing.event.UndoableEditListener

addUndoRedoListener

public void addUndoRedoListener(UndoRedoListener listener)

Adds a listener which gets informed when an undo/redo event happened.

Parameters:

listener - Listener to be added.

removeUndoRedoListener

public void removeUndoRedoListener(UndoRedoListener listener)

Removes a previously added listener.

Parameters:

listener - Listener to be removed.

undo

public void undo()
          throws javax.swing.undo.CannotUndoException

Undoes the last action, if possible.

Throws:

javax.swing.undo.CannotUndoException

canUndo

public boolean canUndo()

Returns true if the last action can be undone.

Returns:

True if undo is possible.

getUndoPresentationName

public java.lang.String getUndoPresentationName()

Returns a description of the last action which can be undone, if available.

Returns:

Description of last undoable action.

redo

public void redo()
          throws javax.swing.undo.CannotRedoException

Redoes the last action which was undone, if available.

Throws:

javax.swing.undo.CannotRedoException

canRedo

public boolean canRedo()

Returns true if an action can be redone.

Returns:

True if redo is possible.

getRedoPresentationName

public java.lang.String getRedoPresentationName()

Returns a description of the action which can be redone, if available.

Returns:

Description of redo action.

setFileNameExtension

public void setFileNameExtension(java.lang.String extension)

Sets the extension of the file name which is displayed. Activates a search for a suitable code formatting for the file type, and sets this formatting if available, resp. a plain text formatting.

Parameters:

extension - Extension of the file which should be displayed by the editor, or null for plain formatting.

setScriptStyleID

public void setScriptStyleID(java.lang.String scriptStyleID)

Searches for a script style with the specific ID and sets the source code formatting of the editor to this style, if found. Sets the editor to plain text formatting if not found.

Parameters:

scriptStyleID - The ID of the script style, or null for plain formatting.

setText

public void setText(java.lang.String content)

Sets the text which is displayed (without formatting).

Parameters:

content - Content which should be displayed.

getText

public java.lang.String getText()

Returns the current text of the editor (without formatting).

Returns:

Content of the editor.

setErrorInLine

public void setErrorInLine(int lineNumber)

Marks that in the given line number an error occurred.

Parameters:

lineNumber - Index (starting at 0) of the line where the error occurred.