Class IzToolTipImpl


  • public class IzToolTipImpl
    extends org.eclipse.jface.window.DefaultToolTip
    The tooltip implementor class controlled by IzToolTip.
    Author:
    Christopher Mindus
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String KEY
      The key.
      • Fields inherited from class org.eclipse.jface.window.ToolTip

        NO_RECREATE, RECREATE
    • Constructor Summary

      Constructors 
      Constructor Description
      IzToolTipImpl​(org.eclipse.swt.widgets.Control control, boolean useHideTimeout)
      Constructs the tooltip.
      IzToolTipImpl​(org.eclipse.swt.widgets.Control control, boolean useRegions, boolean useHideTimeout)
      Constructs the tooltip.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static org.eclipse.swt.widgets.Composite createHTMLComposite​(org.eclipse.swt.widgets.Composite topMost, org.eclipse.swt.widgets.Composite parent, KString kstring, KStringInfoProviderAdapter adapter)
      Creates a HTML composite for HTML preview.
      static org.eclipse.swt.widgets.Composite createJavaDocComposite​(org.eclipse.swt.widgets.Composite topMost, org.eclipse.swt.widgets.Composite parent, org.eclipse.jdt.core.IMember member)
      Creates a JavaDoc tooltip composite for a member.
      protected org.eclipse.swt.widgets.Composite createToolTipContentArea​(org.eclipse.swt.widgets.Event event, org.eclipse.swt.widgets.Composite parent)
      Creates the tooltip content area for HTML.
      void ksetText​(java.lang.String text, int type)
      Sets the text, type is 0=normal text, 1=text with fixed font, 2=text in HTML.
      void setHideTimeout​(boolean on)
      Sets using hide timeout.
      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 setProperty​(GProp<?> gp)
      Sets the property as the tooltip creator for the contents area.
      void setText​(java.lang.String text, int type, KStringInfoProviderAdapter adapter)
      Sets the text, type is 0=normal text, 1=text with fixed font, 2=text in HTML.
      • Methods inherited from class org.eclipse.jface.window.DefaultToolTip

        getBackgroundColor, getBackgroundImage, getFont, getForegroundColor, getImage, getStyle, getText, setBackgroundColor, setBackgroundImage, setFont, setForegroundColor, setImage, setStyle, setText
      • Methods inherited from class org.eclipse.jface.window.ToolTip

        activate, afterHideToolTip, deactivate, getData, getLocation, getToolTipArea, hide, isHideOnMouseDown, isRespectDisplayBounds, isRespectMonitorBounds, setData, setHideDelay, setHideOnMouseDown, setPopupDelay, setRespectDisplayBounds, setRespectMonitorBounds, setShift, shouldCreateToolTip, show
      • Methods inherited from class java.lang.Object

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

      • IzToolTipImpl

        public IzToolTipImpl​(org.eclipse.swt.widgets.Control control,
                             boolean useHideTimeout)
        Constructs the tooltip.
        Parameters:
        control - The owner of the tooltip.
      • IzToolTipImpl

        public IzToolTipImpl​(org.eclipse.swt.widgets.Control control,
                             boolean useRegions,
                             boolean useHideTimeout)
        Constructs the tooltip.
        Parameters:
        control - The owner of the tooltip.
    • Method Detail

      • setHideTimeout

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

        protected org.eclipse.swt.widgets.Composite createToolTipContentArea​(org.eclipse.swt.widgets.Event event,
                                                                             org.eclipse.swt.widgets.Composite parent)
        Creates the tooltip content area for HTML.
        Overrides:
        createToolTipContentArea in class org.eclipse.jface.window.DefaultToolTip
      • ksetText

        public void ksetText​(java.lang.String text,
                             int type)
        Sets the text, type is 0=normal text, 1=text with fixed font, 2=text in HTML.
      • setText

        public void setText​(java.lang.String text,
                            int type,
                            KStringInfoProviderAdapter adapter)
        Sets the text, type is 0=normal text, 1=text with fixed font, 2=text in HTML.
      • 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.
      • setProperty

        public void setProperty​(GProp<?> gp)
        Sets the property 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.
      • createJavaDocComposite

        public static org.eclipse.swt.widgets.Composite createJavaDocComposite​(org.eclipse.swt.widgets.Composite topMost,
                                                                               org.eclipse.swt.widgets.Composite parent,
                                                                               org.eclipse.jdt.core.IMember member)
        Creates a JavaDoc tooltip composite for a member.
        Parameters:
        parent - The parent composite.
        member - The member.
        Returns:
        null if not possible.
      • createHTMLComposite

        public static org.eclipse.swt.widgets.Composite createHTMLComposite​(org.eclipse.swt.widgets.Composite topMost,
                                                                            org.eclipse.swt.widgets.Composite parent,
                                                                            KString kstring,
                                                                            KStringInfoProviderAdapter adapter)
        Creates a HTML composite for HTML preview.