Class HoverManager

java.lang.Object
org.eclipse.ease.ui.help.hovers.HoverManager
All Implemented Interfaces:
org.eclipse.jface.text.IWidgetTokenOwner, org.eclipse.jface.text.IWidgetTokenOwnerExtension

public class HoverManager
extends Object
implements org.eclipse.jface.text.IWidgetTokenOwner, org.eclipse.jface.text.IWidgetTokenOwnerExtension
Manager for HTML hovers. Typically a hover manager is responsible for a part instance, eg a view or editor. The manager takes care that at max 1 hover will be visible at a time for all registered controls.
  • Constructor Summary

    Constructors
    Constructor Description
    HoverManager​(org.eclipse.swt.widgets.Composite hoverContainer)
    Creates a new HoverManager for a given container.
  • Method Summary

    Modifier and Type Method Description
    org.eclipse.ease.ui.help.hovers.internal.ControlHoverManager addHover​(org.eclipse.jface.viewers.TableViewer tableViewer, IHoverContentProvider hoverContent)
    Add a hover for a table viewer.
    org.eclipse.ease.ui.help.hovers.internal.ControlHoverManager addHover​(org.eclipse.jface.viewers.TreeViewer treeViewer, IHoverContentProvider hoverContent)
    Add a hover for a tree viewer.
    org.eclipse.ease.ui.help.hovers.internal.ControlHoverManager addHover​(org.eclipse.swt.widgets.Control control, String hoverContent)
    Add a hover for a control element.
    org.eclipse.ease.ui.help.hovers.internal.ControlHoverManager addHover​(org.eclipse.swt.widgets.Control control, IHoverContentProvider hoverContent)
    Add a hover for a control element.
    void releaseWidgetToken​(org.eclipse.jface.text.IWidgetTokenKeeper tokenKeeper)  
    boolean requestWidgetToken​(org.eclipse.jface.text.IWidgetTokenKeeper requester)  
    boolean requestWidgetToken​(org.eclipse.jface.text.IWidgetTokenKeeper requester, int priority)  

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • HoverManager

      public HoverManager​(org.eclipse.swt.widgets.Composite hoverContainer)
      Creates a new HoverManager for a given container.
      Parameters:
      hoverContainer - the container is typically the root composite of a part.
  • Method Details

    • addHover

      public org.eclipse.ease.ui.help.hovers.internal.ControlHoverManager addHover​(org.eclipse.swt.widgets.Control control, IHoverContentProvider hoverContent)
      Add a hover for a control element.
      Parameters:
      control - control to bind hover to
      hoverContent - hover content provider
    • addHover

      public org.eclipse.ease.ui.help.hovers.internal.ControlHoverManager addHover​(org.eclipse.swt.widgets.Control control, String hoverContent)
      Add a hover for a control element.
      Parameters:
      control - control to bind hover to
      hoverContent - constant hover content
    • addHover

      public org.eclipse.ease.ui.help.hovers.internal.ControlHoverManager addHover​(org.eclipse.jface.viewers.TableViewer tableViewer, IHoverContentProvider hoverContent)
      Add a hover for a table viewer.
      Parameters:
      tableViewer - tableviewer to bind hover to
      hoverContent - hover content provider
    • addHover

      public org.eclipse.ease.ui.help.hovers.internal.ControlHoverManager addHover​(org.eclipse.jface.viewers.TreeViewer treeViewer, IHoverContentProvider hoverContent)
      Add a hover for a tree viewer.
      Parameters:
      treeViewer - treeviewer to bind hover to
      hoverContent - hover content provider
    • requestWidgetToken

      public boolean requestWidgetToken​(org.eclipse.jface.text.IWidgetTokenKeeper requester, int priority)
      Specified by:
      requestWidgetToken in interface org.eclipse.jface.text.IWidgetTokenOwnerExtension
    • requestWidgetToken

      public boolean requestWidgetToken​(org.eclipse.jface.text.IWidgetTokenKeeper requester)
      Specified by:
      requestWidgetToken in interface org.eclipse.jface.text.IWidgetTokenOwner
    • releaseWidgetToken

      public void releaseWidgetToken​(org.eclipse.jface.text.IWidgetTokenKeeper tokenKeeper)
      Specified by:
      releaseWidgetToken in interface org.eclipse.jface.text.IWidgetTokenOwner