Class ToolTipInfo


  • public class ToolTipInfo
    extends java.lang.Object
    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 FocusableTips enabled, and the user clicks on a hyperlink in the tool tip, the specified HyperlinkListener will be called.
    Version:
    1.0
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.net.URL imageBase  
      private javax.swing.event.HyperlinkListener listener  
      private java.lang.String text  
    • Constructor Summary

      Constructors 
      Constructor Description
      ToolTipInfo​(java.lang.String text, javax.swing.event.HyperlinkListener listener)
      Constructor.
      ToolTipInfo​(java.lang.String text, javax.swing.event.HyperlinkListener l, java.net.URL imageBase)
      Constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      javax.swing.event.HyperlinkListener getHyperlinkListener()
      Returns the listener to call when hyperlinks are clicked in the tool tip.
      java.net.URL getImageBase()
      Returns the base URL that any images in the HTML tool tip live in.
      java.lang.String getToolTipText()
      Returns the tool tip text to display.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • text

        private java.lang.String text
      • listener

        private javax.swing.event.HyperlinkListener listener
      • imageBase

        private java.net.URL imageBase
    • Constructor Detail

      • ToolTipInfo

        public ToolTipInfo​(java.lang.String text,
                           javax.swing.event.HyperlinkListener listener)
        Constructor.
        Parameters:
        text - The tool tip text, or null for none.
        listener - The hyperlink listener, or null for none.
      • ToolTipInfo

        public ToolTipInfo​(java.lang.String text,
                           javax.swing.event.HyperlinkListener l,
                           java.net.URL imageBase)
        Constructor.
        Parameters:
        text - The tool tip text, or null for none.
        l - The hyperlink listener, or null for none.
        imageBase - The base URL for images in the HTML text, or null for the default.
    • Method Detail

      • getHyperlinkListener

        public javax.swing.event.HyperlinkListener getHyperlinkListener()
        Returns the listener to call when hyperlinks are clicked in the tool tip.
        Returns:
        The listener, or null for none.
      • getImageBase

        public java.net.URL 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 your FocusableTips. Note that if what getToolTipText() returns isn't HTML, this value is effectively ignored.
        Returns:
        The image base, or null for the default.
      • getToolTipText

        public java.lang.String getToolTipText()
        Returns the tool tip text to display.
        Returns:
        The tool tip text, or null for none.