Package org.nuiton.jaxx.widgets.extra.editor

Class RSyntaxEditor

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
org.nuiton.jaxx.widgets.extra.editor.RSyntaxEditor
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.DocumentListener, EditorInterface
public class RSyntaxEditor
extends javax.swing.JPanel
implements EditorInterface, javax.swing.event.DocumentListener
RSyntaxTextArea editor implementation.
Version:
$Revision$ Last update : $Date$ By : $Author$
Author:
chatellier
See Also:
Serialized Form

  • Nested Class Summary

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

    javax.swing.JPanel.AccessibleJPanel

    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
    Modifier and Type Field Description
    protected org.fife.ui.rsyntaxtextarea.RSyntaxTextArea editor  
    protected boolean isModified  

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

  • Method Summary

    Modifier and Type Method Description
    boolean accept​(java.io.File file)
    If return true, this editor support this file type.
    boolean accept​(Editor.EditorSyntaxConstant editorSyntaxConstant)
    If return true, this editor support the syntax type.
    void addCaretListener​(javax.swing.event.CaretListener listener)
    Add caret listener.
    void addDocumentListener​(javax.swing.event.DocumentListener listener)
    Add document listener.
    void changedUpdate​(javax.swing.event.DocumentEvent e)  
    void copy()
    Copy current current selection into system clipboard.
    void cut()
    Cut current editor selection into system clipboard.
    java.lang.String getText()
    Return the current content text of the editor as String.
    void insertUpdate​(javax.swing.event.DocumentEvent e)  
    boolean isModified()
    Indicate if current opened file has been modified.
    boolean open​(java.io.File file)
    Replace the current edited file by file passed in argument.
    void paste()
    Paste current clicboard content into editor at caret position.
    void removeCaretListener​(javax.swing.event.CaretListener listener)
    Remove caret listener.
    void removeDocumentListener​(javax.swing.event.DocumentListener listener)
    Remove document listener.
    void removeUpdate​(javax.swing.event.DocumentEvent e)  
    boolean saveAs​(java.io.File file)
    Replace the current edited file by file passed in argument.
    void setEnabled​(boolean b)
    Enable/disable editor.
    void setSyntax​(Editor.EditorSyntaxConstant editorSyntax)
    Force syntax to use
    void setText​(java.lang.String text)
    Set all text with text in argument.

    Methods inherited from class javax.swing.JPanel

    getAccessibleContext, getUI, getUIClassID, paramString, setUI, 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, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

    • editor

      protected org.fife.ui.rsyntaxtextarea.RSyntaxTextArea editor

    • isModified

      protected boolean isModified

  • Constructor Details

    • RSyntaxEditor

      public RSyntaxEditor()

  • Method Details

    • accept

      public boolean accept​(java.io.File file)
      Description copied from interface: EditorInterface
      If return true, this editor support this file type. Default implementation return true.
      Specified by:
      accept in interface EditorInterface
      Parameters:
      file - file to test
      Returns:
      if return true, this editor support this file type.

    • accept

      public boolean accept​(Editor.EditorSyntaxConstant editorSyntaxConstant)
      Description copied from interface: EditorInterface
      If return true, this editor support the syntax type. Default implementation return true.
      Specified by:
      accept in interface EditorInterface
      Parameters:
      editorSyntaxConstant - syntaxe type to test
      Returns:
      if return true, this editor support this syntax type.

    • setSyntax

      public void setSyntax​(Editor.EditorSyntaxConstant editorSyntax)
      Description copied from interface: EditorInterface
      Force syntax to use
      Specified by:
      setSyntax in interface EditorInterface
      Parameters:
      editorSyntax - to use

    • open

      public boolean open​(java.io.File file)
      Description copied from interface: EditorInterface
      Replace the current edited file by file passed in argument.
      Specified by:
      open in interface EditorInterface
      Parameters:
      file - the file to open
      Returns:
      true if file has been opened

    • addDocumentListener

      public void addDocumentListener​(javax.swing.event.DocumentListener listener)
      Description copied from interface: EditorInterface
      Add document listener.
      Specified by:
      addDocumentListener in interface EditorInterface
      Parameters:
      listener - listener

    • removeDocumentListener

      public void removeDocumentListener​(javax.swing.event.DocumentListener listener)
      Description copied from interface: EditorInterface
      Remove document listener.
      Specified by:
      removeDocumentListener in interface EditorInterface
      Parameters:
      listener - listener

    • addCaretListener

      public void addCaretListener​(javax.swing.event.CaretListener listener)
      Description copied from interface: EditorInterface
      Add caret listener.
      Specified by:
      addCaretListener in interface EditorInterface
      Parameters:
      listener - listener

    • removeCaretListener

      public void removeCaretListener​(javax.swing.event.CaretListener listener)
      Description copied from interface: EditorInterface
      Remove caret listener.
      Specified by:
      removeCaretListener in interface EditorInterface
      Parameters:
      listener - listener

    • getText

      public java.lang.String getText()
      Description copied from interface: EditorInterface
      Return the current content text of the editor as String.
      Specified by:
      getText in interface EditorInterface
      Returns:
      return the current content text of the editor as String

    • isModified

      public boolean isModified()
      Description copied from interface: EditorInterface
      Indicate if current opened file has been modified.
      Specified by:
      isModified in interface EditorInterface
      Returns:
      true if current file is modified

    • saveAs

      public boolean saveAs​(java.io.File file)
      Description copied from interface: EditorInterface
      Replace the current edited file by file passed in argument.
      Specified by:
      saveAs in interface EditorInterface
      Parameters:
      file - the file to open
      Returns:
      true if file has been saved and reopen with new name

    • setText

      public void setText​(java.lang.String text)
      Description copied from interface: EditorInterface
      Set all text with text in argument.
      Specified by:
      setText in interface EditorInterface
      Parameters:
      text - test to set

    • setEnabled

      public void setEnabled​(boolean b)
      Description copied from interface: EditorInterface
      Enable/disable editor.
      Specified by:
      setEnabled in interface EditorInterface
      Overrides:
      setEnabled in class javax.swing.JComponent
      Parameters:
      b - enable

    • changedUpdate

      public void changedUpdate​(javax.swing.event.DocumentEvent e)
      Specified by:
      changedUpdate in interface javax.swing.event.DocumentListener

    • insertUpdate

      public void insertUpdate​(javax.swing.event.DocumentEvent e)
      Specified by:
      insertUpdate in interface javax.swing.event.DocumentListener

    • removeUpdate

      public void removeUpdate​(javax.swing.event.DocumentEvent e)
      Specified by:
      removeUpdate in interface javax.swing.event.DocumentListener

    • copy

      public void copy()
      Description copied from interface: EditorInterface
      Copy current current selection into system clipboard.
      Specified by:
      copy in interface EditorInterface

    • cut

      public void cut()
      Description copied from interface: EditorInterface
      Cut current editor selection into system clipboard.
      Specified by:
      cut in interface EditorInterface

    • paste

      public void paste()
      Description copied from interface: EditorInterface
      Paste current clicboard content into editor at caret position.
      Specified by:
      paste in interface EditorInterface