Package com.intellij.codeInspection

Class ProblemDescriptorBase

java.lang.Object

com.intellij.codeInspection.CommonProblemDescriptorImpl

com.intellij.codeInspection.ProblemDescriptorBase

All Implemented Interfaces:

CommonProblemDescriptor, ProblemDescriptor

Direct Known Subclasses:

FormElementProblemDescriptor, ProblemDescriptorImpl, ProblemDescriptorWithReporterName

public class ProblemDescriptorBase
extends CommonProblemDescriptorImpl
implements ProblemDescriptor

Field Summary

Fields inherited from interface com.intellij.codeInspection.ProblemDescriptor

EMPTY_ARRAY

Fields inherited from interface com.intellij.codeInspection.CommonProblemDescriptor

ARRAY_FACTORY, DESCRIPTOR_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
ProblemDescriptorBase(PsiElement startElement, PsiElement endElement, java.lang.String descriptionTemplate, LocalQuickFix [] fixes, ProblemHighlightType highlightType, boolean isAfterEndOfLine, TextRange rangeInElement, boolean showTooltip, boolean onTheFly)

Method Summary

Modifier and Type	Method and Description
protected void	assertPhysical(PsiElement element)
VirtualFile	getContainingFile()
java.lang.Throwable	getCreationTrace()
PsiElement	getEndElement()
TextAttributesKey	getEnforcedTextAttributes()
LocalQuickFix []	getFixes() Returns the quickfixes for the problem.
ProblemHighlightType	getHighlightType()
int	getLineNumber() Returns 0-based line number of the problem.
int	getLineStartOffset()
Navigatable	getNavigatable()
ProblemGroup	getProblemGroup()
Project	getProject()
PsiElement	getPsiElement()
PsiElement	getStartElement()
TextRange	getTextRange()
TextRange	getTextRangeForNavigation()
TextRange	getTextRangeInElement()
boolean	isAfterEndOfLine()
boolean	isOnTheFly()
void	setNavigatable(Navigatable navigatable)
void	setProblemGroup(ProblemGroup problemGroup)
void	setTextAttributes(TextAttributesKey key) Sets custom attributes for highlighting the inspection result.
boolean	showTooltip()
java.lang.String	toString()

Methods inherited from class com.intellij.codeInspection.CommonProblemDescriptorImpl

getDescriptionTemplate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.codeInspection.CommonProblemDescriptor

getDescriptionTemplate

Constructor Detail

ProblemDescriptorBase

public ProblemDescriptorBase(PsiElement startElement,
                             PsiElement endElement,
                             java.lang.String descriptionTemplate,
                             LocalQuickFix [] fixes,
                             ProblemHighlightType highlightType,
                             boolean isAfterEndOfLine,
                             TextRange rangeInElement,
                             boolean showTooltip,
                             boolean onTheFly)

Method Detail

isOnTheFly

public boolean isOnTheFly()

assertPhysical

protected void assertPhysical(PsiElement element)

getCreationTrace

public java.lang.Throwable getCreationTrace()

getPsiElement

public PsiElement getPsiElement()

Specified by:

getPsiElement in interface ProblemDescriptor

getTextRangeInElement

public TextRange getTextRangeInElement()

Specified by:

getTextRangeInElement in interface ProblemDescriptor

getStartElement

public PsiElement getStartElement()

Specified by:

getStartElement in interface ProblemDescriptor

getEndElement

public PsiElement getEndElement()

Specified by:

getEndElement in interface ProblemDescriptor

getProject

public Project getProject()

getLineNumber

public int getLineNumber()

Description copied from interface: ProblemDescriptor

Returns 0-based line number of the problem.

Specified by:

getLineNumber in interface ProblemDescriptor

getLineStartOffset

public int getLineStartOffset()

getHighlightType

public ProblemHighlightType getHighlightType()

Specified by:

getHighlightType in interface ProblemDescriptor

isAfterEndOfLine

public boolean isAfterEndOfLine()

Specified by:

isAfterEndOfLine in interface ProblemDescriptor

setTextAttributes

public void setTextAttributes(TextAttributesKey key)

Description copied from interface: ProblemDescriptor

Sets custom attributes for highlighting the inspection result. Can be used only when the severity of the problem is INFORMATION.

Specified by:

setTextAttributes in interface ProblemDescriptor

Parameters:

key - the text attributes key for highlighting the result.

getEnforcedTextAttributes

public TextAttributesKey getEnforcedTextAttributes()

getTextRangeForNavigation

public TextRange getTextRangeForNavigation()

getTextRange

public TextRange getTextRange()

getNavigatable

public Navigatable getNavigatable()

getContainingFile

public VirtualFile getContainingFile()

setNavigatable

public void setNavigatable(Navigatable navigatable)

getProblemGroup

public ProblemGroup getProblemGroup()

Specified by:

getProblemGroup in interface ProblemDescriptor

See Also:

ProblemGroup

setProblemGroup

public void setProblemGroup(ProblemGroup problemGroup)

Specified by:

setProblemGroup in interface ProblemDescriptor

See Also:

ProblemGroup

showTooltip

public boolean showTooltip()

Specified by:

showTooltip in interface ProblemDescriptor

toString

public java.lang.String toString()

Overrides:

toString in class CommonProblemDescriptorImpl

getFixes

public LocalQuickFix [] getFixes()

Description copied from interface: CommonProblemDescriptor

Returns the quickfixes for the problem.

Specified by:

getFixes in interface CommonProblemDescriptor

Overrides:

getFixes in class CommonProblemDescriptorImpl

Returns:

the list of quickfixes registered for the problem.