Class IzToolTip


  • public class IzToolTip
    extends java.lang.Object
    The tooltip text class.
    Author:
    Christopher Mindus
    • Constructor Summary

      Constructors 
      Constructor Description
      IzToolTip​(org.eclipse.swt.widgets.Control control)
      Constructs the tooltip that is using the system tooltip for normal text.
      IzToolTip​(org.eclipse.swt.widgets.Control control, boolean useSystem)
      Constructs the tooltip.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void dispose()
      Disposes of the tooltip.
      void setHideTimeout​(boolean on)
      Sets using hide timeout.
      void setHTMLText​(java.lang.String text)
      Sets the HTML text with the KString adapter for Font Face support.
      void setJavaMember​(org.eclipse.jdt.core.IMember member)
      Sets a Java member to show as HTML from its JavaDoc.
      void setProperty​(DesignerProp dp)
      Sets the DesignerProp as the tooltip creator for the contents area.
      void setProperty​(DesignerProp dp, IzToolTipPropEnhancer enhancer)
      Sets the DesignerProp as the tooltip creator for the contents area.
      void setText​(KString ks, KStringInfoProviderAdapter adapter)
      Sets the HTML text with the KString adapter for Font Face support.
      void setText​(java.lang.String text, int type)
      Sets the text with options 0=normal text, 1=text with fixed font, 2=text in HTML.
      void setText​(java.lang.String text, int type, KStringInfoProviderAdapter adapter)
      Sets the text with options 0=normal text, 1=text with fixed font, 2=text in HTML.
      void setUseSystem​(boolean on)
      Sets using the System tooltip for normal non-fixed font, default is true.
      • Methods inherited from class java.lang.Object

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

      • IzToolTip

        public IzToolTip​(org.eclipse.swt.widgets.Control control)
        Constructs the tooltip that is using the system tooltip for normal text.
        Parameters:
        control - The owner of the tooltip.
      • IzToolTip

        public IzToolTip​(org.eclipse.swt.widgets.Control control,
                         boolean useSystem)
        Constructs the tooltip.
        Parameters:
        control - The owner of the tooltip.
        useSystem - If system tooltips should be used.
    • Method Detail

      • dispose

        public void dispose()
        Disposes of the tooltip.
      • setHideTimeout

        public void setHideTimeout​(boolean on)
        Sets using hide timeout.
      • setUseSystem

        public void setUseSystem​(boolean on)
        Sets using the System tooltip for normal non-fixed font, default is true.
      • setHTMLText

        public void setHTMLText​(java.lang.String text)
        Sets the HTML text with the KString adapter for Font Face support. This cancels creation of the tooltip using a DesignerProp.
      • setText

        public void setText​(KString ks,
                            KStringInfoProviderAdapter adapter)
        Sets the HTML text with the KString adapter for Font Face support. This cancels creation of the tooltip using a DesignerProp.
      • setText

        public void setText​(java.lang.String text,
                            int type)
        Sets the text with options 0=normal text, 1=text with fixed font, 2=text in HTML. This cancels creation of the tooltip using a DesignerProp.
      • setText

        public void setText​(java.lang.String text,
                            int type,
                            KStringInfoProviderAdapter adapter)
        Sets the text with options 0=normal text, 1=text with fixed font, 2=text in HTML. This cancels creation of the tooltip using a DesignerProp.
      • setProperty

        public void setProperty​(DesignerProp dp)
        Sets the DesignerProp as the tooltip creator for the contents area. This will cancel tooltip text as text/HTML.
      • setProperty

        public void setProperty​(DesignerProp dp,
                                IzToolTipPropEnhancer enhancer)
        Sets the DesignerProp as the tooltip creator for the contents area. This will cancel tooltip text as text/HTML.
      • setJavaMember

        public void setJavaMember​(org.eclipse.jdt.core.IMember member)
        Sets a Java member to show as HTML from its JavaDoc.