Class ToolTipInfo
java.lang.Object
org.fife.ui.rsyntaxtextarea.parser.ToolTipInfo
Wrapper for a tool tip and a listener for hyperlink events in the tool
tip (assuming the tip is HTML). If the
RSyntaxTextArea
instance
has FocusableTip
s enabled,
and the user clicks on a hyperlink in the tool tip, the specified
HyperlinkListener
will be called.- Version:
- 1.0
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionToolTipInfo
(String text, HyperlinkListener listener) Constructor.ToolTipInfo
(String text, HyperlinkListener l, URL imageBase) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionReturns the listener to call when hyperlinks are clicked in the tool tip.Returns the base URL that any images in the HTML tool tip live in.Returns the tool tip text to display.
-
Field Details
-
text
-
listener
-
imageBase
-
-
Constructor Details
-
ToolTipInfo
Constructor.- Parameters:
text
- The tool tip text, ornull
for none.listener
- The hyperlink listener, ornull
for none.
-
ToolTipInfo
Constructor.- Parameters:
text
- The tool tip text, ornull
for none.l
- The hyperlink listener, ornull
for none.imageBase
- The base URL for images in the HTMLtext
, ornull
for the default.
-
-
Method Details
-
getHyperlinkListener
Returns the listener to call when hyperlinks are clicked in the tool tip.- Returns:
- The listener, or
null
for none.
-
getImageBase
Returns the base URL that any images in the HTML tool tip live in. This allows you to reference images in a jar file in yourFocusableTip
s. Note that if whatgetToolTipText()
returns isn't HTML, this value is effectively ignored.- Returns:
- The image base, or
null
for the default.
-
getToolTipText
Returns the tool tip text to display.- Returns:
- The tool tip text, or
null
for none.
-