Package com.intellij.codeInsight.highlighting

Class TooltipLinkHandler

java.lang.Object

com.intellij.codeInsight.highlighting.TooltipLinkHandler

Direct Known Subclasses:

AssignmentTooltipLinkHandler, ElementLinkHandler, FilterTooltipLinkHandler, GitCommitTooltipLinkHandler, InspectionDescriptionLinkHandler, JavaClassTooltipLinkHandler, NavigationLinkHandler

public abstract class TooltipLinkHandler
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INSPECTION_INFO

Constructor Summary

Constructors

Constructor and Description
TooltipLinkHandler()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription(java.lang.String refSuffix, Editor editor) Override to show extended description on mouse clicks on a link or expand action.
java.lang.String	getDescriptionTitle(java.lang.String refSuffix, Editor editor) Override to change the title above shown getDescription(String, Editor)
boolean	handleLink(java.lang.String refSuffix, Editor editor) Override to handle mouse clicks on a link.

Methods inherited from class java.lang.Object

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

Field Detail

INSPECTION_INFO

public static final java.lang.String INSPECTION_INFO

See Also:

Constant Field Values

Constructor Detail

TooltipLinkHandler

public TooltipLinkHandler()

Method Detail

handleLink

public boolean handleLink(java.lang.String refSuffix,
                          Editor editor)

Override to handle mouse clicks on a link.

Parameters:

refSuffix - part of link's href attribute after registered prefix.

editor - an editor in which tooltip with a link was shown.

Returns:

true if a link was handled.

getDescription

public java.lang.String getDescription(java.lang.String refSuffix,
                                       Editor editor)

Override to show extended description on mouse clicks on a link or expand action. This method is only called if handleLink(String, com.intellij.openapi.editor.Editor) returned false.

Parameters:

refSuffix - part of link's href attribute after registered prefix.

editor - an editor in which tooltip with a link was shown.

Returns:

detailed description to show.

getDescriptionTitle

public java.lang.String getDescriptionTitle(java.lang.String refSuffix,
                                            Editor editor)

Override to change the title above shown getDescription(String, Editor)

Parameters:

refSuffix - part of link's href attribute after registered prefix.

editor - an editor in which tooltip with a link was shown.

Returns:

title above detailed description in the expanded tooltip