Package com.intellij.codeInsight.documentation

Class QuickDocUtil

java.lang.Object

com.intellij.codeInsight.documentation.QuickDocUtil

public class QuickDocUtil
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Object	CUT_AT_CMD

Constructor Summary

Constructors

Constructor and Description
QuickDocUtil()

Method Summary

Modifier and Type	Method and Description
static DocumentationComponent	getActiveDocComponent(Project project)
static java.lang.String	inferLinkFromFullDocumentation(DocumentationProvider provider, PsiElement element, PsiElement originalElement, java.lang.String navigationInfo)
static boolean	runInReadActionWithWriteActionPriorityWithRetries(java.lang.Runnable action, long timeout, long pauseBetweenRetries) Deprecated. use ReadAction.nonBlocking(java.lang.Runnable)
static boolean	runInReadActionWithWriteActionPriorityWithRetries(java.lang.Runnable action, long timeout, long pauseBetweenRetries, ProgressIndicator progressIndicator) Deprecated. use ReadAction.nonBlocking(java.lang.Runnable)
static void	updateQuickDoc(Project project, PsiElement element, java.lang.String documentation)
static void	updateQuickDocAsync(PsiElement element, java.lang.CharSequence prefix, Consumer<Consumer<java.lang.Object>> provider)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CUT_AT_CMD

public static final java.lang.Object CUT_AT_CMD

Constructor Detail

QuickDocUtil

public QuickDocUtil()

Method Detail

updateQuickDoc

public static void updateQuickDoc(Project project,
                                  PsiElement element,
                                  java.lang.String documentation)

getActiveDocComponent

public static DocumentationComponent getActiveDocComponent(Project project)

runInReadActionWithWriteActionPriorityWithRetries

@Deprecated
public static boolean runInReadActionWithWriteActionPriorityWithRetries(java.lang.Runnable action,
                                                                        long timeout,
                                                                        long pauseBetweenRetries,
                                                                        ProgressIndicator progressIndicator)

Deprecated. use ReadAction.nonBlocking(java.lang.Runnable)

Repeatedly tries to run given task in read action without blocking write actions (for this to work effectively the action should invoke ProgressManager.checkCanceled() or ProgressIndicator.checkCanceled() often enough).

Parameters:

action - task to run

timeout - timeout in milliseconds

pauseBetweenRetries - pause between retries in milliseconds

progressIndicator - optional progress indicator, which can be used to cancel the action externally

Returns:

true if the action succeeded to run without interruptions, false otherwise

runInReadActionWithWriteActionPriorityWithRetries

@Deprecated
public static boolean runInReadActionWithWriteActionPriorityWithRetries(java.lang.Runnable action,
                                                                        long timeout,
                                                                        long pauseBetweenRetries)

Deprecated. use ReadAction.nonBlocking(java.lang.Runnable)

Same as runInReadActionWithWriteActionPriorityWithRetries(Runnable, long, long, ProgressIndicator) using current thread's progress indicator (ProgressManager.getProgressIndicator()).

inferLinkFromFullDocumentation

public static java.lang.String inferLinkFromFullDocumentation(DocumentationProvider provider,
                                                              PsiElement element,
                                                              PsiElement originalElement,
                                                              java.lang.String navigationInfo)

updateQuickDocAsync

public static void updateQuickDocAsync(PsiElement element,
                                       java.lang.CharSequence prefix,
                                       Consumer<Consumer<java.lang.Object>> provider)