org.eclipse.cdt.internal.ui.text.c.hover
Class CEditorTextHoverDescriptor

java.lang.Object
  extended by org.eclipse.cdt.internal.ui.text.c.hover.CEditorTextHoverDescriptor
All Implemented Interfaces:
java.lang.Comparable

public class CEditorTextHoverDescriptor
extends java.lang.Object
implements java.lang.Comparable

CEditorTexHoverDescriptor


Field Summary
static java.lang.String DISABLED_TAG
           
static java.lang.String NO_MODIFIER
           
static java.lang.String VALUE_SEPARATOR
           
 
Method Summary
 boolean canActivatePlugIn()
           
 int compareTo(java.lang.Object o)
          
static int computeStateMask(java.lang.String modifiers)
          Computes the state mask for the given modifier string.
 ICEditorTextHover createTextHover()
          Creates the C editor text hover.
 boolean equals(java.lang.Object obj)
           
 org.eclipse.core.runtime.IConfigurationElement getConfigurationElement()
          Returns this hover descriptors configuration element.
static CEditorTextHoverDescriptor[] getContributedHovers()
          Returns all C editor text hovers contributed to the workbench.
 java.lang.String getDescription()
          Returns the hover's description.
 java.lang.String getHoverClassName()
          Returns the hover's class name.
 java.lang.String getId()
          Returns the hover's id.
 java.lang.String getLabel()
          Returns the hover's label.
 java.lang.String getModifierString()
          Returns the modifier String as set in the preference store.
 java.lang.String getPerspective()
           
 int getStateMask()
          Returns the configured modifier getStateMask for this hover.
 int hashCode()
           
 boolean isEnabled()
          Returns whether this hover is enabled or not.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NO_MODIFIER

public static final java.lang.String NO_MODIFIER
See Also:
Constant Field Values

DISABLED_TAG

public static final java.lang.String DISABLED_TAG
See Also:
Constant Field Values

VALUE_SEPARATOR

public static final java.lang.String VALUE_SEPARATOR
See Also:
Constant Field Values
Method Detail

getContributedHovers

public static CEditorTextHoverDescriptor[] getContributedHovers()
Returns all C editor text hovers contributed to the workbench.


computeStateMask

public static int computeStateMask(java.lang.String modifiers)
Computes the state mask for the given modifier string.

Parameters:
modifiers - the string with the modifiers, separated by '+', '-', ';', ',' or '.'
Returns:
the state mask or -1 if the input is invalid

createTextHover

public ICEditorTextHover createTextHover()
Creates the C editor text hover.


getId

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


getHoverClassName

public java.lang.String getHoverClassName()
Returns the hover's class name.


getLabel

public java.lang.String getLabel()
Returns the hover's label.


getDescription

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

Returns:
the hover's description or null if not provided

getPerspective

public java.lang.String getPerspective()

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

compareTo

public int compareTo(java.lang.Object o)

Specified by:
compareTo in interface java.lang.Comparable

getStateMask

public int getStateMask()
Returns the configured modifier getStateMask for this hover.

Returns:
the hover modifier stateMask or -1 if no hover is configured

getModifierString

public java.lang.String getModifierString()
Returns the modifier String as set in the preference store.

Returns:
the modifier string

isEnabled

public boolean isEnabled()
Returns whether this hover is enabled or not.

Returns:
true if enabled

getConfigurationElement

public org.eclipse.core.runtime.IConfigurationElement getConfigurationElement()
Returns this hover descriptors configuration element.

Returns:
the configuration element