platform/platform-api/src/com/intellij/ide/util/treeView/AbstractTreeNode.java

   1 /*
   2  * Copyright 2000-2009 JetBrains s.r.o.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package com.intellij.ide.util.treeView;
  17
  18 import com.intellij.ide.projectView.PresentationData;
  19 import com.intellij.navigation.NavigationItem;
  20 import com.intellij.openapi.editor.colors.CodeInsightColors;
  21 import com.intellij.openapi.editor.colors.TextAttributesKey;
  22 import com.intellij.openapi.ide.CopyPasteManager;
  23 import com.intellij.openapi.project.Project;
  24 import com.intellij.openapi.util.Comparing;
  25 import com.intellij.openapi.vcs.FileStatus;
  26 import org.jetbrains.annotations.NonNls;
  27 import org.jetbrains.annotations.NotNull;
  28 import org.jetbrains.annotations.Nullable;
  29
  30 import java.awt.*;
  31 import java.util.Collection;
  32
  33 public abstract class AbstractTreeNode<T> extends PresentableNodeDescriptor implements NavigationItem {
  34   private AbstractTreeNode myParent;
  35   private T myValue;
  36   private NodeDescriptor myParentDescriptor;
  37
  38   protected AbstractTreeNode(Project project, T value) {
  39     super(project, null);
  40     setValue(value);
  41   }
  42
  43   @NotNull
  44   public abstract Collection<? extends AbstractTreeNode> getChildren();
  45
  46
  47   protected boolean hasProblemFileBeneath() {
  48     return false;
  49   }
  50
  51   protected boolean valueIsCut() {
  52     return CopyPasteManager.getInstance().isCutElement(getValue());
  53   }
  54
  55   public PresentableNodeDescriptor getChildToHighlightAt(int index) {
  56     final Collection<? extends AbstractTreeNode> kids = getChildren();
  57     int i = 0;
  58     for (final AbstractTreeNode kid : kids) {
  59       if (i == index) return kid;
  60       i++;
  61     }
  62
  63     return null;
  64   }
  65
  66   @Override
  67   protected void postprocess(PresentationData presentation) {
  68     if (hasProblemFileBeneath() ) {
  69       presentation.setAttributesKey(CodeInsightColors.ERRORS_ATTRIBUTES);
  70     }
  71
  72     Color fgColor = getFileStatus().getColor();
  73
  74     if (valueIsCut()) {
  75       fgColor = CopyPasteManager.CUT_COLOR;
  76     }
  77
  78     if (presentation.getForcedTextForeground() == null) {
  79       presentation.setForcedTextForeground(fgColor);
  80     }
  81
  82     if (hasProblemFileBeneath() ) {
  83       presentation.setAttributesKey(CodeInsightColors.ERRORS_ATTRIBUTES);
  84     }
  85   }
  86
  87   protected boolean shouldUpdateData() {
  88     return !myProject.isDisposed() && getValue() != null;
  89   }
  90
  91
  92   public boolean isAlwaysShowPlus() {
  93     return true;
  94   }
  95
  96   public boolean isAlwaysExpand() {
  97     return false;
  98   }
  99
 100   @Nullable
 101   public final Object getElement() {
 102     return getValue() != null ? this : null;
 103   }
 104
 105   public boolean equals(Object object) {
 106     return object instanceof AbstractTreeNode && Comparing.equal(getValue(), ((AbstractTreeNode)object).getValue());
 107   }
 108
 109   public int hashCode() {
 110     return getValue() == null ? 0 : getValue().hashCode();
 111   }
 112
 113   public final AbstractTreeNode getParent() {
 114     return myParent;
 115   }
 116
 117   public final void setParent(AbstractTreeNode parent) {
 118     myParent = parent;
 119     myParentDescriptor = parent;
 120   }
 121
 122   public final AbstractTreeNode setParentDescriptor(NodeDescriptor parentDescriptor) {
 123     myParentDescriptor = parentDescriptor;
 124     return this;
 125   }
 126
 127   public final NodeDescriptor getParentDescriptor() {
 128     return myParentDescriptor;
 129   }
 130
 131   public final T getValue() {
 132     return myValue;
 133   }
 134
 135   public final void setValue(T value) {
 136     myValue = value;
 137   }
 138
 139   @Nullable
 140   @NonNls public String getTestPresentation() {
 141     if (myName != null) {
 142       return myName;
 143     } else if (getValue() != null){
 144       return getValue().toString();
 145     } else {
 146       return null;
 147     }
 148   }
 149
 150
 151   public FileStatus getFileStatus() {
 152     return FileStatus.NOT_CHANGED;
 153   }
 154
 155   public String getName() {
 156     return myName;
 157   }
 158
 159   public void navigate(boolean requestFocus) {
 160   }
 161
 162   public boolean canNavigate() {
 163     return false;
 164   }
 165
 166   public boolean canNavigateToSource() {
 167     return false;
 168   }
 169
 170   @Nullable
 171   protected final Object getParentValue() {
 172     AbstractTreeNode parent = getParent();
 173     return parent == null ? null : parent.getValue();
 174   }
 175
 176
 177   public boolean canRepresent(final Object element) {
 178     return Comparing.equal(getValue(), element);
 179   }
 180
 181   /**
 182    * @deprecated use {@link #getPresentation()} instead
 183    */
 184   protected String getToolTip() {
 185     return getPresentation().getTooltip();
 186   }
 187
 188   /**
 189    * @deprecated use {@link #getPresentation()} instead
 190    */
 191   @Nullable
 192   public TextAttributesKey getAttributesKey() {
 193     return getPresentation().getTextAttributesKey();
 194   }
 195
 196   /**
 197    * @deprecated use {@link #getPresentation()} instead
 198    */
 199   @Nullable
 200   public String getLocationString() {
 201     return getPresentation().getLocationString();
 202   }
 203
 204
 205 }