[editor-ui-api] fix deprecation problems

GitOrigin-RevId: 8378c8ce27b453673250d38793e1ded90413caab
2026-09-27 10:03:11 +07:00 · 2019-06-13 17:14:49 +03:00
parent 5cdcacc996
commit 96952b1a12
14 changed files with 66 additions and 55 deletions
@@ -1,18 +1,4 @@
-/*
- * Copyright 2000-2015 JetBrains s.r.o.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+// Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
 package com.intellij.codeHighlighting;

 import org.jetbrains.annotations.NotNull;
@@ -21,6 +7,9 @@ public interface BackgroundEditorHighlighter {
  @NotNull
  HighlightingPass[] createPassesForEditor();

+  /**
+   * @deprecated unused
+   */
  @Deprecated
  @NotNull
  HighlightingPass[] createPassesForVisibleArea();
@@ -1,5 +1,5 @@
 /*
- * Copyright 2000-2015 JetBrains s.r.o.
+ * Copyright 2000-2019 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -23,11 +23,14 @@ import java.util.Collections;
 import java.util.Set;

 /**
- * This interface specifies that the element corresponds to several virtual files.
+ * Specifies that the element corresponds to several virtual files.
 * For example, a package may correspond to several folders in a project,
 * or a resource bundle may correspond to several properties files.
 */
 public interface RootsProvider {
+  /**
+   * @deprecated use {@link Collections#emptySet()}
+   */
  @Deprecated
  Set<VirtualFile> EMPTY_ROOTS = Collections.emptySet();

@@ -1,27 +1,12 @@
-/*
- * Copyright 2000-2015 JetBrains s.r.o.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+// Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
 package com.intellij.ide.ui;

-// Use AntialiasingType instead
+/**
+ * @deprecated use {@link AntialiasingType} instead
+ */
@Deprecated
 public enum LCDRenderingScope {
-  @Deprecated
  IDE,
-  @Deprecated
  EXCLUDING_EDITOR,
-  @Deprecated
  OFF
 }
@@ -1,5 +1,5 @@
 /*
- * Copyright 2000-2015 JetBrains s.r.o.
+ * Copyright 2000-2019 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -31,7 +31,7 @@ public abstract class NodeDescriptor<E> {
  @Nullable protected Icon myClosedIcon;

  /**
-   * Unused. It's there only for API compatibility.
+   * @deprecated Unused. Left for API compatibility.
   */
  @Deprecated
  protected Icon myOpenIcon;
@@ -80,7 +80,7 @@ public abstract class NodeDescriptor<E> {
  }

  /**
-   Use #getIcon() instead
+   * @deprecated Use {@link #getIcon()} instead
   */
  @Deprecated
  public final Icon getOpenIcon() {
@@ -88,7 +88,7 @@ public abstract class NodeDescriptor<E> {
  }

  /**
-   Use #getIcon() instead
+   * @deprecated Use {@link #getIcon()} instead
   */
  @Deprecated
  public final Icon getClosedIcon() {
@@ -152,7 +152,7 @@ public abstract class ActionManager {
                                              @Nullable String place, boolean now);

  /**
-   * Use {@link AnActionListener#TOPIC}
+   * @deprecated Use {@link AnActionListener#TOPIC}
   */
  @Deprecated
  public abstract void addAnActionListener(AnActionListener listener);
@@ -165,6 +165,9 @@ public abstract class ActionManager {
    ApplicationManager.getApplication().getMessageBus().connect(parentDisposable).subscribe(AnActionListener.TOPIC, listener);
  }

+  /**
+   * @deprecated Use {@link AnActionListener#TOPIC}
+   */
  @Deprecated
  public abstract void removeAnActionListener(AnActionListener listener);

@@ -1,4 +1,4 @@
-// Copyright 2000-2018 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
+// Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
 package com.intellij.openapi.actionSystem;

 import com.intellij.ide.DataManager;
@@ -75,6 +75,9 @@ public class AnActionEvent implements PlaceProvider<String> {
  }


+  /**
+   * @deprecated use {@link #createFromInputEvent(InputEvent, String, Presentation, DataContext, boolean, boolean)}
+   */
  @Deprecated
  @NotNull
  public static AnActionEvent createFromInputEvent(@NotNull AnAction action, @Nullable InputEvent event, @NotNull String place) {
@@ -40,7 +40,7 @@ public interface FoldingModel {
  FoldRegion addFoldRegion(int startOffset, int endOffset, @NotNull String placeholderText);

  /**
-   * Do nothing
+   * @deprecated Does nothing
   * TODO to remove in IDEA 2018
   */
  @Deprecated
@@ -1,5 +1,5 @@
 /*
- * Copyright 2000-2014 JetBrains s.r.o.
+ * Copyright 2000-2019 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -20,8 +20,8 @@ import org.jetbrains.annotations.NotNull;

 /**
 * Defines whether or not some elements can be indented when a user selects a fragment of text and invokes "indent" action (normally by
- * pressing [TAB]). The elements which are said to be unmovable (canIndent() returns false) do not change their indentation. This may be
- * useful for cases like HEREDOC text handling.
+ * pressing [TAB]). The elements which are said to be unmovable ({@link #canIndent(int, int, PsiElement)} returns {@code false}) do not change their indentation.
+ * This may be useful for cases like HEREDOC text handling.
 *
 * @author Rustam Vishnyakov
 */
@@ -29,7 +29,9 @@ public interface IndentStrategy {
  /**
   * @deprecated use {@link #canIndent(int, int, PsiElement)}
   */
-  default boolean canIndent(@NotNull PsiElement element) {
+  @SuppressWarnings("DeprecatedIsStillUsed")
+  @Deprecated
+  default boolean canIndent(@SuppressWarnings("unused") @NotNull PsiElement element) {
    return true;
  }

@@ -39,6 +39,9 @@ public interface EditorColors {
  TextAttributesKey DELETED_TEXT_ATTRIBUTES = TextAttributesKey.createTextAttributesKey("DELETED_TEXT_ATTRIBUTES");

  ColorKey GUTTER_BACKGROUND = ColorKey.createColorKey("GUTTER_BACKGROUND", new JBColor(0xf0f0f0, 0x313335));
+  /**
+   * @deprecated use {@link #GUTTER_BACKGROUND}
+   */
  @Deprecated ColorKey LEFT_GUTTER_BACKGROUND = GUTTER_BACKGROUND;
  ColorKey NOTIFICATION_BACKGROUND = ColorKey.createColorKey("NOTIFICATION_BACKGROUND");

@@ -1,5 +1,5 @@
 /*
- * Copyright 2000-2016 JetBrains s.r.o.
+ * Copyright 2000-2019 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -38,6 +38,9 @@ public abstract class EditorColorsManager {

  public abstract void addColorsScheme(@NotNull EditorColorsScheme scheme);

+  /**
+   * @deprecated Does nothing, left for API compatibility.
+   */
  @Deprecated
  public abstract void removeAllSchemes();

@@ -58,9 +58,15 @@ public interface EditorColorsScheme extends Cloneable, TextAttributesScheme, Sch
   */
  void setEditorFontSize(int fontSize);

+  /**
+   * @deprecated stored in application level property
+   */
  @Deprecated
  FontSize getQuickDocFontSize();

+  /**
+   * @deprecated stored in application level property
+   */
  @Deprecated
  void setQuickDocFontSize(@NotNull FontSize fontSize);

@@ -32,12 +32,13 @@ public interface SyntaxHighlighter {
  ExtensionPointName<KeyedFactoryEPBean> EP_NAME = ExtensionPointName.create("com.intellij.syntaxHighlighter");

  /**
-   * @deprecated
-   * @see SyntaxHighlighterFactory#getSyntaxHighlighter(com.intellij.openapi.project.Project, com.intellij.openapi.vfs.VirtualFile)
-   * @see SyntaxHighlighterFactory#getSyntaxHighlighter(com.intellij.lang.Language, com.intellij.openapi.project.Project, com.intellij.openapi.vfs.VirtualFile)
+   * @deprecated see
+   * {@link SyntaxHighlighterFactory#getSyntaxHighlighter(com.intellij.openapi.project.Project, com.intellij.openapi.vfs.VirtualFile)} and
+   * {@link SyntaxHighlighterFactory#getSyntaxHighlighter(com.intellij.lang.Language, com.intellij.openapi.project.Project, com.intellij.openapi.vfs.VirtualFile)}
   */
-  @Deprecated SyntaxHighlighterProvider PROVIDER =
-    new FileTypeExtensionFactory<>(SyntaxHighlighterProvider.class, EP_NAME).get();
+  @SuppressWarnings("DeprecatedIsStillUsed")
+  @Deprecated
+  SyntaxHighlighterProvider PROVIDER = new FileTypeExtensionFactory<>(SyntaxHighlighterProvider.class, EP_NAME).get();

  /**
   * Returns the lexer used for highlighting the file. The lexer is invoked incrementally when the file is changed, so it must be
@@ -1,5 +1,5 @@
 /*
- * Copyright 2000-2016 JetBrains s.r.o.
+ * Copyright 2000-2019 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -23,12 +23,19 @@ import java.awt.*;

@SuppressWarnings("UseJBColor")
 public interface FileStatus {
+  /** @deprecated use {@link FileStatus#getColor} */
  @Deprecated Color COLOR_MERGE = new Color(117, 3, 220);
+  /** @deprecated use {@link FileStatus#getColor} */
  @Deprecated Color COLOR_MODIFIED = new Color(0, 50, 160);
+  /** @deprecated use {@link FileStatus#getColor} */
  @Deprecated Color COLOR_MISSING = Gray._97;
+  /** @deprecated use {@link FileStatus#getColor} */
  @Deprecated Color COLOR_ADDED = new Color(10, 119, 0);
+  /** @deprecated use {@link FileStatus#getColor} */
  @Deprecated Color COLOR_OUT_OF_DATE = Color.yellow.darker().darker();
+  /** @deprecated use {@link FileStatus#getColor} */
  @Deprecated Color COLOR_SWITCHED = new Color(8, 151, 143);
+  /** @deprecated use {@link FileStatus#getColor} */
  @Deprecated Color COLOR_UNKNOWN = new Color(153, 51, 0);

  FileStatus NOT_CHANGED = FileStatusFactory.getInstance().createFileStatus("NOT_CHANGED", VcsBundle.message("file.status.name.up.to.date"));
@@ -1,5 +1,5 @@
 /*
- * Copyright 2000-2013 JetBrains s.r.o.
+ * Copyright 2000-2019 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -15,9 +15,15 @@
 */
 package com.intellij.ui.switcher;

+import org.jetbrains.annotations.ApiStatus;
+
 import javax.swing.*;

+/**
+ * @deprecated unused
+ */
@Deprecated
+@ApiStatus.ScheduledForRemoval(inVersion = "2020.1")
 public interface QuickAccessProvider {

  JComponent getComponent();