Package com.intellij.codeInsight.documentation

Class DocumentationManager

java.lang.Object

com.intellij.codeInsight.documentation.DockablePopupManager<DocumentationComponent>

com.intellij.codeInsight.documentation.DocumentationManager

public class DocumentationManager
extends DockablePopupManager<DocumentationComponent>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JAVADOC_LOCATION_AND_SIZE
static java.lang.String	NEW_JAVADOC_LOCATION_AND_SIZE
static Key<SmartPsiElementPointer<?>>	ORIGINAL_ELEMENT_KEY
static DataKey<java.lang.String>	SELECTED_QUICK_DOC_TEXT

Fields inherited from class com.intellij.codeInsight.documentation.DockablePopupManager

myProject, myToolWindow

Constructor Summary

Constructors

Constructor and Description
DocumentationManager(Project project)
DocumentationManager(Project project, ActionManager manager, TargetElementUtil targetElementUtil) Deprecated. Use DocumentationManager(Project)

Method Summary

Modifier and Type	Method and Description
protected DocumentationComponent	createComponent()
static void	createHyperlink(java.lang.StringBuilder buffer, java.lang.String refText, java.lang.String label, boolean plainLink)
protected AnAction	createRestorePopupAction()
void	createToolWindow(PsiElement element, PsiElement originalElement)
protected void	doUpdateComponent(Editor editor, PsiFile psiFile)
protected void	doUpdateComponent(Editor editor, PsiFile psiFile, boolean requestFocus)
protected void	doUpdateComponent(PsiElement element)
protected void	doUpdateComponent(PsiElement element, PsiElement originalElement, DocumentationComponent component)
void	fetchDocInfo(PsiElement element, DocumentationComponent component)
PsiElement	findTargetElement(Editor editor, int offset, PsiFile file, PsiElement contextElement)
PsiElement	findTargetElement(Editor editor, PsiFile file)
PsiElement	findTargetElement(Editor editor, PsiFile file, PsiElement contextElement)
java.lang.String	generateDocumentation(PsiElement element, PsiElement originalElement, boolean onHover)
protected boolean	getAutoUpdateDefault()
protected java.lang.String	getAutoUpdateDescription()
java.lang.String	getAutoUpdateEnabledProperty()
protected java.lang.String	getAutoUpdateTitle()
JBPopup	getDocInfoHint()
PsiElement	getElementFromLookup(Editor editor, PsiFile file)
static DocumentationManager	getInstance(Project project)
ActionCallback	getLastAction()
static PsiElement	getOriginalElement(PsiElement element)
Project	getProject(PsiElement element)
static DocumentationProvider	getProviderFromElement(PsiElement element)
static DocumentationProvider	getProviderFromElement(PsiElement element, PsiElement originalElement)
protected java.lang.String	getRestorePopupDescription()
java.lang.String	getShowInToolWindowProperty()
protected java.lang.String	getTitle(PsiElement element)
protected java.lang.String	getToolwindowId()
protected void	installComponentActions(ToolWindow toolWindow, DocumentationComponent component)
void	navigateByLink(DocumentationComponent component, java.lang.String url)
ActionCallback	queueFetchDocInfo(PsiElement element, DocumentationComponent component)
void	restorePopupBehavior()
void	setAllowContentUpdateFromContext(boolean allow)
void	setDocumentationComponent(DocumentationComponent documentationComponent)
protected void	setToolwindowDefaultState()
void	showJavaDocInfo(Editor editor, PsiElement element, PsiElement original, java.lang.Runnable closeCallback, java.lang.String documentation, boolean closeOnSneeze, boolean useStoredPopupSize) Asks to show quick doc for the target element.
void	showJavaDocInfo(Editor editor, PsiFile file, boolean requestFocus)
void	showJavaDocInfo(Editor editor, PsiFile file, boolean requestFocus, java.lang.Runnable closeCallback)
void	showJavaDocInfo(PsiElement element, PsiElement original)
void	showJavaDocInfo(PsiElement element, PsiElement original, boolean requestFocus, java.lang.Runnable closeCallback)
void	showJavaDocInfo(PsiElement element, PsiElement original, boolean requestFocus, java.lang.Runnable closeCallback, java.lang.String documentation, boolean useStoredPopupSize)
void	showJavaDocInfo(PsiElement element, PsiElement original, java.lang.Runnable closeCallback)
void	showJavaDocInfoAtToolWindow(PsiElement element, PsiElement original)
static void	storeOriginalElement(Project project, PsiElement originalElement, PsiElement element)
void	updateToolwindowContext()

Methods inherited from class com.intellij.codeInsight.documentation.DockablePopupManager

createActions, hasActiveDockedDocWindow, recreateToolWindow, resetAutoUpdateState, updateComponent, updateComponent

Methods inherited from class java.lang.Object

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

Field Detail

JAVADOC_LOCATION_AND_SIZE

public static final java.lang.String JAVADOC_LOCATION_AND_SIZE

See Also:

Constant Field Values

NEW_JAVADOC_LOCATION_AND_SIZE

public static final java.lang.String NEW_JAVADOC_LOCATION_AND_SIZE

See Also:

Constant Field Values

SELECTED_QUICK_DOC_TEXT

public static final DataKey<java.lang.String> SELECTED_QUICK_DOC_TEXT

ORIGINAL_ELEMENT_KEY

public static final Key<SmartPsiElementPointer<?>> ORIGINAL_ELEMENT_KEY

Constructor Detail

DocumentationManager

@Deprecated
public DocumentationManager(Project project,
                            ActionManager manager,
                            TargetElementUtil targetElementUtil)

Deprecated. Use DocumentationManager(Project)

DocumentationManager

public DocumentationManager(Project project)

Method Detail

getToolwindowId

protected java.lang.String getToolwindowId()

Specified by:

getToolwindowId in class DockablePopupManager<DocumentationComponent>

createComponent

protected DocumentationComponent createComponent()

Specified by:

createComponent in class DockablePopupManager<DocumentationComponent>

getRestorePopupDescription

protected java.lang.String getRestorePopupDescription()

Specified by:

getRestorePopupDescription in class DockablePopupManager<DocumentationComponent>

getAutoUpdateDescription

protected java.lang.String getAutoUpdateDescription()

Specified by:

getAutoUpdateDescription in class DockablePopupManager<DocumentationComponent>

getAutoUpdateTitle

protected java.lang.String getAutoUpdateTitle()

Specified by:

getAutoUpdateTitle in class DockablePopupManager<DocumentationComponent>

getAutoUpdateDefault

protected boolean getAutoUpdateDefault()

Overrides:

getAutoUpdateDefault in class DockablePopupManager<DocumentationComponent>

createRestorePopupAction

protected AnAction createRestorePopupAction()

Overrides:

createRestorePopupAction in class DockablePopupManager<DocumentationComponent>

restorePopupBehavior

public void restorePopupBehavior()

Overrides:

restorePopupBehavior in class DockablePopupManager<DocumentationComponent>

createToolWindow

public void createToolWindow(PsiElement element,
                             PsiElement originalElement)

Overrides:

createToolWindow in class DockablePopupManager<DocumentationComponent>

installComponentActions

protected void installComponentActions(ToolWindow toolWindow,
                                       DocumentationComponent component)

Overrides:

installComponentActions in class DockablePopupManager<DocumentationComponent>

setToolwindowDefaultState

protected void setToolwindowDefaultState()

Overrides:

setToolwindowDefaultState in class DockablePopupManager<DocumentationComponent>

getInstance

public static DocumentationManager getInstance(Project project)

setAllowContentUpdateFromContext

public void setAllowContentUpdateFromContext(boolean allow)

updateToolwindowContext

public void updateToolwindowContext()

showJavaDocInfoAtToolWindow

public void showJavaDocInfoAtToolWindow(PsiElement element,
                                        PsiElement original)

showJavaDocInfo

public void showJavaDocInfo(PsiElement element,
                            PsiElement original)

showJavaDocInfo

public void showJavaDocInfo(Editor editor,
                            PsiElement element,
                            PsiElement original,
                            java.lang.Runnable closeCallback,
                            java.lang.String documentation,
                            boolean closeOnSneeze,
                            boolean useStoredPopupSize)

Asks to show quick doc for the target element.

Parameters:

editor - editor with an element for which quick do should be shown

element - target element which documentation should be shown

original - element that was used as a quick doc anchor. Example: consider a code like Runnable task;. A user wants to see javadoc for the Runnable, so, original element is a class name from the variable declaration but 'element' argument is a Runnable descriptor

closeCallback - callback to be notified on target hint close (if any)

documentation - precalculated documentation

closeOnSneeze - flag that defines whether quick doc control should be as non-obtrusive as possible. E.g. there are at least two possible situations - the quick doc is shown automatically on mouse over element; the quick doc is shown on explicit action call (Ctrl+Q). We want to close the doc on, say, editor viewport position change at the first situation but don't want to do that at the second

useStoredPopupSize - whether popup size previously set by user (via mouse-dragging) should be used, or default one should be used

showJavaDocInfo

public void showJavaDocInfo(PsiElement element,
                            PsiElement original,
                            java.lang.Runnable closeCallback)

showJavaDocInfo

public void showJavaDocInfo(PsiElement element,
                            PsiElement original,
                            boolean requestFocus,
                            java.lang.Runnable closeCallback)

showJavaDocInfo

public void showJavaDocInfo(PsiElement element,
                            PsiElement original,
                            boolean requestFocus,
                            java.lang.Runnable closeCallback,
                            java.lang.String documentation,
                            boolean useStoredPopupSize)

showJavaDocInfo

public void showJavaDocInfo(Editor editor,
                            PsiFile file,
                            boolean requestFocus)

showJavaDocInfo

public void showJavaDocInfo(Editor editor,
                            PsiFile file,
                            boolean requestFocus,
                            java.lang.Runnable closeCallback)

findTargetElement

public PsiElement findTargetElement(Editor editor,
                                    PsiFile file)

storeOriginalElement

public static void storeOriginalElement(Project project,
                                        PsiElement originalElement,
                                        PsiElement element)

findTargetElement

public PsiElement findTargetElement(Editor editor,
                                    PsiFile file,
                                    PsiElement contextElement)

findTargetElement

public PsiElement findTargetElement(Editor editor,
                                    int offset,
                                    PsiFile file,
                                    PsiElement contextElement)

getElementFromLookup

public PsiElement getElementFromLookup(Editor editor,
                                       PsiFile file)

generateDocumentation

public java.lang.String generateDocumentation(PsiElement element,
                                              PsiElement originalElement,
                                              boolean onHover)

getDocInfoHint

public JBPopup getDocInfoHint()

fetchDocInfo

public void fetchDocInfo(PsiElement element,
                         DocumentationComponent component)

queueFetchDocInfo

public ActionCallback queueFetchDocInfo(PsiElement element,
                                        DocumentationComponent component)

getProviderFromElement

public static DocumentationProvider getProviderFromElement(PsiElement element)

getProviderFromElement

public static DocumentationProvider getProviderFromElement(PsiElement element,
                                                           PsiElement originalElement)

getOriginalElement

public static PsiElement getOriginalElement(PsiElement element)

navigateByLink

public void navigateByLink(DocumentationComponent component,
                           java.lang.String url)

getProject

public Project getProject(PsiElement element)

createHyperlink

public static void createHyperlink(java.lang.StringBuilder buffer,
                                   java.lang.String refText,
                                   java.lang.String label,
                                   boolean plainLink)

getShowInToolWindowProperty

public java.lang.String getShowInToolWindowProperty()

Specified by:

getShowInToolWindowProperty in class DockablePopupManager<DocumentationComponent>

getAutoUpdateEnabledProperty

public java.lang.String getAutoUpdateEnabledProperty()

Specified by:

getAutoUpdateEnabledProperty in class DockablePopupManager<DocumentationComponent>

doUpdateComponent

protected void doUpdateComponent(PsiElement element,
                                 PsiElement originalElement,
                                 DocumentationComponent component)

Specified by:

doUpdateComponent in class DockablePopupManager<DocumentationComponent>

doUpdateComponent

protected void doUpdateComponent(Editor editor,
                                 PsiFile psiFile,
                                 boolean requestFocus)

Overrides:

doUpdateComponent in class DockablePopupManager<DocumentationComponent>

doUpdateComponent

protected void doUpdateComponent(Editor editor,
                                 PsiFile psiFile)

Specified by:

doUpdateComponent in class DockablePopupManager<DocumentationComponent>

doUpdateComponent

protected void doUpdateComponent(PsiElement element)

Specified by:

doUpdateComponent in class DockablePopupManager<DocumentationComponent>

getTitle

protected java.lang.String getTitle(PsiElement element)

Specified by:

getTitle in class DockablePopupManager<DocumentationComponent>

getLastAction

public ActionCallback getLastAction()

setDocumentationComponent

public void setDocumentationComponent(DocumentationComponent documentationComponent)