Eclipse Platform
Release 3.6

org.eclipse.ui.texteditor
Class HyperlinkDetectorDescriptor

java.lang.Object
  extended by org.eclipse.ui.texteditor.HyperlinkDetectorDescriptor

public final class HyperlinkDetectorDescriptor
extends java.lang.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
static java.lang.String STATE_MASK_POSTFIX
           
 
Method Summary
 boolean canActivatePlugIn()
           
 AbstractHyperlinkDetector createHyperlinkDetector()
          Creates a new IHyperlinkDetector.
 boolean equals(java.lang.Object obj)
           
static HyperlinkDetectorDescriptor[] getContributedHyperlinkDetectors()
          Returns descriptors for all hyperlink detector extensions.
 java.lang.String getDescription()
          Returns the hyperlink detector's description.
 java.lang.String getId()
          Returns the hyperlink detector's id.
 java.lang.String getModifierKeys()
          Returns the hyperlink detector's modifier keys that need to be pressed for this hyperlink detector.
 java.lang.String getName()
          Returns the hyperlink detector's name.
 HyperlinkDetectorTargetDescriptor getTarget()
          Returns the hyperlink detector's target descriptor.
 java.lang.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 java.lang.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

public AbstractHyperlinkDetector createHyperlinkDetector()
                                                  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

getId

public java.lang.String getId()
Returns the hyperlink detector's id.

Returns:
the hyperlink detector's id

getName

public java.lang.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 java.lang.String getTargetId()
Returns the hyperlink detector's target id.

Returns:
the hyperlink detector's target id

getDescription

public java.lang.String getDescription()
Returns the hyperlink detector's description.

Returns:
the hyperlink detector's description or null if not provided

getModifierKeys

public java.lang.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(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

Eclipse Platform
Release 3.6

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.