Package com.intellij.openapi.fileEditor.impl.text

Class TextEditorProvider

java.lang.Object

com.intellij.openapi.fileEditor.impl.text.TextEditorProvider

All Implemented Interfaces:

FileEditorProvider, DefaultPlatformFileEditorProvider, DumbAware

Direct Known Subclasses:

LargeFileEditorProvider, PsiAwareTextEditorProvider

public class TextEditorProvider
extends java.lang.Object
implements DefaultPlatformFileEditorProvider, DumbAware

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TextEditorProvider.EditorWrapper

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOG

Fields inherited from interface com.intellij.openapi.fileEditor.FileEditorProvider

EP_FILE_EDITOR_PROVIDER, KEY

Constructor Summary

Constructors

Constructor and Description
TextEditorProvider()

Method Summary

Modifier and Type	Method and Description
boolean	accept(Project project, VirtualFile file) Method is expected to run fast.
FileEditor	createEditor(Project project, VirtualFile file) Creates editor for the specified file.
protected TextEditorProvider.EditorWrapper	createWrapperForEditor(Editor editor)
static Document []	getDocuments(FileEditor editor)
java.lang.String	getEditorTypeId()
static TextEditorProvider	getInstance()
FileEditorPolicy	getPolicy()
protected TextEditorState	getStateImpl(Project project, Editor editor, FileEditorStateLevel level)
TextEditor	getTextEditor(Editor editor)
static boolean	isTextFile(VirtualFile file)
FileEditorState	readState(Element element, Project project, VirtualFile file) Deserialize state from the specified sourceElement.
protected void	setStateImpl(Project project, Editor editor, TextEditorState state, boolean exactState)
void	writeState(FileEditorState _state, Project project, Element element) Serializes state into the specified targetElement.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.fileEditor.FileEditorProvider

disposeEditor

Field Detail

LOG

protected static final Logger LOG

Constructor Detail

TextEditorProvider

public TextEditorProvider()

Method Detail

getInstance

public static TextEditorProvider getInstance()

accept

public boolean accept(Project project,
                      VirtualFile file)

Description copied from interface: FileEditorProvider

Method is expected to run fast.

Specified by:

accept in interface FileEditorProvider

file - file to be tested for acceptance.

Returns:

true if provider can create valid editor for the specified file.

createEditor

public FileEditor createEditor(Project project,
                               VirtualFile file)

Description copied from interface: FileEditorProvider

Creates editor for the specified file.

This method is called only if the provider has accepted this file (i.e. method FileEditorProvider.accept(Project, VirtualFile) returned true). The provider should return only valid editor.

Specified by:

createEditor in interface FileEditorProvider

Returns:

created editor for specified file.

readState

public FileEditorState readState(Element element,
                                 Project project,
                                 VirtualFile file)

Description copied from interface: FileEditorProvider

Deserialize state from the specified sourceElement.

Specified by:

readState in interface FileEditorProvider

writeState

public void writeState(FileEditorState _state,
                       Project project,
                       Element element)

Description copied from interface: FileEditorProvider

Serializes state into the specified targetElement.

Specified by:

writeState in interface FileEditorProvider

getEditorTypeId

public java.lang.String getEditorTypeId()

Specified by:

getEditorTypeId in interface FileEditorProvider

Returns:

id of type of the editors created with this FileEditorProvider. Each FileEditorProvider should have unique nonnull id. The id is used for saving/loading of EditorStates.

getPolicy

public FileEditorPolicy getPolicy()

Specified by:

getPolicy in interface FileEditorProvider

Returns:

policy that specifies how editor created via this provider should be opened.

See Also:

FileEditorPolicy.NONE, FileEditorPolicy.HIDE_DEFAULT_EDITOR, FileEditorPolicy.PLACE_BEFORE_DEFAULT_EDITOR

getTextEditor

public TextEditor getTextEditor(Editor editor)

createWrapperForEditor

protected TextEditorProvider.EditorWrapper createWrapperForEditor(Editor editor)

getDocuments

public static Document [] getDocuments(FileEditor editor)

getStateImpl

protected TextEditorState getStateImpl(Project project,
                                       Editor editor,
                                       FileEditorStateLevel level)

isTextFile

public static boolean isTextFile(VirtualFile file)

setStateImpl

protected void setStateImpl(Project project,
                            Editor editor,
                            TextEditorState state,
                            boolean exactState)