Package com.intellij.util.xml.ui

Class DomFileEditor<T extends BasicDomElementComponent>

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.util.xml.ui.PerspectiveFileEditor

com.intellij.util.xml.ui.DomFileEditor<T>

All Implemented Interfaces:

Disposable, DocumentsEditor, FileEditor, UserDataHolder, UserDataHolderEx, Committable, CommittablePanel, Highlightable

public class DomFileEditor<T extends BasicDomElementComponent>
extends PerspectiveFileEditor
implements CommittablePanel, Highlightable

Nested Class Summary

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

Disposable.Parent

Field Summary

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

PROP_MODIFIED, PROP_VALID

Constructor Summary

Constructors

Constructor and Description
DomFileEditor(DomElement element, java.lang.String name, T component)
DomFileEditor(Project project, VirtualFile file, java.lang.String name, Factory<? extends T> component)
DomFileEditor(Project project, VirtualFile file, java.lang.String name, T component)

Method Summary

Modifier and Type	Method and Description
void	commit()
static BasicDomElementComponent	createComponentWithCaption(CommittablePanel committablePanel, CaptionComponent captionComponent, DomElement element)
protected javax.swing.JComponent	createCustomComponent()
static DomFileEditor	createDomFileEditor(java.lang.String name, javax.swing.Icon icon, DomElement element, Factory<? extends CommittablePanel> committablePanel)
BackgroundEditorHighlighter	getBackgroundHighlighter()
protected T	getDomComponent()
java.lang.String	getName()
javax.swing.JComponent	getPreferredFocusedComponent() Returns component to be focused when editor is opened.
protected DomElement	getSelectedDomElement()
boolean	isValid()
void	reset()
protected void	setSelectedDomElement(DomElement domElement)
void	updateHighlighting()

Methods inherited from class com.intellij.util.xml.ui.PerspectiveFileEditor

addPropertyChangeListener, addWatchedElement, checkIsValid, deselectNotify, dispose, ensureInitialized, getComponent, getCurrentLocation, getDocumentManager, getDocuments, getProject, getPsiFile, getStructureViewBuilder, getVirtualFile, getWrapper, isInitialised, isModified, removePropertyChangeListener, selectNotify, setShowing, setState

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.util.xml.ui.CommittablePanel

getComponent

Methods inherited from interface com.intellij.openapi.Disposable

dispose

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

getFile, getState, setState

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

getUserData, putUserData

Constructor Detail

DomFileEditor

public DomFileEditor(DomElement element,
                     java.lang.String name,
                     T component)

DomFileEditor

public DomFileEditor(Project project,
                     VirtualFile file,
                     java.lang.String name,
                     T component)

DomFileEditor

public DomFileEditor(Project project,
                     VirtualFile file,
                     java.lang.String name,
                     Factory<? extends T> component)

Method Detail

updateHighlighting

public void updateHighlighting()

Specified by:

updateHighlighting in interface Highlightable

commit

public void commit()

Specified by:

commit in interface Committable

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

getDomComponent

protected final T getDomComponent()

createCustomComponent

protected javax.swing.JComponent createCustomComponent()

Specified by:

createCustomComponent in class PerspectiveFileEditor

getName

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

getSelectedDomElement

protected DomElement getSelectedDomElement()

Specified by:

getSelectedDomElement in class PerspectiveFileEditor

setSelectedDomElement

protected void setSelectedDomElement(DomElement domElement)

Specified by:

setSelectedDomElement in class PerspectiveFileEditor

getBackgroundHighlighter

public BackgroundEditorHighlighter getBackgroundHighlighter()

Specified by:

getBackgroundHighlighter in interface FileEditor

Overrides:

getBackgroundHighlighter in class PerspectiveFileEditor

Returns:

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

isValid

public boolean isValid()

Specified by:

isValid in interface FileEditor

Overrides:

isValid in class PerspectiveFileEditor

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.

reset

public void reset()

Specified by:

reset in interface Committable

createDomFileEditor

public static DomFileEditor createDomFileEditor(java.lang.String name,
                                                javax.swing.Icon icon,
                                                DomElement element,
                                                Factory<? extends CommittablePanel> committablePanel)

createComponentWithCaption

public static BasicDomElementComponent createComponentWithCaption(CommittablePanel committablePanel,
                                                                  CaptionComponent captionComponent,
                                                                  DomElement element)