Package com.intellij.largeFilesEditor.editor

Class LargeFileEditorImpl

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.largeFilesEditor.editor.LargeFileEditorImpl

All Implemented Interfaces:

LargeFileEditor, Disposable, FileEditor, UserDataHolder, UserDataHolderEx

public class LargeFileEditorImpl
extends UserDataHolderBase
implements LargeFileEditor

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields inherited from interface com.intellij.largeFilesEditor.editor.LargeFileEditor

LARGE_FILE_EDITOR_KEY, LARGE_FILE_EDITOR_MARK_KEY

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

PROP_MODIFIED, PROP_VALID

Constructor Summary

Constructors

Constructor and Description
LargeFileEditorImpl(Project project, VirtualFile vFile)

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Removes specified listener
LargeFileEditorAccess	createAccessForEncodingWidget()
void	deselectNotify() This method is invoked each time when the editor is deselected.
void	dispose() Usually not invoked directly, see class javadoc.
BackgroundEditorHighlighter	getBackgroundHighlighter()
long	getCaretPageNumber()
int	getCaretPageOffset()
javax.swing.JComponent	getComponent()
FileEditorLocation	getCurrentLocation() The method is optional.
Editor	getEditor()
EditorModel	getEditorModel()
VirtualFile	getFile()
FileDataProviderForSearch	getFileDataProviderForSearch()
java.lang.String	getName()
javax.swing.JComponent	getPreferredFocusedComponent() Returns component to be focused when editor is opened.
Project	getProject()
LfeSearchManager	getSearchManager()
FileEditorState	getState(FileEditorStateLevel level)
VirtualFile	getVirtualFile()
boolean	isModified()
boolean	isValid()
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Adds specified listener
void	selectNotify() This method is invoked each time when the editor is selected.
void	setState(FileEditorState state) Applies given state to the editor.
void	showSearchResult(SearchResult searchResult)

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

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

getStructureViewBuilder, setState

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Constructor Detail

LargeFileEditorImpl

public LargeFileEditorImpl(Project project,
                           VirtualFile vFile)

Method Detail

getSearchManager

public LfeSearchManager getSearchManager()

Specified by:

getSearchManager in interface LargeFileEditor

getComponent

public javax.swing.JComponent getComponent()

Specified by:

getComponent in interface FileEditor

Returns:

component which represents editor in the UI. The method should never return null.

getPreferredFocusedComponent

public javax.swing.JComponent getPreferredFocusedComponent()

Description copied from interface: FileEditor

Returns component to be focused when editor is opened.

Specified by:

getPreferredFocusedComponent in interface FileEditor

getName

public java.lang.String getName()

Specified by:

getName in interface FileEditor

Returns:

editor's name, a string that identifies editor among other editors. For example, UI form might have two editor: "GUI Designer" and "Text". So "GUI Designer" can be a name of one editor and "Text" can be a name of other editor. The method should never return null.

setState

public void setState(FileEditorState state)

Description copied from interface: FileEditor

Applies given state to the editor.

Specified by:

setState in interface FileEditor

Parameters:

state - cannot be null

getState

public FileEditorState getState(FileEditorStateLevel level)

Specified by:

getState in interface FileEditor

Returns:

editor's internal state. Method should never return null.

isModified

public boolean isModified()

Specified by:

isModified in interface FileEditor

Returns:

whether the editor's content is modified in comparison with its file.

isValid

public boolean isValid()

Specified by:

isValid in interface FileEditor

Returns:

whether the editor is valid or not. An editor is valid if the contents displayed in it still exists. For example, an editor displaying the contents of a file stops being valid if the file is deleted. Editor can also become invalid when it's disposed.

selectNotify

public void selectNotify()

Description copied from interface: FileEditor

This method is invoked each time when the editor is selected. This can happen in two cases: editor is selected because the selected file has been changed or editor for the selected file has been changed.

Specified by:

selectNotify in interface FileEditor

deselectNotify

public void deselectNotify()

Description copied from interface: FileEditor

This method is invoked each time when the editor is deselected.

Specified by:

deselectNotify in interface FileEditor

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Description copied from interface: FileEditor

Removes specified listener

Specified by:

addPropertyChangeListener in interface FileEditor

Parameters:

listener - to be added

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Description copied from interface: FileEditor

Adds specified listener

Specified by:

removePropertyChangeListener in interface FileEditor

Parameters:

listener - to be removed

getBackgroundHighlighter

public BackgroundEditorHighlighter getBackgroundHighlighter()

Specified by:

getBackgroundHighlighter in interface FileEditor

Returns:

highlighter object to perform background analysis and highlighting activities. Return null if no background highlighting activity necessary for this file editor.

getCurrentLocation

public FileEditorLocation getCurrentLocation()

Description copied from interface: FileEditor

The method is optional. Currently is used only by find usages subsystem

Specified by:

getCurrentLocation in interface FileEditor

Returns:

the location of user focus. Typically it's a caret or any other form of selection start.

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

showSearchResult

public void showSearchResult(SearchResult searchResult)

Specified by:

showSearchResult in interface LargeFileEditor

getProject

public Project getProject()

Specified by:

getProject in interface LargeFileEditor

getCaretPageNumber

public long getCaretPageNumber()

Specified by:

getCaretPageNumber in interface LargeFileEditor

getCaretPageOffset

public int getCaretPageOffset()

Specified by:

getCaretPageOffset in interface LargeFileEditor

getEditor

public Editor getEditor()

Specified by:

getEditor in interface LargeFileEditor

getFile

public VirtualFile getFile()

Specified by:

getFile in interface LargeFileEditor

Specified by:

getFile in interface FileEditor

getVirtualFile

public VirtualFile getVirtualFile()

Specified by:

getVirtualFile in interface LargeFileEditor

createAccessForEncodingWidget

public LargeFileEditorAccess createAccessForEncodingWidget()

Specified by:

createAccessForEncodingWidget in interface LargeFileEditor

getFileDataProviderForSearch

public FileDataProviderForSearch getFileDataProviderForSearch()

Specified by:

getFileDataProviderForSearch in interface LargeFileEditor

getEditorModel

public EditorModel getEditorModel()

Specified by:

getEditorModel in interface LargeFileEditor