package bluej.editor;

import java.nio.charset.Charset;
import java.util.function.Supplier;

import bluej.editor.moe.MoeEditorManager;
import bluej.editor.stride.FXTabbedEditor;
import bluej.parser.entity.EntityResolver;
import bluej.pkgmgr.JavadocResolver;
import bluej.utility.javafx.FXPlatformRunnable;
import bluej.utility.javafx.FXSupplier;




| Interface between the editor manager and the rest of BlueJ.
|
| @author  Michael Cahill
| @author  Michael Kolling
| @author  Bruce Quig
|
public abstract class EditorManager
{        
private static EditorManager theEditorManager = new MoeEditorManager();

   
   


| Singleton factory method to return an EditorManager instance;
|
| @returns the singleton EditorManager instance
|
public static EditorManager getEditorManager()
   {        
      return theEditorManager;     
      }

   
   


| Open an editor to display a class. The filename may be "null"
|* to open an empty editor (e.g. for displaying a view). The editor
   * is initially hidden; a call to "Editor.show()" is needed to make
   * it visible after opening it.
   *
   * @param filename     name of the source file to open (may be null)
   * @param docFilename  name of the corresponding javadoc file
   * @param charset      the character set of the file contents
| @param windowTitle  title of window (usually class name)
| @param watcher      an watcher to be notified of edit events
| @param compiled     true, if the class has been compiled
| @param projectResolver   A resolver for external symbols
| @param javadocResolver   A resolver for javadoc on external methods
|
| @return          the new editor, or null if there was a problem
|
public abstract Editor openClass(String filename, 
       
   String docFilename,
       
   Charset charset,
       
   String windowTitle,
       
   FXSupplier<FXTabbedEditor> fxTabbedEditor,
       
   EditorWatcher watcher, 
       
   boolean compiled,
       
   EntityResolver projectResolver,
       
   JavadocResolver javadocResolver, FXPlatformRunnable callbackOnOpen);

   
   


| Open an editor to display a text document. The difference to
| "openClass" is that code specific functions (such as compile,
|* debug, view) are disabled in the editor. The filename may be
   * "null" to open an empty editor. The editor is initially hidden.
   * A call to "Editor::show" is needed to make is visible after
   * opening it.
   *
   * @param filename          name of the source file to open (may be null)
   * @param windowTitle       title of window (usually class name)
| @param watcher           an object interested in editing events
| @returns                 the new editor, or null if there was a problem
|
public abstract Editor openText(String filename, Charset charset, String windowTitle,
                                   
   FXSupplier<FXTabbedEditor> fxTabbedEditor);

   
   


| Indicate to the manager that all resources used by this editor
| should be discarded.
|
protected abstract void discardEditor(Editor ed);

   
   


| Refresh the display of all showing editors (usually because
| an editor property such as font has changed)
|
public abstract void refreshAll(); 
   }