Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.ui.texteditor
Class AnnotationPreference

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

public class AnnotationPreference
extends Object

An annotation preference provides all the information required for handing the preferences for the presentation of annotations of a specified type. The type can be changed and retrieved using the getAnnotationType and setAnnotationType methods. For each preference, getter and setter methods are provided.

Preferences that may be changed by the user also have a corresponding key that can be used to obtain the currently set value from an IPreferenceStore.

The following annotation preferences are covered:

Display Preferences controlling how and where annotations are shown

  • as text background highlighting (and respective preference key),
  • as text decorations (and respective preference key),
  • on the overview ruler (and respective preference key),
  • on the overview ruler header,
  • on the vertical ruler (and respective preference key),

Additional Display Preferences

  • the base color for annotations of this type (and respective preference key),
  • the style of text decorations that are drawn (and respective preference key),
  • the annotation image provider,
  • the quick fix image descriptor,
  • the image descriptor,
  • the symbolic image name,
  • the presentation layer.

Navigation Preferences

  • whether included in the "Go to Next Annotation" navigation action (and respective preference key),
  • whether included in the "Go to Previous Annotation" navigation action (and respective preference key),
  • whether to be shown in the "Go to Next/Previous Annotation" navigation toolbar drop down (and respective preference key).

Preference Page Preferences

  • whether the annotation type should be included on the generic annotation preference page,
  • preference label.

Since:
2.1

Field Summary
protected static  Object[] ATTRIBUTES
          Array of all supported attributes.
protected static  Object COLOR_PREFERENCE_KEY
          The preference key for the presentation color.
protected static  Object COLOR_PREFERENCE_VALUE
          The presentation color.
  IAnnotationImageProvider fAnnotationImageProvider
          The annotation image provider.
  String fAnnotationImageProviderAttribute
          The name of the attribute used to load the annotation image provider from the configuration element.
  IConfigurationElement fConfigurationElement
          The configuration element from which to create the annotation image provider.
protected static  Object HEADER_VALUE
          Indicates whether the annotation type contributed to the overview ruler's header.
protected static  Object HIGHLIGHT_PREFERENCE_KEY
          The preference key for highlighting inside text.
protected static  Object HIGHLIGHT_PREFERENCE_VALUE
          The value for highlighting inside text.
protected static  Object IMAGE_DESCRIPTOR
          The image to be used for drawing in the vertical ruler.
protected static  Object IMAGE_PROVIDER
          The annotation image provider.
protected static  Object INCLUDE_ON_PREFERENCE_PAGE
          The value for the includeOnPreferencePage property.
protected static  Object IS_GO_TO_NEXT_TARGET_KEY
          The preference key for go to next navigation enablement.
protected static  Object IS_GO_TO_NEXT_TARGET_VALUE
          The value for go to next navigation enablement.
protected static  Object IS_GO_TO_PREVIOUS_TARGET_KEY
          The preference key for go to previous navigation enablement.
protected static  Object IS_GO_TO_PREVIOUS_TARGET_VALUE
          The value for go to previous navigation enablement.
protected static  Object OVERVIEW_RULER_PREFERENCE_KEY
          The preference key for the visibility in the overview ruler.
protected static  Object OVERVIEW_RULER_PREFERENCE_VALUE
          The visibility in the overview ruler.
protected static  Object PREFERENCE_LABEL
          The preference label.
protected static  Object PRESENTATION_LAYER
          The presentation layer.
protected static  Object QUICK_FIX_IMAGE_DESCRIPTOR
          The Quick Fix image to be used for drawing in the vertical ruler.
protected static  Object SHOW_IN_NAVIGATION_DROPDOWN_KEY
          The preference key for the visibility in the next/previous drop down toolbar action.
protected static  Object SHOW_IN_NAVIGATION_DROPDOWN_VALUE
          The value for the visibility in the next/previous drop down toolbar action.
static  String STYLE_BOX
          Constant defining box decoration for the show in text style preference.
static  String STYLE_DASHED_BOX
          Constant defining dashed box decoration for the show in text style preference.
static  String STYLE_IBEAM
          Constant defining i-beam decoration for the show in text style preference.
static  String STYLE_NONE
          Constant defining no decoration for the show in text style preference.
static  String STYLE_PROBLEM_UNDERLINE
          Constant defining the native problem underline decoration for the show in text style preference.
static  String STYLE_SQUIGGLES
          Constant defining squiggly decoration for the show in text style preference.
static  String STYLE_UNDERLINE
          Constant defining underline decoration for the show in text style preference.
protected static  Object SYMBOLIC_IMAGE_NAME
          The symbolic name of the image to be drawn in the vertical ruler.
protected static  Object TEXT_PREFERENCE_KEY
          The preference key for the visibility inside text.
protected static  Object TEXT_PREFERENCE_VALUE
          The visibility inside text.
protected static  Object TEXT_STYLE_PREFERENCE_KEY
          The preference key for the decoration style.
protected static  Object TEXT_STYLE_PREFERENCE_VALUE
          The value for the text decoration style.
protected static  Object VERTICAL_RULER_PREFERENCE_KEY
          The preference key for the visibility in the vertical ruler.
protected static  Object VERTICAL_RULER_PREFERENCE_VALUE
          The visibility in the vertical ruler.
 
Constructor Summary
AnnotationPreference ()
          Creates a new un-initialized annotation preference.
AnnotationPreference ( Object annotationType, String colorKey, String textKey, String overviewRulerKey, int presentationLayer)
          Creates a new annotation preference for the given annotation type.
 
Method Summary
 boolean contributesToHeader ()
          Returns whether the annotation type contributes to the header of the overview ruler.
  IAnnotationImageProvider getAnnotationImageProvider ()
          Returns the annotation image provider.
  Object getAnnotationType ()
          Returns the annotation type.
protected  boolean getBooleanValue ( Object attribute)
          Returns the value of the given attribute as boolean.
  String getColorPreferenceKey ()
          Returns the preference key for the presentation color.
  RGB getColorPreferenceValue ()
          Returns the default presentation color.
  String getHighlightPreferenceKey ()
          Returns the preference key for highlighting inside text.
 boolean getHighlightPreferenceValue ()
          Returns the default value for highlighting inside text.
  ImageDescriptor getImageDescriptor ()
          Returns the image descriptor for the image to be drawn in the vertical ruler.
protected  int getIntegerValue ( Object attribute)
          Returns the value of the given attribute as integer.
  String getIsGoToNextNavigationTargetKey ()
          Returns the preference key for go to next navigation enablement.
  String getIsGoToPreviousNavigationTargetKey ()
          Returns the preference key for go to previous navigation enablement.
  String getMarkerType ()
          Deprecated. since 3.0
  String getOverviewRulerPreferenceKey ()
          Returns the preference key for the visibility in the overview ruler.
 boolean getOverviewRulerPreferenceValue ()
          Returns the default visibility in the overview ruler.
  String getPreferenceLabel ()
          Returns the presentation string for this annotation type.
 int getPresentationLayer ()
          Returns the presentation layer.
  ImageDescriptor getQuickFixImageDescriptor ()
          Returns the Quick Fix image descriptor for the image to be drawn in the vertical ruler.
 int getSeverity ()
          Deprecated. since 3.0
  String getShowInNextPrevDropdownToolbarActionKey ()
          Returns the preference key for the visibility in the next/previous drop down toolbar action.
protected   String getStringValue ( Object attribute)
          Returns the value of the given attribute as string.
  String getSymbolicImageName ()
          Returns the symbolic name of the image to be drawn in the vertical ruler.
  String getTextPreferenceKey ()
          Returns the preference key for the visibility inside text.
 boolean getTextPreferenceValue ()
          Returns the default visibility inside text.
  String getTextStylePreferenceKey ()
          Returns the preference key for the decoration style used when the annotation is shown in text.
  String getTextStyleValue ()
          Returns the value for the decoration style used when the annotation is shown in text.
  Object getValue ( Object attribute)
          Returns the value of the given attribute.
  String getVerticalRulerPreferenceKey ()
          Returns the preference key for the visibility in the vertical ruler.
 boolean getVerticalRulerPreferenceValue ()
          Returns the default visibility in the vertical ruler.
 boolean hasValue ( Object attribute)
          Returns whether the given attribute is defined.
 boolean isGoToNextNavigationTarget ()
          Returns the default value for go to next navigation enablement.
 boolean isGoToPreviousNavigationTarget ()
          Returns the default value for go to previous navigation enablement.
 boolean isIncludeOnPreferencePage ()
          Returns the property of the receiver of whether it should be included on the default annotation preference page.
 boolean isPreferenceKey ( String key)
          Returns whether the given string is a preference key.
 boolean isShowInNextPrevDropdownToolbarAction ()
          Returns the default value for the visibility in the next/previous drop down toolbar action.
 void merge ( AnnotationPreference preference)
          Merges the values of the given preference into this preference.
 void setAnnotationImageProvider ( IAnnotationImageProvider provider)
          Sets the annotation image provider who provides images for annotations of the specified annotation type.
 void setAnnotationImageProviderData ( IConfigurationElement configurationElement, String annotationImageProviderAttribute)
          Sets the data needed to create the annotation image provider.
 void setAnnotationType ( Object annotationType)
          Sets the annotation type.
 void setColorPreferenceKey ( String colorKey)
          Sets the preference key for the presentation color.
 void setColorPreferenceValue ( RGB colorValue)
          Sets the default presentation color.
 void setContributesToHeader (boolean contributesToHeader)
          Sets whether the annotation type contributes to the overview ruler's header.
 void setHighlightPreferenceKey ( String highlightKey)
          Sets the preference key for highlighting inside text.
 void setHighlightPreferenceValue (boolean highlightValue)
          Sets the default value for highlighting inside text.
 void setImageDescriptor ( ImageDescriptor descriptor)
          Sets the image descriptor for the image to be drawn in the vertical ruler.
 void setIncludeOnPreferencePage (boolean includeOnPreferencePage)
          Sets the property of this annotation preference whether it should be included on the default annotation preference page.
 void setIsGoToNextNavigationTarget (boolean isGoToNextNavigationTarget)
          Sets the default value for go to next navigation enablement.
 void setIsGoToNextNavigationTargetKey ( String isGoToNextNavigationTargetKey)
          Sets the preference key for go to next navigation enablement.
 void setIsGoToPreviousNavigationTarget (boolean isGoToPreviousNavigationTarget)
          Sets the default value for go to previous navigation enablement.
 void setIsGoToPreviousNavigationTargetKey ( String isGoToPreviousNavigationTargetKey)
          Sets the preference key for go to previous navigation enablement.
 void setMarkerType ( String markerType)
          Sets the marker type.
 void setOverviewRulerPreferenceKey ( String overviewRulerKey)
          Sets the preference key for the visibility in the overview ruler.
 void setOverviewRulerPreferenceValue (boolean overviewRulerValue)
          Sets the default visibility in the overview ruler.
 void setPreferenceLabel ( String label)
          Sets the presentation label of this annotation type.
 void setPresentationLayer (int presentationLayer)
          Sets the presentation layer.
 void setQuickFixImageDescriptor ( ImageDescriptor descriptor)
          Sets the Quick Fix image descriptor for the image to be drawn in the vertical ruler.
 void setSeverity (int severity)
          Sets the marker severity.
 void setShowInNextPrevDropdownToolbarAction (boolean showInNextPrevDropdownToolbarAction)
          Sets the default value for the visibility in the next/previous drop down toolbar action.
 void setShowInNextPrevDropdownToolbarActionKey ( String showInNextPrevDropdownToolbarActionKey)
          Sets the preference key for the visibility in the next/previous drop down toolbar action.
 void setSymbolicImageName ( String symbolicImageName)
          Sets the symbolic name of the image to be drawn in the vertical ruler.
 void setTextPreferenceKey ( String textKey)
          Sets the preference key for the visibility of squiggles inside text.
 void setTextPreferenceValue (boolean textValue)
          Sets the default visibility inside text.
 void setTextStylePreferenceKey ( String key)
          Sets the preference key for the text style property.
 void setTextStyleValue ( String value)
          Sets the value for the text style property.
protected  void setValue ( Object attribute, boolean value)
          Sets the given value for the given attribute.
protected  void setValue ( Object attribute, int value)
          Sets the given value for the given attribute.
protected  void setValue ( Object attribute, Object value)
          Sets the given value for the given attribute.
 void setVerticalRulerPreferenceKey ( String verticalRulerKey)
          Sets the preference key for the visibility in the vertical ruler.
 void setVerticalRulerPreferenceValue (boolean verticalRulerValue)
          Sets the default visibility in the vertical ruler.
 
Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STYLE_NONE

public static final 
String STYLE_NONE
Constant defining no decoration for the show in text style preference.

Since:
3.0
See Also:
Constant Field Values

STYLE_SQUIGGLES

public static final 
String STYLE_SQUIGGLES
Constant defining squiggly decoration for the show in text style preference.

Since:
3.0
See Also:
Constant Field Values

STYLE_PROBLEM_UNDERLINE

public static final 
String STYLE_PROBLEM_UNDERLINE
Constant defining the native problem underline decoration for the show in text style preference.

The look of this style is platform dependent.

Since:
3.4
See Also:
Constant Field Values

STYLE_BOX

public static final 
String STYLE_BOX
Constant defining box decoration for the show in text style preference.

Since:
3.0
See Also:
Constant Field Values

STYLE_DASHED_BOX

public static final 
String STYLE_DASHED_BOX
Constant defining dashed box decoration for the show in text style preference.

Since:
3.3
See Also:
Constant Field Values

STYLE_UNDERLINE

public static final 
String STYLE_UNDERLINE
Constant defining underline decoration for the show in text style preference.

Since:
3.0
See Also:
Constant Field Values

STYLE_IBEAM

public static final 
String STYLE_IBEAM
Constant defining i-beam decoration for the show in text style preference.

Since:
3.0
See Also:
Constant Field Values

IMAGE_DESCRIPTOR

protected static final 
Object IMAGE_DESCRIPTOR
The image to be used for drawing in the vertical ruler.

Since:
3.0

QUICK_FIX_IMAGE_DESCRIPTOR

protected static final 
Object QUICK_FIX_IMAGE_DESCRIPTOR
The Quick Fix image to be used for drawing in the vertical ruler.

Since:
3.2

PREFERENCE_LABEL

protected static final 
Object PREFERENCE_LABEL
The preference label.

Since:
3.0

PRESENTATION_LAYER

protected static final 
Object PRESENTATION_LAYER
The presentation layer.

Since:
3.0

SYMBOLIC_IMAGE_NAME

protected static final 
Object SYMBOLIC_IMAGE_NAME
The symbolic name of the image to be drawn in the vertical ruler.

Since:
3.0

HEADER_VALUE

protected static final 
Object HEADER_VALUE
Indicates whether the annotation type contributed to the overview ruler's header.

Since:
3.0

IMAGE_PROVIDER

protected static final 
Object IMAGE_PROVIDER
The annotation image provider.

Since:
3.0

INCLUDE_ON_PREFERENCE_PAGE

protected static final 
Object INCLUDE_ON_PREFERENCE_PAGE
The value for the includeOnPreferencePage property.

Since:
3.0

TEXT_PREFERENCE_KEY

protected static final 
Object TEXT_PREFERENCE_KEY
The preference key for the visibility inside text.

Since:
3.0

TEXT_PREFERENCE_VALUE

protected static final 
Object TEXT_PREFERENCE_VALUE
The visibility inside text.

Since:
3.0

COLOR_PREFERENCE_KEY

protected static final 
Object COLOR_PREFERENCE_KEY
The preference key for the presentation color.

Since:
3.0

COLOR_PREFERENCE_VALUE

protected static final 
Object COLOR_PREFERENCE_VALUE
The presentation color.

Since:
3.0

HIGHLIGHT_PREFERENCE_KEY

protected static final 
Object HIGHLIGHT_PREFERENCE_KEY
The preference key for highlighting inside text.

Since:
3.0

HIGHLIGHT_PREFERENCE_VALUE

protected static final 
Object HIGHLIGHT_PREFERENCE_VALUE
The value for highlighting inside text.

Since:
3.0

IS_GO_TO_NEXT_TARGET_KEY

protected static final 
Object IS_GO_TO_NEXT_TARGET_KEY
The preference key for go to next navigation enablement.

Since:
3.0

IS_GO_TO_NEXT_TARGET_VALUE

protected static final 
Object IS_GO_TO_NEXT_TARGET_VALUE
The value for go to next navigation enablement.

Since:
3.0

IS_GO_TO_PREVIOUS_TARGET_KEY

protected static final 
Object IS_GO_TO_PREVIOUS_TARGET_KEY
The preference key for go to previous navigation enablement.

Since:
3.0

IS_GO_TO_PREVIOUS_TARGET_VALUE

protected static final 
Object IS_GO_TO_PREVIOUS_TARGET_VALUE
The value for go to previous navigation enablement.

Since:
3.0

VERTICAL_RULER_PREFERENCE_KEY

protected static final 
Object VERTICAL_RULER_PREFERENCE_KEY
The preference key for the visibility in the vertical ruler.

Since:
3.0

VERTICAL_RULER_PREFERENCE_VALUE

protected static final 
Object VERTICAL_RULER_PREFERENCE_VALUE
The visibility in the vertical ruler.

Since:
3.0

OVERVIEW_RULER_PREFERENCE_KEY

protected static final 
Object OVERVIEW_RULER_PREFERENCE_KEY
The preference key for the visibility in the overview ruler.

Since:
3.0

OVERVIEW_RULER_PREFERENCE_VALUE

protected static final 
Object OVERVIEW_RULER_PREFERENCE_VALUE
The visibility in the overview ruler.

Since:
3.0

SHOW_IN_NAVIGATION_DROPDOWN_KEY

protected static final 
Object SHOW_IN_NAVIGATION_DROPDOWN_KEY
The preference key for the visibility in the next/previous drop down toolbar action.

Since:
3.0

SHOW_IN_NAVIGATION_DROPDOWN_VALUE

protected static final 
Object SHOW_IN_NAVIGATION_DROPDOWN_VALUE
The value for the visibility in the next/previous drop down toolbar action.

Since:
3.0

TEXT_STYLE_PREFERENCE_KEY

protected static final 
Object TEXT_STYLE_PREFERENCE_KEY
The preference key for the decoration style.

Since:
3.0

TEXT_STYLE_PREFERENCE_VALUE

protected static final 
Object TEXT_STYLE_PREFERENCE_VALUE
The value for the text decoration style.

Since:
3.0

ATTRIBUTES

protected static final 
Object[] ATTRIBUTES
Array of all supported attributes.

Since:
3.0

fAnnotationImageProvider

public 
IAnnotationImageProvider fAnnotationImageProvider
The annotation image provider.

Since:
3.0

fConfigurationElement

public 
IConfigurationElement fConfigurationElement
The configuration element from which to create the annotation image provider.

Since:
3.0

fAnnotationImageProviderAttribute

public 
String fAnnotationImageProviderAttribute
The name of the attribute used to load the annotation image provider from the configuration element.

Since:
3.0
Constructor Detail

AnnotationPreference

public AnnotationPreference()
Creates a new un-initialized annotation preference. Note that instances with a null annotation type are invalid and should not be used.


AnnotationPreference

public AnnotationPreference(
Object annotationType,
                            
String colorKey,
                            
String textKey,
                            
String overviewRulerKey,
                            int presentationLayer)
Creates a new annotation preference for the given annotation type.

Parameters:
annotationType - the annotation type
colorKey - the preference key for the presentation color
textKey - the preference key for the visibility inside text
overviewRulerKey - the preference key for the visibility in the overview ruler
presentationLayer - the presentation layer
Method Detail

setValue

protected void setValue(
Object attribute,
                        
Object value)
Sets the given value for the given attribute.

Parameters:
attribute - the attribute
value - the attribute value
Since:
3.0

setValue

protected void setValue(
Object attribute,
                        int value)
Sets the given value for the given attribute.

Parameters:
attribute - the attribute
value - the attribute value
Since:
3.0

setValue

protected void setValue(
Object attribute,
                        boolean value)
Sets the given value for the given attribute.

Parameters:
attribute - the attribute
value - the attribute value
Since:
3.0

getStringValue

protected 
String getStringValue(
Object attribute)
Returns the value of the given attribute as string.

Parameters:
attribute - the attribute
Returns:
the attribute value
Since:
3.0

getBooleanValue

protected boolean getBooleanValue(
Object attribute)
Returns the value of the given attribute as boolean.

Parameters:
attribute - the attribute
Returns:
the attribute value
Since:
3.0

getIntegerValue

protected int getIntegerValue(
Object attribute)
Returns the value of the given attribute as integer.

Parameters:
attribute - the attribute
Returns:
the attribute value
Since:
3.0

getValue

public 
Object getValue(
Object attribute)
Returns the value of the given attribute.

Parameters:
attribute - the attribute
Returns:
the attribute value
Since:
3.0

hasValue

public boolean hasValue(
Object attribute)
Returns whether the given attribute is defined.

Parameters:
attribute - the attribute
Returns:
true if the attribute has a value false otherwise
Since:
3.0

isPreferenceKey

public boolean isPreferenceKey(
String key)
Returns whether the given string is a preference key.

Parameters:
key - the string to test
Returns:
true if the string is a preference key

getAnnotationType

public 
Object getAnnotationType()
Returns the annotation type. Should not be null in a completely set up instance.

Returns:
the annotation type, null if the receiver has not been initialized yet

getMarkerType

public 
String getMarkerType()
Deprecated. since 3.0

Returns the marker type.

Returns:
the marker type, or null if none is set

getSeverity

public int getSeverity()
Deprecated. since 3.0

Returns the marker severity.

Returns:
the marker severity

setAnnotationType

public void setAnnotationType(
Object annotationType)
Sets the annotation type. Note that instances with a null annotation type are considered invalid and should not be used with the framework.

Parameters:
annotationType - the annotation type

setMarkerType

public void setMarkerType(
String markerType)
Sets the marker type.

Parameters:
markerType - the marker type

setSeverity

public void setSeverity(int severity)
Sets the marker severity.

Parameters:
severity - the marker severity

getColorPreferenceKey

public 
String getColorPreferenceKey()
Returns the preference key for the presentation color.

Returns:
the preference key for the presentation color or null if none is set

getColorPreferenceValue

public 
RGB getColorPreferenceValue()
Returns the default presentation color.

Returns:
the default presentation color or null if none is set

getPreferenceLabel

public 
String getPreferenceLabel()
Returns the presentation string for this annotation type.

Returns:
the presentation string for this annotation type or null if none is set

getOverviewRulerPreferenceKey

public 
String getOverviewRulerPreferenceKey()
Returns the preference key for the visibility in the overview ruler.

Returns:
the preference key for the visibility in the overview ruler or null if none is set

getOverviewRulerPreferenceValue

public boolean getOverviewRulerPreferenceValue()
Returns the default visibility in the overview ruler.

Returns:
the default visibility in the overview ruler

getVerticalRulerPreferenceKey

public 
String getVerticalRulerPreferenceKey()
Returns the preference key for the visibility in the vertical ruler.

Returns:
the preference key for the visibility in the vertical ruler or null if none is set
Since:
3.0

getVerticalRulerPreferenceValue

public boolean getVerticalRulerPreferenceValue()
Returns the default visibility in the vertical ruler.

Returns:
the default visibility in the vertical ruler
Since:
3.0

getPresentationLayer

public int getPresentationLayer()
Returns the presentation layer.

Returns:
the presentation layer

getTextPreferenceKey

public 
String getTextPreferenceKey()
Returns the preference key for the visibility inside text.

Returns:
the preference key for the visibility inside text or null if none is set

getTextPreferenceValue

public boolean getTextPreferenceValue()
Returns the default visibility inside text.

Returns:
the default visibility inside text

getHighlightPreferenceKey

public 
String getHighlightPreferenceKey()
Returns the preference key for highlighting inside text.

Returns:
the preference key for highlighting inside text or null if none is set
Since:
3.0

getHighlightPreferenceValue

public boolean getHighlightPreferenceValue()
Returns the default value for highlighting inside text.

Returns:
the default value for highlighting inside text
Since:
3.0

contributesToHeader

public boolean contributesToHeader()
Returns whether the annotation type contributes to the header of the overview ruler.

Returns:
true if the annotation type contributes to the header of the overview ruler

setColorPreferenceKey

public void setColorPreferenceKey(
String colorKey)
Sets the preference key for the presentation color.

Parameters:
colorKey - the preference key

setColorPreferenceValue

public void setColorPreferenceValue(
RGB colorValue)
Sets the default presentation color.

Parameters:
colorValue - the default color

setPreferenceLabel

public void setPreferenceLabel(
String label)
Sets the presentation label of this annotation type.

Parameters:
label - the presentation label

setOverviewRulerPreferenceKey

public void setOverviewRulerPreferenceKey(
String overviewRulerKey)
Sets the preference key for the visibility in the overview ruler.

Parameters:
overviewRulerKey - the preference key

setOverviewRulerPreferenceValue

public void setOverviewRulerPreferenceValue(boolean overviewRulerValue)
Sets the default visibility in the overview ruler.

Parameters:
overviewRulerValue - true if visible by default, false otherwise

setVerticalRulerPreferenceKey

public void setVerticalRulerPreferenceKey(
String verticalRulerKey)
Sets the preference key for the visibility in the vertical ruler.

Parameters:
verticalRulerKey - the preference key
Since:
3.0

setVerticalRulerPreferenceValue

public void setVerticalRulerPreferenceValue(boolean verticalRulerValue)
Sets the default visibility in the vertical ruler.

Parameters:
verticalRulerValue - true if visible by default, false otherwise
Since:
3.0

setPresentationLayer

public void setPresentationLayer(int presentationLayer)
Sets the presentation layer.

Parameters:
presentationLayer - the presentation layer

setTextPreferenceKey

public void setTextPreferenceKey(
String textKey)
Sets the preference key for the visibility of squiggles inside text.

Parameters:
textKey - the preference key

setTextPreferenceValue

public void setTextPreferenceValue(boolean textValue)
Sets the default visibility inside text.

Parameters:
textValue - true if visible by default, false otherwise

setHighlightPreferenceKey

public void setHighlightPreferenceKey(
String highlightKey)
Sets the preference key for highlighting inside text.

Parameters:
highlightKey - the preference key
Since:
3.0

setHighlightPreferenceValue

public void setHighlightPreferenceValue(boolean highlightValue)
Sets the default value for highlighting inside text.

Parameters:
highlightValue - true if highlighted in text by default, false otherwise
Since:
3.0

setContributesToHeader

public void setContributesToHeader(boolean contributesToHeader)
Sets whether the annotation type contributes to the overview ruler's header.

Parameters:
contributesToHeader - true if in header, false otherwise

isGoToNextNavigationTarget

public boolean isGoToNextNavigationTarget()
Returns the default value for go to next navigation enablement.

Returns:
true if enabled by default
Since:
3.0

setIsGoToNextNavigationTarget

public void setIsGoToNextNavigationTarget(boolean isGoToNextNavigationTarget)
Sets the default value for go to next navigation enablement.

Parameters:
isGoToNextNavigationTarget - true if enabled by default
Since:
3.0

getIsGoToNextNavigationTargetKey

public 
String getIsGoToNextNavigationTargetKey()
Returns the preference key for go to next navigation enablement.

Returns:
the preference key or null if the key is undefined
Since:
3.0

setIsGoToNextNavigationTargetKey

public void setIsGoToNextNavigationTargetKey(
String isGoToNextNavigationTargetKey)
Sets the preference key for go to next navigation enablement.

Parameters:
isGoToNextNavigationTargetKey - true if enabled by default
Since:
3.0

isGoToPreviousNavigationTarget

public boolean isGoToPreviousNavigationTarget()
Returns the default value for go to previous navigation enablement.

Returns:
true if enabled by default
Since:
3.0

setIsGoToPreviousNavigationTarget

public void setIsGoToPreviousNavigationTarget(boolean isGoToPreviousNavigationTarget)
Sets the default value for go to previous navigation enablement.

Parameters:
isGoToPreviousNavigationTarget - true if enabled by default
Since:
3.0

getIsGoToPreviousNavigationTargetKey

public 
String getIsGoToPreviousNavigationTargetKey()
Returns the preference key for go to previous navigation enablement.

Returns:
the preference key or null if the key is undefined
Since:
3.0

setIsGoToPreviousNavigationTargetKey

public void setIsGoToPreviousNavigationTargetKey(
String isGoToPreviousNavigationTargetKey)
Sets the preference key for go to previous navigation enablement.

Parameters:
isGoToPreviousNavigationTargetKey - the preference key
Since:
3.0

getShowInNextPrevDropdownToolbarActionKey

public 
String getShowInNextPrevDropdownToolbarActionKey()
Returns the preference key for the visibility in the next/previous drop down toolbar action.

Returns:
the preference key or null if the key is undefined
Since:
3.0

setShowInNextPrevDropdownToolbarActionKey

public void setShowInNextPrevDropdownToolbarActionKey(
String showInNextPrevDropdownToolbarActionKey)
Sets the preference key for the visibility in the next/previous drop down toolbar action.

Parameters:
showInNextPrevDropdownToolbarActionKey - the preference key
Since:
3.0

isShowInNextPrevDropdownToolbarAction

public boolean isShowInNextPrevDropdownToolbarAction()
Returns the default value for the visibility in the next/previous drop down toolbar action.

Returns:
true if enabled by default
Since:
3.0

setShowInNextPrevDropdownToolbarAction

public void setShowInNextPrevDropdownToolbarAction(boolean showInNextPrevDropdownToolbarAction)
Sets the default value for the visibility in the next/previous drop down toolbar action.

Parameters:
showInNextPrevDropdownToolbarAction - true if enabled by default
Since:
3.0

setTextStylePreferenceKey

public void setTextStylePreferenceKey(
String key)
Sets the preference key for the text style property.

Parameters:
key - the new key
Since:
3.0

getTextStylePreferenceKey

public 
String getTextStylePreferenceKey()
Returns the preference key for the decoration style used when the annotation is shown in text.

Returns:
the preference key for the decoration style or null if the key is undefined
Since:
3.0

getTextStyleValue

public 
String getTextStyleValue()
Returns the value for the decoration style used when the annotation is shown in text.

Returns:
the value for the decoration style or null if the key is undefined
Since:
3.0

setTextStyleValue

public void setTextStyleValue(
String value)
Sets the value for the text style property.

Parameters:
value - the new text decoration style
Since:
3.0

getImageDescriptor

public 
ImageDescriptor getImageDescriptor()
Returns the image descriptor for the image to be drawn in the vertical ruler. The provided image is only used, if getAnnotationImageProvider returns null.

Returns:
the image descriptor or null
Since:
3.0

setImageDescriptor

public void setImageDescriptor(
ImageDescriptor descriptor)
Sets the image descriptor for the image to be drawn in the vertical ruler.

Parameters:
descriptor - the image descriptor
Since:
3.0

getSymbolicImageName

public 
String getSymbolicImageName()
Returns the symbolic name of the image to be drawn in the vertical ruler. The image is only used if getImageDescriptor returns null.

Returns:
the symbolic name of the image or null
Since:
3.0

setSymbolicImageName

public void setSymbolicImageName(
String symbolicImageName)
Sets the symbolic name of the image to be drawn in the vertical ruler.

Parameters:
symbolicImageName - the symbolic image name
Since:
3.0

getAnnotationImageProvider

public 
IAnnotationImageProvider getAnnotationImageProvider()
Returns the annotation image provider. If no default annotation image provider has been set, this method checks whether the annotation image provider data has been set. If so, an annotation image provider is created if the configuration element's plug-in is loaded. When an annotation image provider has been created successfully, it is set as the default annotation image provider.

Returns:
the annotation image provider
Since:
3.0

setAnnotationImageProvider

public void setAnnotationImageProvider(
IAnnotationImageProvider provider)
Sets the annotation image provider who provides images for annotations of the specified annotation type.

Parameters:
provider - the annotation image provider
Since:
3.0

setAnnotationImageProviderData

public void setAnnotationImageProviderData(
IConfigurationElement configurationElement,
                                           
String annotationImageProviderAttribute)
Sets the data needed to create the annotation image provider.

Parameters:
configurationElement - the configuration element
annotationImageProviderAttribute - the attribute of the configuration element
Since:
3.0

setIncludeOnPreferencePage

public void setIncludeOnPreferencePage(boolean includeOnPreferencePage)
Sets the property of this annotation preference whether it should be included on the default annotation preference page.

Parameters:
includeOnPreferencePage - the new value
Since:
3.0

isIncludeOnPreferencePage

public boolean isIncludeOnPreferencePage()
Returns the property of the receiver of whether it should be included on the default annotation preference page.

Returns:
the includeOnPreferencePage property
Since:
3.0

merge

public void merge(
AnnotationPreference preference)
Merges the values of the given preference into this preference. Existing values will not be overwritten. Subclasses may extend.

Parameters:
preference - the preference to merge into this preference
Since:
3.0

setQuickFixImageDescriptor

public void setQuickFixImageDescriptor(
ImageDescriptor descriptor)
Sets the Quick Fix image descriptor for the image to be drawn in the vertical ruler.

Parameters:
descriptor - the image descriptor
Since:
3.2

getQuickFixImageDescriptor

public 
ImageDescriptor getQuickFixImageDescriptor()
Returns the Quick Fix image descriptor for the image to be drawn in the vertical ruler. The provided image is only used, if getAnnotationImageProvider returns null.

Returns:
the image descriptor or null
Since:
3.2

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

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


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire