Add description to @Deprecated methods and add corresponding @ApiStatus.ScheduledForRemoval for them

GitOrigin-RevId: 6dc71c6120734c0255686994ce3ffe106baa328a
This commit is contained in:
Sergey Malenkov
2019-07-02 06:52:16 +03:00
committed by intellij-monorepo-bot
parent f7fe9f07b4
commit e2c41c190e
6 changed files with 37 additions and 0 deletions
@@ -15,6 +15,7 @@ import com.intellij.openapi.util.text.StringUtil;
import com.intellij.util.ArrayUtil;
import com.intellij.util.containers.ContainerUtil;
import org.intellij.lang.annotations.JdkConstants;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
@@ -83,8 +84,12 @@ public class KeymapUtil {
return s;
}
/**
* @deprecated icons are not applicable for our user interface and will be removed
*/
@NotNull
@Deprecated
@ApiStatus.ScheduledForRemoval(inVersion = "2020.1")
public static Icon getShortcutIcon(@NotNull Shortcut shortcut) {
if (shortcut instanceof KeyboardShortcut) {
return AllIcons.General.KeyboardShortcut;
@@ -94,7 +94,11 @@ public class AnimatedIcon implements Icon {
AllIcons.Ide.Macro.Recording_4);
}
/**
* @deprecated icons are not applicable for our user interface and will be removed
*/
@Deprecated
@ApiStatus.ScheduledForRemoval(inVersion = "2020.1")
public static class Grey extends AnimatedIcon {
public Grey() {
super(DELAY, ICONS.toArray(new Icon[0]));
@@ -39,8 +39,10 @@ public class JBScrollPane extends JScrollPane {
*
* @see UIUtil#putClientProperty(JComponent, Key, Object)
* @see UIUtil#isUnderDarcula
* @deprecated unsupported approach to control a scroll bar painting
*/
@Deprecated
@ApiStatus.ScheduledForRemoval(inVersion = "2020.2")
public static final Key<Boolean> BRIGHTNESS_FROM_VIEW = Key.create("JB_SCROLL_PANE_BRIGHTNESS_FROM_VIEW");
/**
@@ -236,7 +238,11 @@ public class JBScrollPane extends JScrollPane {
return new JBViewport();
}
/**
* @deprecated unsupported old implementation
*/
@Deprecated
@ApiStatus.ScheduledForRemoval(inVersion = "2020.2")
protected boolean isOverlaidScrollbar(@Nullable JScrollBar scrollbar) {
ScrollBarUI vsbUI = scrollbar == null ? null : scrollbar.getUI();
return vsbUI instanceof ButtonlessScrollBarUI && !((ButtonlessScrollBarUI)vsbUI).alwaysShowTrack();
@@ -15,6 +15,7 @@ import com.intellij.ui.TreeUIHelper;
import com.intellij.util.ui.EmptyIcon;
import com.intellij.util.ui.UIUtil;
import com.intellij.util.ui.tree.TreeUtil;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
@@ -556,14 +557,22 @@ public class SimpleTree extends Tree implements CellEditorListener {
myEmptyHandle = null;
}
/**
* @deprecated old way to configure tree icons
*/
@Deprecated
@ApiStatus.ScheduledForRemoval(inVersion = "2020.3")
public Icon getHandleIcon(DefaultMutableTreeNode node, TreePath path) {
if (node.getChildCount() == 0) return getEmptyHandle();
return isExpanded(path) ? getExpandedHandle() : getCollapsedHandle();
}
/**
* @deprecated use UIUtil.getTreeExpandedIcon(...) instead
*/
@Deprecated
@ApiStatus.ScheduledForRemoval(inVersion = "2020.3")
public Icon getExpandedHandle() {
if (myExpandedHandle == null) {
myExpandedHandle = UIUtil.getTreeExpandedIcon();
@@ -571,7 +580,11 @@ public class SimpleTree extends Tree implements CellEditorListener {
return myExpandedHandle;
}
/**
* @deprecated use UIUtil.getTreeCollapsedIcon(...) instead
*/
@Deprecated
@ApiStatus.ScheduledForRemoval(inVersion = "2020.3")
public Icon getCollapsedHandle() {
if (myCollapsedHandle == null) {
myCollapsedHandle = UIUtil.getTreeCollapsedIcon();
@@ -579,7 +592,11 @@ public class SimpleTree extends Tree implements CellEditorListener {
return myCollapsedHandle;
}
/**
* @deprecated use EmptyIcon.create(...) instead
*/
@Deprecated
@ApiStatus.ScheduledForRemoval(inVersion = "2020.3")
public Icon getEmptyHandle() {
if (myEmptyHandle == null) {
final Icon expand = getExpandedHandle();
@@ -6,13 +6,16 @@ import com.intellij.openapi.extensions.ExtensionPointName;
import com.intellij.openapi.options.Configurable;
import com.intellij.openapi.options.ConfigurableEP;
import com.intellij.openapi.options.ConfigurableGroup;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/**
* @author nik
* @deprecated needed for IdeConfigurablesGroup
*/
@Deprecated
@ApiStatus.ScheduledForRemoval(inVersion = "2020.2")
abstract class ConfigurablesGroupBase implements ConfigurableGroup {
private Configurable[] myChildren;
private final ExtensionPointName<ConfigurableEP<Configurable>> myConfigurablesExtensionPoint;
@@ -4,11 +4,13 @@ package com.intellij.openapi.options.ex;
import com.intellij.openapi.options.Configurable;
import com.intellij.openapi.options.ConfigurableGroup;
import com.intellij.openapi.options.OptionsBundle;
import org.jetbrains.annotations.ApiStatus;
/**
* @deprecated ShowSettingsUtilImpl#getConfigurableGroups(null, true)
*/
@Deprecated
@ApiStatus.ScheduledForRemoval(inVersion = "2020.2")
public class IdeConfigurablesGroup extends ConfigurablesGroupBase implements ConfigurableGroup {
public IdeConfigurablesGroup() {
super(Configurable.APPLICATION_CONFIGURABLE);