Package org.eclipse.ui.texteditor

Class HyperlinkDetectorDescriptor

java.lang.Object

org.eclipse.ui.texteditor.HyperlinkDetectorDescriptor

public final class HyperlinkDetectorDescriptor
extends Object

Describes a contribution to the 'org.eclipse.ui.workbench.texteditor.hyperlinkDetectors' extension point.

Since:

3.3

Restriction:

This class is not intended to be instantiated by clients.

Field Summary

Fields

Modifier and Type	Field	Description
static String	STATE_MASK_POSTFIX

Method Summary

Modifier and Type	Method	Description
boolean	canActivatePlugIn()
AbstractHyperlinkDetector	createHyperlinkDetector()	Deprecated. As of 3.9, replaced by createHyperlinkDetectorImplementation()
IHyperlinkDetector	createHyperlinkDetectorImplementation()	Creates a new IHyperlinkDetector.
boolean	equals(Object obj)
static HyperlinkDetectorDescriptor[]	getContributedHyperlinkDetectors()	Returns descriptors for all hyperlink detector extensions.
String	getDescription()	Returns the hyperlink detector's description.
String	getId()	Returns the hyperlink detector's id.
String	getModifierKeys()	Returns the hyperlink detector's modifier keys that need to be pressed for this hyperlink detector.
String	getName()	Returns the hyperlink detector's name.
HyperlinkDetectorTargetDescriptor	getTarget()	Returns the hyperlink detector's target descriptor.
String	getTargetId()	Returns the hyperlink detector's target id.
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

STATE_MASK_POSTFIX

public static final String STATE_MASK_POSTFIX

See Also:

Constant Field Values

Method Detail

getContributedHyperlinkDetectors

public static HyperlinkDetectorDescriptor[] getContributedHyperlinkDetectors()

Returns descriptors for all hyperlink detector extensions.

Returns:

an array with the contributed hyperlink detectors

createHyperlinkDetector

@Deprecated
public AbstractHyperlinkDetector createHyperlinkDetector()
                                                  throws CoreException

Deprecated.

As of 3.9, replaced by createHyperlinkDetectorImplementation()

Creates a new AbstractHyperlinkDetector.

Returns:

the hyperlink detector or null if the plug-in isn't loaded yet

Throws:

CoreException - if a failure occurred during creation

createHyperlinkDetectorImplementation

public IHyperlinkDetector createHyperlinkDetectorImplementation()
                                                         throws CoreException

Creates a new IHyperlinkDetector.

Returns:

the hyperlink detector or null if the plug-in isn't loaded yet

Throws:

CoreException - if a failure occurred during creation

Since:

3.9

getId

public String getId()

Returns the hyperlink detector's id.

Returns:

the hyperlink detector's id

getName

public String getName()

Returns the hyperlink detector's name.

Returns:

the hyperlink detector's name

getTarget

public HyperlinkDetectorTargetDescriptor getTarget()

Returns the hyperlink detector's target descriptor.

Returns:

the hyperlink detector's target descriptor

getTargetId

public String getTargetId()

Returns the hyperlink detector's target id.

Returns:

the hyperlink detector's target id

getDescription

public String getDescription()

Returns the hyperlink detector's description.

Returns:

the hyperlink detector's description or null if not provided

getModifierKeys

public String getModifierKeys()

Returns the hyperlink detector's modifier keys that need to be pressed for this hyperlink detector.

Returns:

the hyperlink detector's description or null if not provided

canActivatePlugIn

public boolean canActivatePlugIn()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object