Package org.basex.gui.view.editor

Class EditorView

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
org.basex.gui.layout.BaseXBack
org.basex.gui.layout.BaseXPanel
org.basex.gui.view.View
org.basex.gui.view.editor.EditorView
All Implemented Interfaces:
ComponentListener, KeyListener, MouseListener, MouseMotionListener, MouseWheelListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible
public final class EditorView extends View
This view allows the input and evaluation of queries and documents.
Author:
BaseX Team 2005-21, BSD License, Christian Gruen
See Also:

  • Field Details

    • posCode

      public final GUICode posCode
      Code for setting cursor position.

  • Constructor Details

    • EditorView

      public EditorView(ViewNotifier notifier)
      Default constructor.
      Parameters:
      notifier - view notifier

  • Method Details

    • refreshInit

      public void refreshInit()
      Description copied from class: View
      Called when the data reference has changed.
      Specified by:
      refreshInit in class View

    • refreshFocus

      public void refreshFocus()
      Description copied from class: View
      Called when a new focus has been chosen.
      Specified by:
      refreshFocus in class View

    • refreshMark

      public void refreshMark()
      Description copied from class: View
      Called when a context set has been marked.
      Specified by:
      refreshMark in class View

    • refreshContext

      public void refreshContext(boolean more, boolean quick)
      Description copied from class: View
      Called when a new context set has been chosen.
      Specified by:
      refreshContext in class View
      Parameters:
      more - show more details
      quick - perform a quick context switch

    • refreshLayout

      public void refreshLayout()
      Description copied from class: View
      Called when GUI design has changed.
      Specified by:
      refreshLayout in class View

    • refreshUpdate

      public void refreshUpdate()
      Description copied from class: View
      Called when updates have been done in the data structure.
      Specified by:
      refreshUpdate in class View

    • visible

      public boolean visible()
      Description copied from class: View
      Tests if this view is currently marked as visible.
      Specified by:
      visible in class View
      Returns:
      result of check

    • visible

      public void visible(boolean v)
      Description copied from class: View
      Sets a flag denoting the visibility of the view.
      Specified by:
      visible in class View
      Parameters:
      v - visibility flag

    • db

      protected boolean db()
      Description copied from class: View
      Tests if this view relies on a database instance.
      Specified by:
      db in class View
      Returns:
      result of check

    • refreshContextLabel

      public void refreshContextLabel()
      Refreshes the context label.

    • setContext

      public void setContext(IOFile file)
      Sets an XML document as context.
      Parameters:
      file - file

    • context

      public String context()
      Returns a string describing the current context.
      Returns:
      context string (can be empty)

    • showProject

      public void showProject()
      Shows the project view.

    • toggleProject

      public void toggleProject()
      Toggles the project view.

    • findFiles

      public void findFiles()
      Focuses the project view.

    • focusEditor

      public void focusEditor()
      Focuses the current editor.

    • jumpToFile

      public void jumpToFile()
      Focuses the currently edited file in the project view.

    • tab

      public void tab(boolean next)
      Switches the current editor tab.
      Parameters:
      next - next next/previous tab

    • init

      public void init(ArrayList<IOFile> files)
      Opens previously opened and new files.
      Parameters:
      files - files to be opened

    • open

      public void open()
      Opens a new file.

    • save

      public boolean save()
      Saves the contents of the currently opened editor.
      Returns:
      false if operation was canceled

    • saveAs

      public boolean saveAs()
      Saves the contents of the currently opened editor under a new name.
      Returns:
      false if operation was canceled

    • newFile

      public void newFile()
      Creates a new file.

    • delete

      public boolean delete(IOFile file)
      Deletes a file.
      Parameters:
      file - file to be deleted
      Returns:
      success flag

    • open

      public EditorArea open(IOFile file)
      Opens and parses the specified query file.
      Parameters:
      file - query file
      Returns:
      opened editor or null if file could not be opened

    • closeAll

      public void closeAll()
      Closes all editors.

    • close

      public void close(EditorArea edit)
      Closes an editor.
      Parameters:
      edit - editor to be closed (if null, the currently opened editor will be closed)

    • pleaseWait

      public void pleaseWait(int id)
      Starts a thread, which shows a waiting info after a short timeout.
      Parameters:
      id - thread id

    • info

      public void info(Throwable th, boolean stopped, boolean refresh)
      Processes the result from a command or query execution.
      Parameters:
      th - exception or null
      stopped - true if evaluation was interrupted
      refresh - refresh buttons

    • jump

      public void jump(String link)
      Jumps to the specified file and position.
      Parameters:
      link - link

    • markError

      public void markError(boolean jump)
      Jumps to the current error.
      Parameters:
      jump - jump to error position (if necessary, open file)

    • openFiles

      public String[] openFiles()
      Returns paths of all open files.
      Returns:
      file paths

    • getEditor

      public EditorArea getEditor()
      Returns the current editor.
      Returns:
      editor or null

    • rename

      public void rename(IOFile old, IOFile renamed)
      Updates the references to renamed files.
      Parameters:
      old - old file file reference
      renamed - updated file reference

    • confirm

      public boolean confirm(EditorArea edit)
      Shows a confirmation dialog for the specified editor, or all editors.
      Parameters:
      edit - editor to be saved, or null to save all editors
      Returns:
      true if all editors were confirmed