Package com.intellij.codeInsight.documentation

Class DocumentationComponent

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.intellij.codeInsight.documentation.DocumentationComponent

All Implemented Interfaces:

DataProvider, Disposable, WidthBasedLayout, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class DocumentationComponent
extends javax.swing.JPanel
implements Disposable, DataProvider, WidthBasedLayout

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

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

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
static ColorKey	COLOR_KEY
static java.awt.Color	SECTION_COLOR

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
DocumentationComponent(DocumentationManager manager)
DocumentationComponent(DocumentationManager manager, boolean storeSize)

Method Summary

Modifier and Type	Method and Description
void	clearHistory()
static DocumentationComponent	createAndFetch(Project project, PsiElement element, Disposable disposable)
void	dispose() Usually not invoked directly, see class javadoc.
AnAction[]	getActions()
javax.swing.JComponent	getComponent()
java.lang.Object	getData(java.lang.String dataId) Returns the object corresponding to the specified data identifier.
java.lang.String	getDecoratedText()
PsiElement	getElement()
AnAction	getFontSizeAction()
JBPopup	getHint()
java.awt.Dimension	getOptimalSize()
int	getPreferredHeight(int width)
int	getPreferredWidth()
static FontSize	getQuickDocFontSize()
java.lang.String	getText()
boolean	isEmpty()
boolean	isUpToDate()
boolean	needsToolbar()
void	removeCornerMenu()
void	replaceText(java.lang.String text, PsiElement element)
void	requestFocus()
boolean	requestFocusInWindow()
void	setBackground(java.awt.Color color)
void	setData(PsiElement element, java.lang.String text, java.lang.String effectiveExternalUrl, java.lang.String ref, DocumentationProvider provider)
void	setHint(JBPopup hint)
static void	setQuickDocFontSize(FontSize fontSize)
void	setText(java.lang.String text, PsiElement element, DocumentationProvider provider)
void	setToolwindowCallback(java.lang.Runnable callback)
void	showExternalDoc()
protected void	showHint()
protected void	showHint(java.awt.Rectangle viewRect, java.lang.String ref)
void	startWait()

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.ui.WidthBasedLayout

getPreferredHeight, getPreferredWidth

Field Detail

COLOR_KEY

public static final ColorKey COLOR_KEY

SECTION_COLOR

public static final java.awt.Color SECTION_COLOR

Constructor Detail

DocumentationComponent

public DocumentationComponent(DocumentationManager manager)

DocumentationComponent

public DocumentationComponent(DocumentationManager manager,
                              boolean storeSize)

Method Detail

createAndFetch

public static DocumentationComponent createAndFetch(Project project,
                                                    PsiElement element,
                                                    Disposable disposable)

setBackground

public void setBackground(java.awt.Color color)

Overrides:

setBackground in class javax.swing.JComponent

getActions

public AnAction[] getActions()

getFontSizeAction

public AnAction getFontSizeAction()

removeCornerMenu

public void removeCornerMenu()

setToolwindowCallback

public void setToolwindowCallback(java.lang.Runnable callback)

showExternalDoc

public void showExternalDoc()

requestFocusInWindow

public boolean requestFocusInWindow()

Overrides:

requestFocusInWindow in class javax.swing.JComponent

requestFocus

public void requestFocus()

Overrides:

requestFocus in class javax.swing.JComponent

getData

public java.lang.Object getData(java.lang.String dataId)

Description copied from interface: DataProvider

Returns the object corresponding to the specified data identifier. Some of the supported data identifiers are defined in the PlatformDataKeys class.

Specified by:

getData in interface DataProvider

Parameters:

dataId - the data identifier for which the value is requested.

Returns:

the value, or null if no value is available in the current context for this identifier.

getQuickDocFontSize

public static FontSize getQuickDocFontSize()

setQuickDocFontSize

public static void setQuickDocFontSize(FontSize fontSize)

isEmpty

public boolean isEmpty()

startWait

public void startWait()

setHint

public void setHint(JBPopup hint)

getHint

public JBPopup getHint()

getComponent

public javax.swing.JComponent getComponent()

getElement

public PsiElement getElement()

isUpToDate

public boolean isUpToDate()

setText

public void setText(java.lang.String text,
                    PsiElement element,
                    DocumentationProvider provider)

replaceText

public void replaceText(java.lang.String text,
                        PsiElement element)

clearHistory

public void clearHistory()

setData

public void setData(PsiElement element,
                    java.lang.String text,
                    java.lang.String effectiveExternalUrl,
                    java.lang.String ref,
                    DocumentationProvider provider)

showHint

protected void showHint(java.awt.Rectangle viewRect,
                        java.lang.String ref)

showHint

protected void showHint()

getOptimalSize

public java.awt.Dimension getOptimalSize()

getPreferredWidth

public int getPreferredWidth()

Specified by:

getPreferredWidth in interface WidthBasedLayout

getPreferredHeight

public int getPreferredHeight(int width)

Specified by:

getPreferredHeight in interface WidthBasedLayout

needsToolbar

public boolean needsToolbar()

getText

public java.lang.String getText()

getDecoratedText

public java.lang.String getDecoratedText()

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable