Package com.intellij.codeInsight.navigation

Class NavigationGutterIconBuilder<T>

java.lang.Object

com.intellij.codeInsight.navigation.NavigationGutterIconBuilder<T>

public class NavigationGutterIconBuilder<T>
extends java.lang.Object

DOM-specific builder for GutterIconRenderer and LineMarkerInfo.

Field Summary

Fields

Modifier and Type	Field and Description
static NotNullFunction<DomElement,java.util.Collection<? extends PsiElement>>	DEFAULT_DOM_CONVERTOR
protected static NotNullFunction<PsiElement,java.util.Collection<? extends PsiElement>>	DEFAULT_PSI_CONVERTOR
static NotNullFunction<DomElement,java.util.Collection<? extends GotoRelatedItem>>	DOM_GOTO_RELATED_ITEM_PROVIDER
protected GutterIconRenderer.Alignment	myAlignment
protected java.lang.String	myEmptyText
protected javax.swing.Icon	myIcon
protected java.lang.String	myPopupTitle
protected NotNullLazyValue<java.util.Collection<? extends T>>	myTargets
protected java.lang.String	myTooltipText
protected java.lang.String	myTooltipTitle
protected static NotNullFunction<PsiElement,java.util.Collection<? extends GotoRelatedItem>>	PSI_GOTO_RELATED_ITEM_PROVIDER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NavigationGutterIconBuilder(javax.swing.Icon icon, NotNullFunction<? super T,? extends java.util.Collection<? extends PsiElement>> converter)
protected	NavigationGutterIconBuilder(javax.swing.Icon icon, NotNullFunction<? super T,? extends java.util.Collection<? extends PsiElement>> converter, NotNullFunction<? super T,? extends java.util.Collection<? extends GotoRelatedItem>> gotoRelatedItemProvider)

Method Summary

Modifier and Type	Method and Description
protected java.util.Collection<GotoRelatedItem>	computeGotoTargets()
static NavigationGutterIconBuilder<PsiElement>	create(javax.swing.Icon icon)
static <T> NavigationGutterIconBuilder<T>	create(javax.swing.Icon icon, NotNullFunction<? super T,? extends java.util.Collection<? extends PsiElement>> converter)
static <T> NavigationGutterIconBuilder<T>	create(javax.swing.Icon icon, NotNullFunction<? super T,? extends java.util.Collection<? extends PsiElement>> converter, NotNullFunction<? super T,? extends java.util.Collection<? extends GotoRelatedItem>> gotoRelatedItemProvider)
void	createGutterIcon(AnnotationHolder holder, PsiElement element)
protected NavigationGutterIconRenderer	createGutterIconRenderer(NotNullLazyValue<java.util.List<SmartPsiElementPointer<?>>> pointers, Computable<PsiElementListCellRenderer<?>> renderer, boolean empty)
protected NavigationGutterIconRenderer	createGutterIconRenderer(Project project)
RelatedItemLineMarkerInfo<PsiElement>	createLineMarkerInfo(PsiElement element)
Annotation	install(AnnotationHolder holder, PsiElement element) Deprecated. Use {createGutterIcon(AnnotationHolder, PsiElement)} instead
Annotation	install(DomElementAnnotationHolder holder, DomElement element)
NavigationGutterIconBuilder<T>	setAlignment(GutterIconRenderer.Alignment alignment)
NavigationGutterIconBuilder<T>	setCellRenderer(PsiElementListCellRenderer cellRenderer)
NavigationGutterIconBuilder<T>	setEmptyPopupText(java.lang.String emptyText)
NavigationGutterIconBuilder<T>	setNamer(NullableFunction<? super T,java.lang.String> namer)
NavigationGutterIconBuilder<T>	setPopupTitle(java.lang.String popupTitle)
NavigationGutterIconBuilder<T>	setTarget(T target)
NavigationGutterIconBuilder<T>	setTargets(java.util.Collection<? extends T> targets)
NavigationGutterIconBuilder<T>	setTargets(NotNullLazyValue<java.util.Collection<? extends T>> targets)
NavigationGutterIconBuilder<T>	setTargets(T... targets)
NavigationGutterIconBuilder<T>	setTooltipText(java.lang.String tooltipText)
NavigationGutterIconBuilder<T>	setTooltipTitle(java.lang.String tooltipTitle)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PSI_CONVERTOR

protected static final NotNullFunction<PsiElement,java.util.Collection<? extends PsiElement>> DEFAULT_PSI_CONVERTOR

myIcon

protected final javax.swing.Icon myIcon

myTargets

protected NotNullLazyValue<java.util.Collection<? extends T>> myTargets

myTooltipText

protected java.lang.String myTooltipText

myPopupTitle

protected java.lang.String myPopupTitle

myEmptyText

protected java.lang.String myEmptyText

myTooltipTitle

protected java.lang.String myTooltipTitle

myAlignment

protected GutterIconRenderer.Alignment myAlignment

DEFAULT_DOM_CONVERTOR

public static final NotNullFunction<DomElement,java.util.Collection<? extends PsiElement>> DEFAULT_DOM_CONVERTOR

DOM_GOTO_RELATED_ITEM_PROVIDER

public static final NotNullFunction<DomElement,java.util.Collection<? extends GotoRelatedItem>> DOM_GOTO_RELATED_ITEM_PROVIDER

PSI_GOTO_RELATED_ITEM_PROVIDER

protected static final NotNullFunction<PsiElement,java.util.Collection<? extends GotoRelatedItem>> PSI_GOTO_RELATED_ITEM_PROVIDER

Constructor Detail

NavigationGutterIconBuilder

protected NavigationGutterIconBuilder(javax.swing.Icon icon,
                                      NotNullFunction<? super T,? extends java.util.Collection<? extends PsiElement>> converter)

NavigationGutterIconBuilder

protected NavigationGutterIconBuilder(javax.swing.Icon icon,
                                      NotNullFunction<? super T,? extends java.util.Collection<? extends PsiElement>> converter,
                                      NotNullFunction<? super T,? extends java.util.Collection<? extends GotoRelatedItem>> gotoRelatedItemProvider)

Method Detail

create

public static NavigationGutterIconBuilder<PsiElement> create(javax.swing.Icon icon)

create

public static <T> NavigationGutterIconBuilder<T> create(javax.swing.Icon icon,
                                                        NotNullFunction<? super T,? extends java.util.Collection<? extends PsiElement>> converter)

create

public static <T> NavigationGutterIconBuilder<T> create(javax.swing.Icon icon,
                                                        NotNullFunction<? super T,? extends java.util.Collection<? extends PsiElement>> converter,
                                                        NotNullFunction<? super T,? extends java.util.Collection<? extends GotoRelatedItem>> gotoRelatedItemProvider)

setTarget

public NavigationGutterIconBuilder<T> setTarget(T target)

setTargets

@SafeVarargs
public final NavigationGutterIconBuilder<T> setTargets(T... targets)

setTargets

public NavigationGutterIconBuilder<T> setTargets(NotNullLazyValue<java.util.Collection<? extends T>> targets)

setTargets

public NavigationGutterIconBuilder<T> setTargets(java.util.Collection<? extends T> targets)

setTooltipText

public NavigationGutterIconBuilder<T> setTooltipText(java.lang.String tooltipText)

setAlignment

public NavigationGutterIconBuilder<T> setAlignment(GutterIconRenderer.Alignment alignment)

setPopupTitle

public NavigationGutterIconBuilder<T> setPopupTitle(java.lang.String popupTitle)

setEmptyPopupText

public NavigationGutterIconBuilder<T> setEmptyPopupText(java.lang.String emptyText)

setTooltipTitle

public NavigationGutterIconBuilder<T> setTooltipTitle(java.lang.String tooltipTitle)

setNamer

public NavigationGutterIconBuilder<T> setNamer(NullableFunction<? super T,java.lang.String> namer)

setCellRenderer

public NavigationGutterIconBuilder<T> setCellRenderer(PsiElementListCellRenderer cellRenderer)

install

public Annotation install(DomElementAnnotationHolder holder,
                          DomElement element)

install

@Deprecated
public Annotation install(AnnotationHolder holder,
                          PsiElement element)

Deprecated. Use {createGutterIcon(AnnotationHolder, PsiElement)} instead

createGutterIcon

public void createGutterIcon(AnnotationHolder holder,
                             PsiElement element)

createLineMarkerInfo

public RelatedItemLineMarkerInfo<PsiElement> createLineMarkerInfo(PsiElement element)

computeGotoTargets

protected java.util.Collection<GotoRelatedItem> computeGotoTargets()

createGutterIconRenderer

protected NavigationGutterIconRenderer createGutterIconRenderer(Project project)

createGutterIconRenderer

protected NavigationGutterIconRenderer createGutterIconRenderer(NotNullLazyValue<java.util.List<SmartPsiElementPointer<?>>> pointers,
                                                                Computable<PsiElementListCellRenderer<?>> renderer,
                                                                boolean empty)