dom/openapi/src/com/intellij/util/xml/ui/PerspectiveFileEditor.java

   1 /*
   2  * Copyright (c) 2000-2006 JetBrains s.r.o. All Rights Reserved.
   3  */
   4
   5 package com.intellij.util.xml.ui;
   6
   7 import com.intellij.codeHighlighting.BackgroundEditorHighlighter;
   8 import com.intellij.ide.structureView.StructureViewBuilder;
   9 import com.intellij.openapi.editor.Document;
  10 import com.intellij.openapi.editor.ScrollType;
  11 import com.intellij.openapi.fileEditor.*;
  12 import com.intellij.openapi.project.Project;
  13 import com.intellij.openapi.util.UserDataHolderBase;
  14 import com.intellij.openapi.vfs.*;
  15 import com.intellij.pom.Navigatable;
  16 import com.intellij.psi.PsiDocumentManager;
  17 import com.intellij.psi.PsiElement;
  18 import com.intellij.psi.PsiFile;
  19 import com.intellij.psi.PsiManager;
  20 import com.intellij.psi.util.PsiTreeUtil;
  21 import com.intellij.psi.xml.XmlTag;
  22 import com.intellij.util.xml.DomElement;
  23 import com.intellij.util.xml.DomManager;
  24 import org.jetbrains.annotations.NotNull;
  25 import org.jetbrains.annotations.Nullable;
  26
  27 import javax.swing.*;
  28 import java.beans.PropertyChangeListener;
  29 import java.beans.PropertyChangeSupport;
  30
  31 /**
  32  * User: Sergey.Vasiliev
  33  */
  34 abstract public class PerspectiveFileEditor extends UserDataHolderBase implements DocumentsEditor, Committable {
  35   private final PropertyChangeSupport myPropertyChangeSupport = new PropertyChangeSupport(this);
  36   private final Project myProject;
  37   private final VirtualFile myFile;
  38   private final UndoHelper myUndoHelper;
  39   private boolean myInvalidated;
  40
  41   private static final FileEditorState FILE_EDITOR_STATE = new FileEditorState() {
  42     public boolean canBeMergedWith(FileEditorState otherState, FileEditorStateLevel level) {
  43       return true;
  44     }
  45   };
  46
  47   protected PerspectiveFileEditor(final Project project, final VirtualFile file) {
  48     myProject = project;
  49     myUndoHelper = new UndoHelper(project, this);
  50     myFile = file;
  51
  52     FileEditorManager.getInstance(myProject).addFileEditorManagerListener(new FileEditorManagerAdapter() {
  53       public void selectionChanged(FileEditorManagerEvent event) {
  54         if (PerspectiveFileEditor.this.equals(event.getOldEditor())) {
  55           deselectNotify();
  56           if (event.getNewEditor() instanceof TextEditor) {
  57             setSelectionInTextEditor((TextEditor)event.getNewEditor(), getSelectedDomElement());
  58           }
  59         }
  60         else if (PerspectiveFileEditor.this.equals(event.getNewEditor())) {
  61           selectNotify();
  62           if (event.getOldEditor() instanceof TextEditor) {
  63             final DomElement element = getSelectedDomElementFromTextEditor((TextEditor)event.getOldEditor());
  64             if (element != null) {
  65               setSelectedDomElement(element);
  66             }
  67           } else if (event.getOldEditor() instanceof PerspectiveFileEditor) {
  68             setSelectedDomElement(((PerspectiveFileEditor)event.getOldEditor()).getSelectedDomElement());
  69           }
  70         }
  71       }
  72     }, this);
  73     //todo[peter] move this listener to DOM
  74     VirtualFileManager.getInstance().addVirtualFileListener(new VirtualFileAdapter() {
  75       public void propertyChanged(VirtualFilePropertyEvent event) {
  76         checkIsValid();
  77       }
  78
  79       public void contentsChanged(VirtualFileEvent event) {
  80         checkIsValid();
  81       }
  82
  83       public void fileCreated(VirtualFileEvent event) {
  84         checkIsValid();
  85       }
  86
  87       public void fileDeleted(VirtualFileEvent event) {
  88         checkIsValid();
  89       }
  90
  91       public void fileMoved(VirtualFileMoveEvent event) {
  92         checkIsValid();
  93       }
  94     }, this);
  95
  96     myUndoHelper.startListeningDocuments();
  97
  98     final PsiFile psiFile = getPsiFile();
  99     if (psiFile != null) {
 100       final Document document = PsiDocumentManager.getInstance(getProject()).getDocument(psiFile);
 101       if (document != null) {
 102         addWatchedDocument(document);
 103       }
 104     }
 105   }
 106
 107   abstract protected DomElement getSelectedDomElement();
 108   abstract protected void setSelectedDomElement(DomElement domElement);
 109
 110   protected boolean isMyFile(VirtualFile file) {
 111     return file.equals(myFile);
 112   }
 113
 114   public final void addWatchedElement(final DomElement domElement) {
 115     addWatchedDocument(getDocumentManager().getDocument(domElement.getRoot().getFile()));
 116   }
 117
 118   public final void removeWatchedElement(final DomElement domElement) {
 119     removeWatchedDocument(getDocumentManager().getDocument(domElement.getRoot().getFile()));
 120   }
 121
 122   public final void addWatchedDocument(final Document document) {
 123     myUndoHelper.addWatchedDocument(document);
 124   }
 125
 126   public final void removeWatchedDocument(final Document document) {
 127     myUndoHelper.removeWatchedDocument(document);
 128   }
 129
 130   protected DomElement getSelectedDomElementFromTextEditor(final TextEditor textEditor) {
 131     final PsiFile psiFile = getPsiFile();
 132     if (psiFile == null) return null;
 133     final PsiElement psiElement = psiFile.findElementAt(textEditor.getEditor().getCaretModel().getOffset());
 134
 135     if(psiElement == null) return null;
 136
 137     final XmlTag xmlTag = PsiTreeUtil.getParentOfType(psiElement, XmlTag.class);
 138
 139     return DomManager.getDomManager(myProject).getDomElement(xmlTag);
 140   }
 141
 142   public void setSelectionInTextEditor(final TextEditor textEditor, final DomElement element) {
 143     if (element != null && element.isValid()) {
 144       final XmlTag tag = element.getXmlTag();
 145       if (tag == null) return;
 146
 147       final PsiFile file = tag.getContainingFile();
 148       if (file == null) return;
 149
 150       final Document document = getDocumentManager().getDocument(file);
 151       if (document == null || !document.equals(textEditor.getEditor().getDocument())) return;
 152
 153       textEditor.getEditor().getCaretModel().moveToOffset(tag.getTextOffset());
 154       textEditor.getEditor().getScrollingModel().scrollToCaret(ScrollType.CENTER);
 155     }
 156   }
 157
 158   protected final PsiDocumentManager getDocumentManager() {
 159     return PsiDocumentManager.getInstance(myProject);
 160   }
 161
 162   @Nullable
 163   public final PsiFile getPsiFile() {
 164     return PsiManager.getInstance(myProject).findFile(myFile);
 165   }
 166
 167   public final Document[] getDocuments() {
 168     return myUndoHelper.getDocuments();
 169   }
 170
 171   public final Project getProject() {
 172     return myProject;
 173   }
 174
 175   public final VirtualFile getVirtualFile() {
 176     return myFile;
 177   }
 178
 179   public void dispose() {
 180     if (myInvalidated) return;
 181     myInvalidated = true;
 182     myUndoHelper.stopListeningDocuments();
 183   }
 184
 185   public final boolean isModified() {
 186     return FileDocumentManager.getInstance().isFileModified(getVirtualFile());
 187   }
 188
 189   public boolean isValid() {
 190     return getVirtualFile().isValid();
 191   }
 192
 193   public void selectNotify() {
 194     myUndoHelper.setShowing(true);
 195     reset();
 196   }
 197
 198   public void deselectNotify() {
 199     if (myInvalidated) return;
 200     myUndoHelper.setShowing(false);
 201     commit();
 202   }
 203
 204   public BackgroundEditorHighlighter getBackgroundHighlighter() {
 205     return null;
 206   }
 207
 208   public FileEditorLocation getCurrentLocation() {
 209     return new FileEditorLocation() {
 210       public FileEditor getEditor() {
 211         return PerspectiveFileEditor.this;
 212       }
 213
 214       public int compareTo(final FileEditorLocation fileEditorLocation) {
 215         return 0;
 216       }
 217     };
 218   }
 219
 220   public StructureViewBuilder getStructureViewBuilder() {
 221     return null;
 222   }
 223
 224   @NotNull
 225   public FileEditorState getState(FileEditorStateLevel level) {
 226     return FILE_EDITOR_STATE;
 227   }
 228
 229   public void setState(FileEditorState state) {
 230   }
 231
 232   public void addPropertyChangeListener(PropertyChangeListener listener) {
 233     myPropertyChangeSupport.addPropertyChangeListener(listener);
 234   }
 235
 236   public void removePropertyChangeListener(PropertyChangeListener listener) {
 237     myPropertyChangeSupport.removePropertyChangeListener(listener);
 238   }
 239
 240   protected final boolean checkIsValid() {
 241     if (!myInvalidated && !isValid()) {
 242       myInvalidated = true;
 243       myPropertyChangeSupport.firePropertyChange(FileEditor.PROP_VALID, Boolean.TRUE, Boolean.FALSE);
 244     }
 245     return !myInvalidated;
 246   }
 247
 248 }