org.eclipse.xtext.ui.editor.hover
Class AbstractEObjectHover

java.lang.Object
  extended by org.eclipse.xtext.ui.editor.hover.AbstractHover
      extended by org.eclipse.xtext.ui.editor.hover.AbstractEObjectHover
All Implemented Interfaces:
org.eclipse.jface.text.ITextHover, org.eclipse.jface.text.ITextHoverExtension, org.eclipse.jface.text.ITextHoverExtension2, IEObjectHover, ISourceViewerAware
Direct Known Subclasses:
DispatchingEObjectTextHover

public abstract class AbstractEObjectHover
extends AbstractHover
implements IEObjectHover

A hover which determines the EObject at the hover region. Subclasses have to implement getHoverInfo2 (final EObject eObject, final ITextViewer textViewer, final IRegion hoverRegion).

Author:
Christoph Kulla - Initial contribution and API

Field Summary
 
Fields inherited from class org.eclipse.xtext.ui.editor.hover.AbstractHover
sourceViewer
 
Constructor Summary
AbstractEObjectHover()
           
 
Method Summary
abstract  java.lang.Object getHoverInfo(org.eclipse.emf.ecore.EObject eObject, org.eclipse.jface.text.ITextViewer textViewer, org.eclipse.jface.text.IRegion hoverRegion)
           
 java.lang.Object getHoverInfo2(org.eclipse.jface.text.ITextViewer textViewer, org.eclipse.jface.text.IRegion hoverRegion)
           
 org.eclipse.jface.text.IRegion getHoverRegion(org.eclipse.jface.text.ITextViewer textViewer, int offset)
           
protected  Pair<org.eclipse.emf.ecore.EObject,org.eclipse.jface.text.IRegion> getXtextElementAt(XtextResource resource, int offset)
          Call this method only from within an IUnitOfWork
protected  Pair<org.eclipse.emf.ecore.EObject,org.eclipse.jface.text.IRegion> getXtextElementAt(XtextResource resource, org.eclipse.jface.text.IRegion hoverRegion)
          Call this method only from within an IUnitOfWork
 
Methods inherited from class org.eclipse.xtext.ui.editor.hover.AbstractHover
getDocument, getHoverControlCreator, getHoverInfo, getLineNumber, setSourceViewer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractEObjectHover

public AbstractEObjectHover()
Method Detail

getHoverRegion

public org.eclipse.jface.text.IRegion getHoverRegion(org.eclipse.jface.text.ITextViewer textViewer,
                                                     int offset)
Specified by:
getHoverRegion in interface org.eclipse.jface.text.ITextHover
Overrides:
getHoverRegion in class AbstractHover

getHoverInfo2

public java.lang.Object getHoverInfo2(org.eclipse.jface.text.ITextViewer textViewer,
                                      org.eclipse.jface.text.IRegion hoverRegion)
Specified by:
getHoverInfo2 in interface org.eclipse.jface.text.ITextHoverExtension2

getHoverInfo

public abstract java.lang.Object getHoverInfo(org.eclipse.emf.ecore.EObject eObject,
                                              org.eclipse.jface.text.ITextViewer textViewer,
                                              org.eclipse.jface.text.IRegion hoverRegion)
Specified by:
getHoverInfo in interface IEObjectHover

getXtextElementAt

protected Pair<org.eclipse.emf.ecore.EObject,org.eclipse.jface.text.IRegion> getXtextElementAt(XtextResource resource,
                                                                                               org.eclipse.jface.text.IRegion hoverRegion)
Call this method only from within an IUnitOfWork


getXtextElementAt

protected Pair<org.eclipse.emf.ecore.EObject,org.eclipse.jface.text.IRegion> getXtextElementAt(XtextResource resource,
                                                                                               int offset)
Call this method only from within an IUnitOfWork