|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.datatools.sqltools.sqleditor.sql.AbstractSQLEditorTextHover
org.eclipse.datatools.sqltools.sqleditor.internal.sql.SQLAnnotationHover
public class SQLAnnotationHover
This class provides annotation hover (tooltip) support for SQL syntax error and portability target annotations.
Constructor Summary | |
---|---|
SQLAnnotationHover(org.eclipse.ui.IEditorPart editor)
|
Method Summary | |
---|---|
java.lang.String |
getHoverInfo(org.eclipse.jface.text.source.ISourceViewer sourceViewer,
int lineNumber)
Returns the text which should be presented in the a hover popup window. |
java.lang.String |
getHoverInfo(org.eclipse.jface.text.ITextViewer textViewer,
org.eclipse.jface.text.IRegion hoverRegion)
Returns the information which should be presented when a hover popup is shown for the specified hover region. |
org.eclipse.jface.text.IRegion |
getHoverRegion(org.eclipse.jface.text.ITextViewer textViewer,
int offset)
Returns the text region which should serve as the source of information to compute the hover popup display information. |
void |
setEditor(org.eclipse.ui.IEditorPart editor)
Associates a SQL editor with this hover. |
Methods inherited from class org.eclipse.datatools.sqltools.sqleditor.sql.AbstractSQLEditorTextHover |
---|
getHoverControlCreator |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.eclipse.jface.text.ITextHoverExtension |
---|
getHoverControlCreator |
Constructor Detail |
---|
public SQLAnnotationHover(org.eclipse.ui.IEditorPart editor)
Method Detail |
---|
public java.lang.String getHoverInfo(org.eclipse.jface.text.ITextViewer textViewer, org.eclipse.jface.text.IRegion hoverRegion)
getHoverRegion
. If the returned
information is null
or empty no hover popup will be shown.
getHoverInfo
in interface org.eclipse.jface.text.ITextHover
textViewer
- the viewer on which the hover popup should be shownhoverRegion
- the text range in the viewer which is used to determine the hover display information
public org.eclipse.jface.text.IRegion getHoverRegion(org.eclipse.jface.text.ITextViewer textViewer, int offset)
For example, if hover information can be provided on a per method basis in a source viewer, the offset should be used to find the enclosing method and the source range of the method should be returned.
getHoverRegion
in interface org.eclipse.jface.text.ITextHover
getHoverRegion
in class AbstractSQLEditorTextHover
textViewer
- the viewer on which the hover popup should be shownoffset
- the offset for which the hover request has been issued
public java.lang.String getHoverInfo(org.eclipse.jface.text.source.ISourceViewer sourceViewer, int lineNumber)
getHoverInfo
in interface org.eclipse.jface.text.source.IAnnotationHover
sourceViewer
- the source viewer this hover is registered withlineNumber
- the line number for which information is requested
null
if no such information existspublic void setEditor(org.eclipse.ui.IEditorPart editor)
AbstractSQLEditorTextHover
setEditor
in class AbstractSQLEditorTextHover
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |