Package com.intellij.codeInsight.documentation

Class DocumentationPreviewPanelProvider

java.lang.Object

com.intellij.openapi.preview.PreviewPanelProvider<Couple<PsiElement>,DocumentationComponent>

com.intellij.codeInsight.documentation.DocumentationPreviewPanelProvider

All Implemented Interfaces:

Disposable

public final class DocumentationPreviewPanelProvider
extends PreviewPanelProvider<Couple<PsiElement>,DocumentationComponent>

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
static PreviewProviderId<Couple<PsiElement>,DocumentationComponent>	ID

Fields inherited from class com.intellij.openapi.preview.PreviewPanelProvider

EP_NAME

Constructor Summary

Constructors

Constructor and Description
DocumentationPreviewPanelProvider(Project project)

Method Summary

Modifier and Type	Method and Description
boolean	contentsAreEqual(Couple<PsiElement> content1, Couple<PsiElement> content2)
void	dispose() Usually not invoked directly, see class javadoc.
protected javax.swing.JComponent	getComponent()
protected javax.swing.Icon	getIcon(Couple<PsiElement> content)
float	getMenuOrder()
protected java.lang.String	getTitle(Couple<PsiElement> content)
protected DocumentationComponent	initComponent(Couple<PsiElement> content, boolean requestFocus)
boolean	isModified(Couple<PsiElement> content, boolean beforeReuse)
void	release(Couple<PsiElement> content)
void	showInStandardPlace(Couple<PsiElement> content)

Methods inherited from class com.intellij.openapi.preview.PreviewPanelProvider

getId, supportsStandardPlace, toString

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final PreviewProviderId<Couple<PsiElement>,DocumentationComponent> ID

Constructor Detail

DocumentationPreviewPanelProvider

public DocumentationPreviewPanelProvider(Project project)

Method Detail

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

getComponent

protected javax.swing.JComponent getComponent()

Specified by:

getComponent in class PreviewPanelProvider<Couple<PsiElement>,DocumentationComponent>

getTitle

protected java.lang.String getTitle(Couple<PsiElement> content)

Specified by:

getTitle in class PreviewPanelProvider<Couple<PsiElement>,DocumentationComponent>

getIcon

protected javax.swing.Icon getIcon(Couple<PsiElement> content)

Specified by:

getIcon in class PreviewPanelProvider<Couple<PsiElement>,DocumentationComponent>

getMenuOrder

public float getMenuOrder()

Specified by:

getMenuOrder in class PreviewPanelProvider<Couple<PsiElement>,DocumentationComponent>

showInStandardPlace

public void showInStandardPlace(Couple<PsiElement> content)

Specified by:

showInStandardPlace in class PreviewPanelProvider<Couple<PsiElement>,DocumentationComponent>

release

public void release(Couple<PsiElement> content)

Specified by:

release in class PreviewPanelProvider<Couple<PsiElement>,DocumentationComponent>

contentsAreEqual

public boolean contentsAreEqual(Couple<PsiElement> content1,
                                Couple<PsiElement> content2)

Specified by:

contentsAreEqual in class PreviewPanelProvider<Couple<PsiElement>,DocumentationComponent>

isModified

public boolean isModified(Couple<PsiElement> content,
                          boolean beforeReuse)

Specified by:

isModified in class PreviewPanelProvider<Couple<PsiElement>,DocumentationComponent>

initComponent

protected DocumentationComponent initComponent(Couple<PsiElement> content,
                                               boolean requestFocus)

Specified by:

initComponent in class PreviewPanelProvider<Couple<PsiElement>,DocumentationComponent>