Package org.fife.ui.autocomplete
Class ParameterizedCompletionDescriptionToolTip
java.lang.Object
org.fife.ui.autocomplete.ParameterizedCompletionDescriptionToolTip
A "tool tip" that displays information on the function or method currently
being entered.
- Version:
- 1.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate AutoCompletion
The backing AutoCompletion.private JLabel
The label that holds the description.private boolean
private ParameterizedCompletion
The completion being described.private JWindow
The actual tool tip. -
Constructor Summary
ConstructorsConstructorDescriptionParameterizedCompletionDescriptionToolTip
(Window owner, ParameterizedCompletionContext context, AutoCompletion ac, ParameterizedCompletion pc) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns whether this tool tip is visible.void
Sets the location of this tool tip relative to the given rectangle.void
setVisible
(boolean visible) Toggles the visibility of this tool tip.boolean
updateText
(int selectedParam) Updates the text in the tool tip to have the current parameter displayed in bold.void
updateUI()
Updates theLookAndFeel
of this window and the description window.
-
Field Details
-
ac
The backing AutoCompletion. -
tooltip
The actual tool tip. -
descLabel
The label that holds the description. -
pc
The completion being described. -
overflow
private boolean overflow
-
-
Constructor Details
-
ParameterizedCompletionDescriptionToolTip
ParameterizedCompletionDescriptionToolTip(Window owner, ParameterizedCompletionContext context, AutoCompletion ac, ParameterizedCompletion pc) Constructor.- Parameters:
owner
- The parent window.ac
- The parent auto-completion.pc
- The completion being described.
-
-
Method Details
-
isVisible
public boolean isVisible()Returns whether this tool tip is visible.- Returns:
- Whether this tool tip is visible.
- See Also:
-
setLocationRelativeTo
Sets the location of this tool tip relative to the given rectangle.- Parameters:
r
- The visual position of the caret (in screen coordinates).
-
setVisible
public void setVisible(boolean visible) Toggles the visibility of this tool tip.- Parameters:
visible
- Whether this tool tip should be visible.- See Also:
-
updateText
public boolean updateText(int selectedParam) Updates the text in the tool tip to have the current parameter displayed in bold.- Parameters:
selectedParam
- The index of the selected parameter.- Returns:
- Whether the text needed to be updated.
-
updateUI
public void updateUI()Updates theLookAndFeel
of this window and the description window.
-