Package com.intellij.ui

Class LightweightHint

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.ui.LightweightHint

All Implemented Interfaces:

UserDataHolder, UserDataHolderEx, Hint

Direct Known Subclasses:

EmmetPreviewHint, LookupImpl, NavBarPopup

public class LightweightHint
extends UserDataHolderBase
implements Hint

Field Summary

Fields

Modifier and Type	Field and Description
static Key<java.lang.Boolean>	SHOWN_AT_DEBUG

Constructor Summary

Constructors

Constructor and Description
LightweightHint(javax.swing.JComponent component)

Method Summary

Modifier and Type	Method and Description
void	addHintListener(HintListener listener)
protected void	beforeShow()
protected boolean	canAutoHideOn(TooltipEvent event)
boolean	canControlAutoHide()
java.awt.Rectangle	getBounds()
javax.swing.JComponent	getComponent()
IdeTooltip	getCurrentIdeTooltip()
java.awt.Point	getLocationOn(javax.swing.JComponent c)
java.awt.Dimension	getSize()
void	hide() Hides current hint object.
void	hide(boolean ok)
boolean	isAwtTooltip()
boolean	isForceHideShadow()
boolean	isInsideHint(RelativePoint target)
boolean	isRealPopup()
boolean	isSelectingHint()
boolean	isVisible()
protected void	onPopupCancel()
void	pack()
void	removeHintListener(HintListener listener)
void	setCancelOnClickOutside(boolean b)
void	setCancelOnOtherWindowOpen(boolean b)
void	setFocusRequestor(javax.swing.JComponent c)
void	setForceHideShadow(boolean forceHideShadow)
void	setForceLightweightPopup(boolean forceLightweightPopup)
void	setForceShowAsPopup(boolean forceShowAsPopup)
void	setLocation(RelativePoint point)
void	setResizable(boolean b)
void	setSelectingHint(boolean selectingHint)
void	setSize(java.awt.Dimension size)
void	setTitle(java.lang.String title)
void	show(javax.swing.JComponent parentComponent, int x, int y, javax.swing.JComponent focusBackComponent, HintHint hintHint) Shows the hint in the layered pane.
java.lang.String	toString()
void	updateLocation(int x, int y)
void	updatePosition(Balloon.Position position)
boolean	vetoesHiding()

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

Field Detail

SHOWN_AT_DEBUG

public static final Key<java.lang.Boolean> SHOWN_AT_DEBUG

Constructor Detail

LightweightHint

public LightweightHint(javax.swing.JComponent component)

Method Detail

setForceLightweightPopup

public void setForceLightweightPopup(boolean forceLightweightPopup)

setForceShowAsPopup

public void setForceShowAsPopup(boolean forceShowAsPopup)

setFocusRequestor

public void setFocusRequestor(javax.swing.JComponent c)

setTitle

public void setTitle(java.lang.String title)

isSelectingHint

public boolean isSelectingHint()

setSelectingHint

public void setSelectingHint(boolean selectingHint)

setCancelOnClickOutside

public void setCancelOnClickOutside(boolean b)

setCancelOnOtherWindowOpen

public void setCancelOnOtherWindowOpen(boolean b)

setResizable

public void setResizable(boolean b)

canAutoHideOn

protected boolean canAutoHideOn(TooltipEvent event)

show

public void show(javax.swing.JComponent parentComponent,
                 int x,
                 int y,
                 javax.swing.JComponent focusBackComponent,
                 HintHint hintHint)

Shows the hint in the layered pane. Coordinates x and y are in parentComponent coordinate system. Note that the component appears on 250 layer.

Specified by:

show in interface Hint

Parameters:

parentComponent - defines coordinate system where hint will be shown.

x - x coordinate of hint in parent coordinate system

y - y coordinate of hint in parent coordinate system

focusBackComponent - component which should get focus when the hint will

onPopupCancel

protected void onPopupCancel()

beforeShow

protected void beforeShow()

vetoesHiding

public boolean vetoesHiding()

isForceHideShadow

public boolean isForceHideShadow()

setForceHideShadow

public void setForceHideShadow(boolean forceHideShadow)

getBounds

public final java.awt.Rectangle getBounds()

Returns:

bounds of hint component in the parent component's layered pane coordinate system.

isVisible

public boolean isVisible()

Specified by:

isVisible in interface Hint

Returns:

whether the hint is showing or not

isRealPopup

public final boolean isRealPopup()

hide

public void hide()

Description copied from interface: Hint

Hides current hint object.

Note: this method is also used as a destruction callback, i.e. it performs necessary de-initialization when current hint is not necessary to use anymore. Hence, it's necessary to call it from place where you definitely know that current hint will not be used.

Specified by:

hide in interface Hint

hide

public void hide(boolean ok)

pack

public void pack()

Specified by:

pack in interface Hint

updateLocation

public void updateLocation(int x,
                           int y)

updatePosition

public void updatePosition(Balloon.Position position)

getComponent

public final javax.swing.JComponent getComponent()

addHintListener

public final void addHintListener(HintListener listener)

Specified by:

addHintListener in interface Hint

removeHintListener

public final void removeHintListener(HintListener listener)

Specified by:

removeHintListener in interface Hint

getLocationOn

public java.awt.Point getLocationOn(javax.swing.JComponent c)

setLocation

public void setLocation(RelativePoint point)

Specified by:

setLocation in interface Hint

setSize

public void setSize(java.awt.Dimension size)

isAwtTooltip

public boolean isAwtTooltip()

getSize

public java.awt.Dimension getSize()

isInsideHint

public boolean isInsideHint(RelativePoint target)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

canControlAutoHide

public boolean canControlAutoHide()

getCurrentIdeTooltip

public IdeTooltip getCurrentIdeTooltip()