Package com.intellij.largeFilesEditor.editor

Class LargeFileEditorProvider

java.lang.Object

com.intellij.largeFilesEditor.editor.LargeFileEditorProvider

All Implemented Interfaces:

FileEditorProvider, DefaultPlatformFileEditorProvider, DumbAware

public final class LargeFileEditorProvider
extends java.lang.Object
implements DefaultPlatformFileEditorProvider, DumbAware

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROVIDER_ID

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

EP_FILE_EDITOR_PROVIDER, KEY

Constructor Summary

Constructors

Constructor and Description
LargeFileEditorProvider()

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.
java.lang.String	getEditorTypeId()
FileEditorPolicy	getPolicy()
FileEditorState	readState(Element sourceElement, Project project, VirtualFile file) Deserialize state from the specified sourceElement.
void	writeState(FileEditorState state, Project project, Element targetElement) 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

PROVIDER_ID

public static final java.lang.String PROVIDER_ID

See Also:

Constant Field Values

Constructor Detail

LargeFileEditorProvider

public LargeFileEditorProvider()

Method Detail

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.

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

writeState

public void writeState(FileEditorState state,
                       Project project,
                       Element targetElement)

Description copied from interface: FileEditorProvider

Serializes state into the specified targetElement.

Specified by:

writeState in interface FileEditorProvider

readState

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

Description copied from interface: FileEditorProvider

Deserialize state from the specified sourceElement.

Specified by:

readState in interface FileEditorProvider