com.ibm.designer.domino.xsp.api.editor
Interface IXSPHyperlinkDetector

public interface IXSPHyperlinkDetector

A detector that is used in conjunction with the com.ibm.designer.domino.xsp.editor.xpagesHyperlinkDetector extension point. The class will be provided with information about where the cursor is currently hovering and will be asked for hyperlinks for that region. If a non null value is returned that hyperlink will be executed when the hyperlink is clicked on.

Method Summary

org.eclipse.jface.text.hyperlink.IHyperlink[]

detectHyperlink(DesignerProject designerProject, org.eclipse.jface.text.IDocument document, org.eclipse.jface.text.IRegion region, org.w3c.dom.Node currentNode, org.w3c.dom.Attr currentAttribute) Called by the XPages editor to detect hyperlinks for the current region

Method Detail

detectHyperlink

org.eclipse.jface.text.hyperlink.IHyperlink[] detectHyperlink(DesignerProject designerProject,
                                                              org.eclipse.jface.text.IDocument document,
                                                              org.eclipse.jface.text.IRegion region,
                                                              org.w3c.dom.Node currentNode,
                                                              org.w3c.dom.Attr currentAttribute)

Called by the XPages editor to detect hyperlinks for the current region

Parameters:

designerProject - the DesignerProject (application) in which the currently open XPage resides

document - the editor's document

region - the region currently being hovered over

currentNode - the node (Element) under the mouse pointer

currentAttribute - the attribute under the mouse pointer (may be null)

Returns:

an array of hyperlinks, may return null