Package com.intellij.navigation

Interface ItemPresentation

All Known Subinterfaces:

ColoredItemPresentation, GrDynamicImplicitElement, ItemPresentationWithSeparator, TextAttributesPresentation

All Known Implementing Classes:

AbstractXmlTagTreeElement, BeanPropertyElement, ClassInitializerTreeElement, CustomMembersGenerator.GdslNamedParameter, DelegatingItemPresentation, DomStructureTreeElement, DtdFileTreeElement, FakePsiElement, FindInProjectUtil.StringUsageTarget, GoToSymbolProvider.BaseNavigationItem, GrDynamicImplicitMethod, GrDynamicImplicitProperty, HtmlTagTreeElement, ImplicitModeElement, InspectionElement, JavaAnonymousClassTreeElement, JavaClassTreeElement, JavaClassTreeElementBase, JavaFileTreeElement, JavaFxPropertyElement, JavaLambdaTreeElement, MarkdownBasePresentation, MarkdownStructureElement, PomTargetPsiElementImpl, PresentationData, PropertiesFileStructureViewElement, PropertyGroup, PsiElement2UsageTargetAdapter, PsiFieldTreeElement, PsiMethodTreeElement, PsiTreeElementBase, PyElementPresentation, RenameableFakePsiElement, RestStructureViewElement, SchemaPrefix, SuperTypeGroup, TaskPsiElement, XmlFileTreeElement, XmlTagTreeElement, XsltApplyTemplatesImpl, XsltCallTemplateImpl, XsltFunctionImpl, XsltParameterImpl, XsltStylesheetImpl, XsltTemplateImpl, XsltVariableImpl, XsltWithParamImpl

public interface ItemPresentation

The presentation of an item in a tree, list or similar view.

See Also:

TreeElement.getPresentation(), PresentationData

Method Summary

Modifier and Type	Method and Description
javax.swing.Icon	getIcon(boolean unused) Returns the icon representing the object.
java.lang.String	getLocationString() Returns the location of the object (for example, the package of a class).
java.lang.String	getPresentableText() Returns the name of the object to be presented in most renderers across the program.

Method Detail

getPresentableText

java.lang.String getPresentableText()

Returns the name of the object to be presented in most renderers across the program.

Returns:

the object name.

getLocationString

java.lang.String getLocationString()

Returns the location of the object (for example, the package of a class). The location string is used by some renderers and usually displayed as grayed text next to the item name.

Returns:

the location description, or null if none is applicable.

getIcon

javax.swing.Icon getIcon(boolean unused)

Returns the icon representing the object.

Parameters:

unused - Used to mean if open/close icons for tree renderer. No longer in use. The parameter is only there for API compatibility reason.