Interface EditorAdapter

All Known Implementing Classes:
BasicEditor

public interface EditorAdapter
Author:
Mik Kersten
  • Method Summary

    Modifier and Type
    Method
    Description
     
    void
    Paste text into the current caret position of the editor.
    void
    Save the contents of the current file being edited.
    void
    showSourceLine​(int lineNumber, boolean highlight)
    Seek the editor to a source line in the current file.
    void
    showSourceLine​(String filePath, int lineNumber, boolean highlight)
    Seek the editor to a source line in the file specified.
    void
    showSourceLine​(ISourceLocation sourceLocation, boolean highlight)
    Seek the editor to a SourceLocation and highlight if specified.
    void
    showSourcelineAnnotation​(String filePath, int lineNumber, List items)
    Implement if inline annotations are supported by the editor.
  • Method Details

    • showSourceLine

      void showSourceLine(String filePath, int lineNumber, boolean highlight)
      Seek the editor to a source line in the file specified.
    • showSourceLine

      void showSourceLine(ISourceLocation sourceLocation, boolean highlight)
      Seek the editor to a SourceLocation and highlight if specified.
    • showSourceLine

      void showSourceLine(int lineNumber, boolean highlight)
      Seek the editor to a source line in the current file.
    • getCurrFile

      String getCurrFile()
      Returns:
      full path to the file currently being edited.
    • saveContents

      void saveContents() throws IOException
      Save the contents of the current file being edited.
      Throws:
      IOException
    • pasteToCaretPos

      void pasteToCaretPos(String text)
      Paste text into the current caret position of the editor.
    • showSourcelineAnnotation

      void showSourcelineAnnotation(String filePath, int lineNumber, List items)
      Implement if inline annotations are supported by the editor. Make null implementation if inline annotations are not supported.
      Parameters:
      filePath - path to the file that should get the annotation
      lineNumber - line number for the annotation
      items - list of relations to be rendered as the annotation