Package com.intellij.openapi.editor

Class EditorFactory

java.lang.Object

com.intellij.openapi.editor.EditorFactory

Direct Known Subclasses:

EditorFactoryImpl

public abstract class EditorFactory
extends java.lang.Object

Provides services for creating document and editor instances. Creating and releasing of editors must be done from EDT.

Constructor Summary

Constructors

Constructor and Description
EditorFactory()

Method Summary

Modifier and Type	Method and Description
abstract void	addEditorFactoryListener(EditorFactoryListener listener) Deprecated. use the addEditorFactoryListener(EditorFactoryListener, Disposable) instead
abstract void	addEditorFactoryListener(EditorFactoryListener listener, Disposable parentDisposable) Registers a listener for receiving notifications when editor instances are created and released and removes the listener when the parentDisposable gets disposed.
abstract Document	createDocument(char [] text) Creates a document from the specified text specified as an array of characters.
abstract Document	createDocument(java.lang.CharSequence text) Creates a document from the specified text specified as a character sequence.
abstract Editor	createEditor(Document document) Creates an editor for the specified document.
abstract Editor	createEditor(Document document, Project project) Creates an editor for the specified document associated with the specified project.
abstract Editor	createEditor(Document document, Project project, EditorKind kind) Does the same as createEditor(Document, Project) and also sets the special kind for the created editor
abstract Editor	createEditor(Document document, Project project, FileType fileType, boolean isViewer) Creates an editor for the specified document associated with the specified project.
abstract Editor	createEditor(Document document, Project project, VirtualFile file, boolean isViewer) Creates an editor for the specified document associated with the specified project.
abstract Editor	createEditor(Document document, Project project, VirtualFile file, boolean isViewer, EditorKind kind) Does the same as createEditor(Document, Project, VirtualFile, boolean) and also sets the special kind for the created editor
abstract Editor	createViewer(Document document) Creates a read-only editor for the specified document.
abstract Editor	createViewer(Document document, Project project) Creates a read-only editor for the specified document associated with the specified project.
abstract Editor	createViewer(Document document, Project project, EditorKind kind) Does the same as createViewer(Document, Project) and also sets the special kind for the created viewer
abstract Editor []	getAllEditors() Returns the list of all currently open editors.
Editor []	getEditors(Document document) Returns the list of all editors for the specified document.
abstract Editor []	getEditors(Document document, Project project) Returns the list of editors for the specified document associated with the specified project.
abstract EditorEventMulticaster	getEventMulticaster() Returns the service for attaching event listeners to all editor instances.
static EditorFactory	getInstance() Returns the editor factory instance.
abstract void	refreshAllEditors() Reloads the editor settings and refreshes all currently open editors.
abstract void	releaseEditor(Editor editor) Disposes the specified editor instance.
abstract void	removeEditorFactoryListener(EditorFactoryListener listener) Deprecated. you should have used the addEditorFactoryListener(EditorFactoryListener, Disposable) instead

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EditorFactory

public EditorFactory()

Method Detail

getInstance

public static EditorFactory getInstance()

Returns the editor factory instance.

Returns:

the editor factory instance.

createDocument

public abstract Document createDocument(java.lang.CharSequence text)

Creates a document from the specified text specified as a character sequence.

createDocument

public abstract Document createDocument(char [] text)

Creates a document from the specified text specified as an array of characters.

createEditor

public abstract Editor createEditor(Document document)

Creates an editor for the specified document. Must be invoked in EDT.

The created editor must be disposed after use by calling releaseEditor(Editor).

createViewer

public abstract Editor createViewer(Document document)

Creates a read-only editor for the specified document. Must be invoked in EDT.

The created editor must be disposed after use by calling releaseEditor(Editor).

createEditor

public abstract Editor createEditor(Document document,
                                    Project project)

Creates an editor for the specified document associated with the specified project. Must be invoked in EDT.

The created editor must be disposed after use by calling releaseEditor(Editor).

See Also:

Editor.getProject()

createEditor

public abstract Editor createEditor(Document document,
                                    Project project,
                                    EditorKind kind)

Does the same as createEditor(Document, Project) and also sets the special kind for the created editor

createEditor

public abstract Editor createEditor(Document document,
                                    Project project,
                                    FileType fileType,
                                    boolean isViewer)

Creates an editor for the specified document associated with the specified project. Must be invoked in EDT.

The created editor must be disposed after use by calling releaseEditor(Editor).

Parameters:

document - the document to create the editor for.

project - the project for which highlighter should be created

fileType - the file type according to which the editor contents is highlighted.

isViewer - true if read-only editor should be created

See Also:

Editor.getProject()

createEditor

public abstract Editor createEditor(Document document,
                                    Project project,
                                    VirtualFile file,
                                    boolean isViewer)

Creates an editor for the specified document associated with the specified project. Must be invoked in EDT.

The created editor must be disposed after use by calling releaseEditor(Editor).

Parameters:

document - the document to create the editor for.

project - the project for which highlighter should be created

file - the file according to which the editor contents is highlighted.

isViewer - true if read-only editor should be created

Returns:

the editor instance.

See Also:

Editor.getProject()

createEditor

public abstract Editor createEditor(Document document,
                                    Project project,
                                    VirtualFile file,
                                    boolean isViewer,
                                    EditorKind kind)

Does the same as createEditor(Document, Project, VirtualFile, boolean) and also sets the special kind for the created editor

createViewer

public abstract Editor createViewer(Document document,
                                    Project project)

Creates a read-only editor for the specified document associated with the specified project. Must be invoked in EDT.

The created editor must be disposed after use by calling releaseEditor(Editor)

createViewer

public abstract Editor createViewer(Document document,
                                    Project project,
                                    EditorKind kind)

Does the same as createViewer(Document, Project) and also sets the special kind for the created viewer

releaseEditor

public abstract void releaseEditor(Editor editor)

Disposes the specified editor instance. Must be invoked in EDT.

getEditors

public abstract Editor [] getEditors(Document document,
                                     Project project)

Returns the list of editors for the specified document associated with the specified project.

Parameters:

document - the document for which editors are requested.

project - the project with which editors should be associated, or null if any editors for this document should be returned.

getEditors

public Editor [] getEditors(Document document)

Returns the list of all editors for the specified document.

getAllEditors

public abstract Editor [] getAllEditors()

Returns the list of all currently open editors.

addEditorFactoryListener

@Deprecated
public abstract void addEditorFactoryListener(EditorFactoryListener listener)

Deprecated. use the addEditorFactoryListener(EditorFactoryListener, Disposable) instead

Registers a listener for receiving notifications when editor instances are created and released.

addEditorFactoryListener

public abstract void addEditorFactoryListener(EditorFactoryListener listener,
                                              Disposable parentDisposable)

Registers a listener for receiving notifications when editor instances are created and released and removes the listener when the parentDisposable gets disposed.

removeEditorFactoryListener

@Deprecated
public abstract void removeEditorFactoryListener(EditorFactoryListener listener)

Deprecated. you should have used the addEditorFactoryListener(EditorFactoryListener, Disposable) instead

Un-registers a listener for receiving notifications when editor instances are created and released.

getEventMulticaster

public abstract EditorEventMulticaster getEventMulticaster()

Returns the service for attaching event listeners to all editor instances.

refreshAllEditors

public abstract void refreshAllEditors()

Reloads the editor settings and refreshes all currently open editors.