Package fr.ifremer.isisfish.ui.widget.text

Class SyntaxEditor

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.fife.rsta.ui.CollapsibleSectionPanel

fr.ifremer.isisfish.ui.widget.text.SyntaxEditorUI

fr.ifremer.isisfish.ui.widget.text.SyntaxEditor

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, CaretListener, DocumentListener, org.fife.rsta.ui.search.SearchListener

public class SyntaxEditor
extends SyntaxEditorUI
implements DocumentListener

Add custom behavior to RSyntaxEditor UI. Like :

• copy/paste
• file change detection

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
protected boolean	askIfNotSaved	Will ask user to perform save on close.
protected JPanel	askReloadPanel	Ask reload file panel (not null if displayed).
protected File	file	Currently edited file.
protected long	lastSaveTimestamp	Timestamp when saved has been performed from editor.
protected boolean	modified	Flag is file has been modified.
protected Action	saveAction	Save action instance.
protected WatchService	watchService	Single watch service instance.
protected Thread	watchThread	Watch service thread.

Fields inherited from class fr.ifremer.isisfish.ui.widget.text.SyntaxEditorUI

copyAction, cutAction, findAction, findDialog, gotoAction, noFileLabel, pasteAction, replaceAction, replaceDialog, textArea, textScrollpane

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

Method Summary

Modifier and Type	Method	Description
void	addDocumentListener(DocumentListener listener)
protected boolean	askAndSaveOrCancel()
void	changedUpdate(DocumentEvent e)
protected void	clearReloadPanel()
boolean	close()
void	copy()
void	cut()
protected void	detectExternalChanges(File file)
protected void	finalize()
Action	getSaveAction()
String	getText()
void	insertUpdate(DocumentEvent e)
boolean	isAskIfNotSaved()
boolean	isModified()
protected void	notifyFileChanged(File file)
boolean	open(File file)
void	paste()
void	removeDocumentListener(DocumentListener listener)
void	removeUpdate(DocumentEvent e)
void	save()
void	setAskIfNotSaved(boolean askIfNotSaved)
protected void	setAutocomplete()	Autocomplete support is not perfect yet and don't support partial classes (equation).
protected void	setFile(File file)
protected void	setModified(boolean modified)

Methods inherited from class fr.ifremer.isisfish.ui.widget.text.SyntaxEditorUI

caretUpdate, getCopyAction, getCutAction, getFindAction, getGotoAction, getPasteAction, getReplaceAction, getSelectedText, initActions, searchEvent, setColumns, setEnabled, setRows, setStyle, setText

Methods inherited from class org.fife.rsta.ui.CollapsibleSectionPanel

addBottomComponent, addBottomComponent, getDisplayedBottomComponent, hideBottomComponent, setAnimationTime, showBottomComponent, updateUI

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI

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, 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, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

askIfNotSaved

protected boolean askIfNotSaved

Will ask user to perform save on close.

file

protected File file

Currently edited file.

modified

protected transient boolean modified

Flag is file has been modified.

lastSaveTimestamp

protected transient long lastSaveTimestamp

Timestamp when saved has been performed from editor.

saveAction

protected Action saveAction

Save action instance.

watchService

protected WatchService watchService

Single watch service instance.

watchThread

protected Thread watchThread

Watch service thread.

askReloadPanel

protected JPanel askReloadPanel

Ask reload file panel (not null if displayed).

Constructor Details

SyntaxEditor

public SyntaxEditor()

Method Details

setAutocomplete

protected void setAutocomplete()

Autocomplete support is not perfect yet and don't support partial classes (equation).

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

isAskIfNotSaved

public boolean isAskIfNotSaved()

setAskIfNotSaved

public void setAskIfNotSaved(boolean askIfNotSaved)

setModified

protected void setModified(boolean modified)

isModified

public boolean isModified()

addDocumentListener

public void addDocumentListener(DocumentListener listener)

removeDocumentListener

public void removeDocumentListener(DocumentListener listener)

open

public boolean open(File file)

askAndSaveOrCancel

protected boolean askAndSaveOrCancel()

close

public boolean close()

setFile

protected void setFile(File file)

save

public void save()

getText

public String getText()

copy

public void copy()

paste

public void paste()

cut

public void cut()

insertUpdate

public void insertUpdate(DocumentEvent e)

Specified by:

insertUpdate in interface DocumentListener

removeUpdate

public void removeUpdate(DocumentEvent e)

Specified by:

removeUpdate in interface DocumentListener

changedUpdate

public void changedUpdate(DocumentEvent e)

Specified by:

changedUpdate in interface DocumentListener

getSaveAction

public Action getSaveAction()

clearReloadPanel

protected void clearReloadPanel()

detectExternalChanges

protected void detectExternalChanges(File file)

notifyFileChanged

protected void notifyFileChanged(File file)