Package com.intellij.designer

Class DesignerEditor

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.designer.DesignerEditor

All Implemented Interfaces:

Disposable, FileEditor, UserDataHolder, UserDataHolderEx

public abstract class DesignerEditor
extends UserDataHolderBase
implements FileEditor

Nested Class Summary

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

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
protected DesignerEditorPanel	myDesignerPanel

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

PROP_MODIFIED, PROP_VALID

Constructor Summary

Constructors

Constructor and Description
DesignerEditor(Project project, VirtualFile file)

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Removes specified listener
protected abstract DesignerEditorPanel	createDesignerPanel(Project project, Module module, VirtualFile file)
void	deselectNotify() This method is invoked each time when the editor is deselected.
void	dispose() Usually not invoked directly, see class javadoc.
protected abstract Module	findModule(Project project, VirtualFile file)
javax.swing.JComponent	getComponent()
FileEditorLocation	getCurrentLocation() The method is optional.
DesignerEditorPanel	getDesignerPanel()
java.lang.String	getName()
javax.swing.JComponent	getPreferredFocusedComponent() Returns component to be focused when editor is opened.
FileEditorState	getState(FileEditorStateLevel level)
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

getBackgroundHighlighter, getFile, getStructureViewBuilder, setState

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

getUserData, putUserData

Field Detail

myDesignerPanel

protected final DesignerEditorPanel myDesignerPanel

Constructor Detail

DesignerEditor

public DesignerEditor(Project project,
                      VirtualFile file)

Method Detail

findModule

protected abstract Module findModule(Project project,
                                     VirtualFile file)

createDesignerPanel

protected abstract DesignerEditorPanel createDesignerPanel(Project project,
                                                           Module module,
                                                           VirtualFile file)

getDesignerPanel

public final DesignerEditorPanel getDesignerPanel()

getComponent

public final 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 final 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.

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

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.

isModified

public boolean isModified()

Specified by:

isModified in interface FileEditor

Returns:

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

getState

public FileEditorState getState(FileEditorStateLevel level)

Specified by:

getState in interface FileEditor

Returns:

editor's internal state. 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

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

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.