Package com.intellij.openapi.fileEditor

Class TextEditorWithPreview

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.openapi.fileEditor.TextEditorWithPreview

All Implemented Interfaces:

Disposable, FileEditor, UserDataHolder, UserDataHolderEx

Direct Known Subclasses:

EditorConfigEditorWithPreview

public class TextEditorWithPreview
extends UserDataHolderBase
implements FileEditor

Two panel editor with three states: Editor, Preview and Editor with Preview. Based on SplitFileEditor by Valentin Fondaratov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextEditorWithPreview.Layout

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

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
static Key<TextEditorWithPreview.Layout>	DEFAULT_LAYOUT_FOR_FILE
protected TextEditor	myEditor
protected FileEditor	myPreview

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

PROP_MODIFIED, PROP_VALID

Constructor Summary

Constructors

Constructor and Description
TextEditorWithPreview(TextEditor editor, FileEditor preview)
TextEditorWithPreview(TextEditor editor, FileEditor preview, java.lang.String editorName)
TextEditorWithPreview(TextEditor editor, FileEditor preview, java.lang.String editorName, TextEditorWithPreview.Layout defaultLayout)

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Removes specified listener
protected ActionGroup	createLeftToolbarActionGroup()
protected ActionGroup	createRightToolbarActionGroup()
protected ActionToolbar	createToolbar()
protected ActionGroup	createViewActionGroup()
void	deselectNotify() This method is invoked each time when the editor is deselected.
void	dispose() Usually not invoked directly, see class javadoc.
BackgroundEditorHighlighter	getBackgroundHighlighter()
javax.swing.JComponent	getComponent()
FileEditorLocation	getCurrentLocation() The method is optional.
TextEditorWithPreview.Layout	getLayout()
java.lang.String	getName()
javax.swing.JComponent	getPreferredFocusedComponent() Returns component to be focused when editor is opened.
protected ToggleAction	getShowEditorAction()
protected ToggleAction	getShowEditorAndPreviewAction()
protected ToggleAction	getShowPreviewAction()
protected java.lang.String	getSplitterProportionKey()
FileEditorState	getState(FileEditorStateLevel level)
StructureViewBuilder	getStructureViewBuilder()
TextEditor	getTextEditor()
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.

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

getFile, setState

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

getUserData, putUserData

Field Detail

myEditor

protected final TextEditor myEditor

myPreview

protected final FileEditor myPreview

DEFAULT_LAYOUT_FOR_FILE

public static final Key<TextEditorWithPreview.Layout> DEFAULT_LAYOUT_FOR_FILE

Constructor Detail

TextEditorWithPreview

public TextEditorWithPreview(TextEditor editor,
                             FileEditor preview,
                             java.lang.String editorName,
                             TextEditorWithPreview.Layout defaultLayout)

TextEditorWithPreview

public TextEditorWithPreview(TextEditor editor,
                             FileEditor preview,
                             java.lang.String editorName)

TextEditorWithPreview

public TextEditorWithPreview(TextEditor editor,
                             FileEditor preview)

Method Detail

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.

getStructureViewBuilder

public StructureViewBuilder getStructureViewBuilder()

Specified by:

getStructureViewBuilder in interface FileEditor

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

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

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.

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

getSplitterProportionKey

protected java.lang.String getSplitterProportionKey()

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.

getState

public FileEditorState getState(FileEditorStateLevel level)

Specified by:

getState in interface FileEditor

Returns:

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

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

getTextEditor

public TextEditor getTextEditor()

getLayout

public TextEditorWithPreview.Layout getLayout()

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.

createToolbar

protected ActionToolbar createToolbar()

createLeftToolbarActionGroup

protected ActionGroup createLeftToolbarActionGroup()

createViewActionGroup

protected ActionGroup createViewActionGroup()

createRightToolbarActionGroup

protected ActionGroup createRightToolbarActionGroup()

getShowEditorAction

protected ToggleAction getShowEditorAction()

getShowPreviewAction

protected ToggleAction getShowPreviewAction()

getShowEditorAndPreviewAction

protected ToggleAction getShowEditorAndPreviewAction()