Hyperlink Detectors

Identifier:

org.eclipse.ui.workbench.texteditor.hyperlinkDetectors

Since:

3.3

Description:

This extension point is used to plug in hyperlink detectors.

Configuration Markup:

<!ELEMENT extension (hyperlinkDetector+)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

point - a fully qualified identifier of the target extension point
id - an optional identifier of the extension instance
name - an optional name of the extension instance

<!ELEMENT hyperlinkDetector EMPTY>

<!ATTLIST hyperlinkDetector

id CDATA #REQUIRED

name CDATA #REQUIRED

description CDATA #IMPLIED

targetId IDREF #REQUIRED

class CDATA #REQUIRED

activate (true | false) "true"

modifierKeys CDATA #IMPLIED>

id - a unique id that will be used to identify this hyperlink detector
name - a name that allows to identify this hyperlink detector in the UI
description - the translatable description for this hyperlink detector. Currently, this description isn't displayed anywhere in the UI by the Eclipse SDK.
targetId - the id of the hyperlink target which has been registered via org.eclipse.ui.workbench.texteditor.hyperlinkTargets extension point
class - the fully qualified class name implementing the interface org.eclipse.jface.text.hyperlink.IHyperlinkDetector. Subclass org.eclipse.jface.text.hyperlink.AbstractHyperlinkDetector if you want to access context that is provided by the target.
activate - an attribute that tells whether to activate the contributing plug-in when hyperlink detection takes place in the given target
modifierKeys - the modifier keys that need to be pressed for this hyperlink detector to be active. Valid values are: "Alt", "Ctrl", "Shift", "Command", "M1", "M2", "M3", "M4" and a combination of them separated by "+". Note that "Shift" by itself is not allowed because "Shift" + left mouse click sets the selection. If this attribute is not specified then the default modifier keys are used.

Examples:

The following is an example of a hyperlink detector definition:


<extension
  point="org.eclipse.ui.workbench.texteditor.hyperlinkDetectors">
  <hyperlinkDetector
    id="org.eclipse.example.jdt.internal.debug.ui.JavaHyperlinkDetector"
    targetId="org.eclipse.jdt.ui.javaCode"
    class="org.eclipse.example.jdt.internal.debug.ui.JavaHyperlinkDetector"
    name="%javaHyperlinkDetector">
  </hyperlinkDetector>
</extension>

Copyright (c) 2007, 2008 IBM Corporation and others.
This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html/ SPDX-License-Identifier: EPL-2.0