Package com.intellij.codeInsight.hint

Class InspectionDescriptionLinkHandler

java.lang.Object

com.intellij.codeInsight.highlighting.TooltipLinkHandler

com.intellij.codeInsight.hint.InspectionDescriptionLinkHandler

public class InspectionDescriptionLinkHandler
extends TooltipLinkHandler

Handles tooltip links in format #inspection/inspection_short_name. On a click or expend acton returns more detailed description for given inspection.

Field Summary

Fields inherited from class com.intellij.codeInsight.highlighting.TooltipLinkHandler

INSPECTION_INFO

Constructor Summary

Constructors

Constructor and Description
InspectionDescriptionLinkHandler()

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.

Methods inherited from class com.intellij.codeInsight.highlighting.TooltipLinkHandler

getDescriptionTitle, handleLink

Methods inherited from class java.lang.Object

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

Constructor Detail

InspectionDescriptionLinkHandler

public InspectionDescriptionLinkHandler()

Method Detail

getDescription

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

Description copied from class: TooltipLinkHandler

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

Overrides:

getDescription in class TooltipLinkHandler

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.