Package com.intellij.codeInsight.hint

Class HintManagerImpl

java.lang.Object

com.intellij.codeInsight.hint.HintManager

com.intellij.codeInsight.hint.HintManagerImpl

public class HintManagerImpl
extends HintManager

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HintManagerImpl.ActionToIgnore

Nested classes/interfaces inherited from class com.intellij.codeInsight.hint.HintManager

HintManager.HideFlags, HintManager.PositionFlags

Field Summary

Fields inherited from class com.intellij.codeInsight.hint.HintManager

ABOVE, DEFAULT, DONT_CONSUME_ESCAPE, HIDE_BY_ANY_KEY, HIDE_BY_CARET_MOVE, HIDE_BY_ESCAPE, HIDE_BY_LOOKUP_ITEM_CHANGE, HIDE_BY_MOUSEOVER, HIDE_BY_OTHER_HINT, HIDE_BY_SCROLLING, HIDE_BY_TEXT_CHANGE, HIDE_IF_OUT_OF_EDITOR, LEFT, RIGHT, RIGHT_UNDER, UNDER, UPDATE_BY_SCROLLING

Constructor Summary

Constructors

Constructor and Description
HintManagerImpl()

Method Summary

Modifier and Type	Method and Description
static void	adjustEditorHintPosition(LightweightHint hint, Editor editor, java.awt.Point p, short constraint)
boolean	canShowQuestionAction(QuestionAction action)
void	cleanup()
static HintHint	createHintHint(Editor editor, java.awt.Point p, LightweightHint hint, short constraint)
static HintHint	createHintHint(Editor editor, java.awt.Point p, LightweightHint hint, short constraint, boolean createInEditorComponent)
static javax.swing.JComponent	getExternalComponent(Editor editor)
static java.awt.Point	getHintPosition(LightweightHint hint, Editor editor, LogicalPosition pos, short constraint)
java.awt.Point	getHintPosition(LightweightHint hint, Editor editor, short constraint)
static java.awt.Point	getHintPosition(LightweightHint hint, Editor editor, VisualPosition pos, short constraint)
static HintManagerImpl	getInstanceImpl()
boolean	hasShownHintsThatWillHideByOtherHint(boolean willShowTooltip)
void	hideAllHints()
boolean	hideHints(int mask, boolean onlyOne, boolean editorChanged)
boolean	performCurrentQuestionAction()
void	setRequestFocusForNextHint(boolean requestFocus) Sets whether the next showXxx call will request the focus to the newly shown tooltip.
void	showEditorHint(LightweightHint hint, Editor editor, java.awt.Point p, int flags, int timeout, boolean reviveOnEditorChange)
void	showEditorHint(LightweightHint hint, Editor editor, java.awt.Point p, int flags, int timeout, boolean reviveOnEditorChange, HintHint hintInfo)
void	showEditorHint(LightweightHint hint, Editor editor, java.awt.Point p, int flags, int timeout, boolean reviveOnEditorChange, short position)
void	showEditorHint(LightweightHint hint, Editor editor, short constraint, int flags, int timeout, boolean reviveOnEditorChange) In this method the point to show hint depends on current caret position.
void	showErrorHint(Editor editor, java.lang.String text)
void	showErrorHint(Editor editor, java.lang.String hintText, int offset1, int offset2, short constraint, int flags, int timeout)
void	showErrorHint(Editor editor, java.lang.String text, short position)
void	showHint(javax.swing.JComponent component, RelativePoint p, int flags, int timeout)
void	showInformationHint(Editor editor, javax.swing.JComponent component)
void	showInformationHint(Editor editor, javax.swing.JComponent component, short position)
void	showInformationHint(Editor editor, java.lang.String text, javax.swing.event.HyperlinkListener listener)
void	showInformationHint(Editor editor, java.lang.String text, short position)
void	showQuestionHint(Editor editor, int offset1, int offset2, LightweightHint hint, QuestionAction action, short constraint)
void	showQuestionHint(Editor editor, java.awt.Point p, int offset1, int offset2, LightweightHint hint, QuestionAction action, short constraint)
void	showQuestionHint(Editor editor, java.lang.String hintText, int offset1, int offset2, QuestionAction action)
protected void	updateLastEditor(Editor editor)
static void	updateLocation(LightweightHint hint, Editor editor, java.awt.Point p)

Methods inherited from class com.intellij.codeInsight.hint.HintManager

getInstance, showInformationHint

Methods inherited from class java.lang.Object

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

Constructor Detail

HintManagerImpl

public HintManagerImpl()

Method Detail

canShowQuestionAction

public boolean canShowQuestionAction(QuestionAction action)

getInstanceImpl

public static HintManagerImpl getInstanceImpl()

setRequestFocusForNextHint

public void setRequestFocusForNextHint(boolean requestFocus)

Sets whether the next showXxx call will request the focus to the newly shown tooltip. Note the flag applies only to the next call, i.e. is reset to false after any showXxx is called.

Note: This method was created to avoid the code churn associated with creating an overload to every showXxx method with an additional boolean requestFocus parameter

Specified by:

setRequestFocusForNextHint in class HintManager

performCurrentQuestionAction

public boolean performCurrentQuestionAction()

hasShownHintsThatWillHideByOtherHint

public boolean hasShownHintsThatWillHideByOtherHint(boolean willShowTooltip)

Specified by:

hasShownHintsThatWillHideByOtherHint in class HintManager

showEditorHint

public void showEditorHint(LightweightHint hint,
                           Editor editor,
                           short constraint,
                           int flags,
                           int timeout,
                           boolean reviveOnEditorChange)

In this method the point to show hint depends on current caret position. So, first of all, editor will be scrolled to make the caret position visible.

showEditorHint

public void showEditorHint(LightweightHint hint,
                           Editor editor,
                           java.awt.Point p,
                           int flags,
                           int timeout,
                           boolean reviveOnEditorChange)

Parameters:

p - point in layered pane coordinate system.

showEditorHint

public void showEditorHint(LightweightHint hint,
                           Editor editor,
                           java.awt.Point p,
                           int flags,
                           int timeout,
                           boolean reviveOnEditorChange,
                           short position)

showEditorHint

public void showEditorHint(LightweightHint hint,
                           Editor editor,
                           java.awt.Point p,
                           int flags,
                           int timeout,
                           boolean reviveOnEditorChange,
                           HintHint hintInfo)

showHint

public void showHint(javax.swing.JComponent component,
                     RelativePoint p,
                     int flags,
                     int timeout)

Specified by:

showHint in class HintManager

updateLocation

public static void updateLocation(LightweightHint hint,
                                  Editor editor,
                                  java.awt.Point p)

adjustEditorHintPosition

public static void adjustEditorHintPosition(LightweightHint hint,
                                            Editor editor,
                                            java.awt.Point p,
                                            short constraint)

hideAllHints

public void hideAllHints()

Specified by:

hideAllHints in class HintManager

cleanup

public void cleanup()

getHintPosition

public java.awt.Point getHintPosition(LightweightHint hint,
                                      Editor editor,
                                      short constraint)

Returns:

coordinates in layered pane coordinate system.

getHintPosition

public static java.awt.Point getHintPosition(LightweightHint hint,
                                             Editor editor,
                                             LogicalPosition pos,
                                             short constraint)

Returns:

position of hint in layered pane coordinate system

getHintPosition

public static java.awt.Point getHintPosition(LightweightHint hint,
                                             Editor editor,
                                             VisualPosition pos,
                                             short constraint)

Returns:

position of hint in layered pane coordinate system

getExternalComponent

public static javax.swing.JComponent getExternalComponent(Editor editor)

showErrorHint

public void showErrorHint(Editor editor,
                          java.lang.String text)

Specified by:

showErrorHint in class HintManager

showErrorHint

public void showErrorHint(Editor editor,
                          java.lang.String text,
                          short position)

Specified by:

showErrorHint in class HintManager

showInformationHint

public void showInformationHint(Editor editor,
                                java.lang.String text,
                                short position)

Specified by:

showInformationHint in class HintManager

showInformationHint

public void showInformationHint(Editor editor,
                                java.lang.String text,
                                javax.swing.event.HyperlinkListener listener)

Specified by:

showInformationHint in class HintManager

showInformationHint

public void showInformationHint(Editor editor,
                                javax.swing.JComponent component)

Specified by:

showInformationHint in class HintManager

showInformationHint

public void showInformationHint(Editor editor,
                                javax.swing.JComponent component,
                                short position)

showErrorHint

public void showErrorHint(Editor editor,
                          java.lang.String hintText,
                          int offset1,
                          int offset2,
                          short constraint,
                          int flags,
                          int timeout)

Specified by:

showErrorHint in class HintManager

showQuestionHint

public void showQuestionHint(Editor editor,
                             java.lang.String hintText,
                             int offset1,
                             int offset2,
                             QuestionAction action)

Specified by:

showQuestionHint in class HintManager

showQuestionHint

public void showQuestionHint(Editor editor,
                             int offset1,
                             int offset2,
                             LightweightHint hint,
                             QuestionAction action,
                             short constraint)

showQuestionHint

public void showQuestionHint(Editor editor,
                             java.awt.Point p,
                             int offset1,
                             int offset2,
                             LightweightHint hint,
                             QuestionAction action,
                             short constraint)

createHintHint

public static HintHint createHintHint(Editor editor,
                                      java.awt.Point p,
                                      LightweightHint hint,
                                      short constraint)

createHintHint

public static HintHint createHintHint(Editor editor,
                                      java.awt.Point p,
                                      LightweightHint hint,
                                      short constraint,
                                      boolean createInEditorComponent)

updateLastEditor

protected void updateLastEditor(Editor editor)

hideHints

public boolean hideHints(int mask,
                         boolean onlyOne,
                         boolean editorChanged)

Specified by:

hideHints in class HintManager