org.eclipse.xtext.web.server.hover

Class HoverService

java.lang.Object

org.eclipse.xtext.web.server.hover.HoverService

public class HoverService
extends java.lang.Object

Service class for mouse hover information. Such information can be created for an already existing model element or for an element proposed through content assist.

Constructor Summary

Constructors

Constructor and Description
HoverService()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	addIconDivs(org.eclipse.xtext.ide.labels.IImageDescription it, java.lang.String nameHtml)
protected HoverResult	createHover(java.lang.Object element, java.lang.String stateId, org.eclipse.xtext.util.CancelIndicator cancelIndicator)
HoverResult	getHover(XtextWebDocumentAccess document, int offset) Compute a hover result at the given offset in the document.
HoverResult	getHover(XtextWebDocumentAccess document, java.lang.String proposal, org.eclipse.xtext.util.ITextRegion selection, int offset) Compute a hover result for a content assist proposal at the given offset.
protected java.lang.String	surroundWithDiv(java.lang.String html, java.lang.String... divClasses)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HoverService

public HoverService()

Method Detail

getHover

public HoverResult getHover(XtextWebDocumentAccess document,
                            int offset)
                     throws InvalidRequestException

Compute a hover result at the given offset in the document.

Throws:

InvalidRequestException

getHover

public HoverResult getHover(XtextWebDocumentAccess document,
                            java.lang.String proposal,
                            org.eclipse.xtext.util.ITextRegion selection,
                            int offset)
                     throws InvalidRequestException

Compute a hover result for a content assist proposal at the given offset.

Throws:

InvalidRequestException

createHover

protected HoverResult createHover(java.lang.Object element,
                                  java.lang.String stateId,
                                  org.eclipse.xtext.util.CancelIndicator cancelIndicator)

addIconDivs

protected java.lang.String addIconDivs(org.eclipse.xtext.ide.labels.IImageDescription it,
                                       java.lang.String nameHtml)

surroundWithDiv

protected java.lang.String surroundWithDiv(java.lang.String html,
                                           java.lang.String... divClasses)