Java Doc for AnnotationPreference.java in » IDE-Eclipse » ui-workbench » org » eclipse » ui » texteditor » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » IDE Eclipse » ui workbench » org.eclipse.ui.texteditor

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.eclipse.ui.texteditor .AnnotationPreference

AnnotationPreference

public class AnnotationPreference (Code)

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
final protected static Object[]	ATTRIBUTES Array of all supported attributes.
final protected static Object	COLOR_PREFERENCE_KEY The preference key for the presentation color.
final protected static Object	COLOR_PREFERENCE_VALUE The presentation color.
final protected static Object	HEADER_VALUE Indicates whether the annotation type contributed to the overview ruler's header.
final protected static Object	HIGHLIGHT_PREFERENCE_KEY The preference key for highlighting inside text.
final protected static Object	HIGHLIGHT_PREFERENCE_VALUE The value for highlighting inside text.
final protected static Object	IMAGE_DESCRIPTOR The image to be used for drawing in the vertical ruler.
final protected static Object	IMAGE_PROVIDER The annotation image provider.
final protected static Object	INCLUDE_ON_PREFERENCE_PAGE The value for the includeOnPreferencePage property.
final protected static Object	IS_GO_TO_NEXT_TARGET_KEY The preference key for go to next navigation enablement.
final protected static Object	IS_GO_TO_NEXT_TARGET_VALUE The value for go to next navigation enablement.
final protected static Object	IS_GO_TO_PREVIOUS_TARGET_KEY The preference key for go to previous navigation enablement.
final protected static Object	IS_GO_TO_PREVIOUS_TARGET_VALUE The value for go to previous navigation enablement.
final protected static Object	OVERVIEW_RULER_PREFERENCE_KEY The preference key for the visibility in the overview ruler.
final protected static Object	OVERVIEW_RULER_PREFERENCE_VALUE The visibility in the overview ruler.
final protected static Object	PREFERENCE_LABEL The preference label.
final protected static Object	PRESENTATION_LAYER The presentation layer.
final protected static Object	QUICK_FIX_IMAGE_DESCRIPTOR The Quick Fix image to be used for drawing in the vertical ruler.
final protected static Object	SHOW_IN_NAVIGATION_DROPDOWN_KEY The preference key for the visibility in the next/previous drop down toolbar action.
final protected static Object	SHOW_IN_NAVIGATION_DROPDOWN_VALUE The value for the visibility in the next/previous drop down toolbar action.
final public static String	STYLE_BOX Constant defining box decoration for the show in text style preference.
final public static String	STYLE_DASHED_BOX Constant defining dashed box decoration for the show in text style preference.
final public static String	STYLE_IBEAM Constant defining i-beam decoration for the show in text style preference.
final public static String	STYLE_NONE Constant defining no decoration for the show in text style preference.
final public static String	STYLE_SQUIGGLES Constant defining squiggly decoration for the show in text style preference.
final public static String	STYLE_UNDERLINE Constant defining underline decoration for the show in text style preference.
final protected static Object	SYMBOLIC_IMAGE_NAME The symbolic name of the image to be drawn in the vertical ruler.
final protected static Object	TEXT_PREFERENCE_KEY The preference key for the visibility inside text.
final protected static Object	TEXT_PREFERENCE_VALUE The visibility inside text.
final protected static Object	TEXT_STYLE_PREFERENCE_KEY The preference key for the decoration style.
final protected static Object	TEXT_STYLE_PREFERENCE_VALUE The value for the text decoration style.
final protected static Object	VERTICAL_RULER_PREFERENCE_KEY The preference key for the visibility in the vertical ruler.
final protected static Object	VERTICAL_RULER_PREFERENCE_VALUE The visibility in the vertical ruler.
public IAnnotationImageProvider	fAnnotationImageProvider The annotation image provider.
public String	fAnnotationImageProviderAttribute The name of the attribute used to load the annotation image provider from the configuration element.
public IConfigurationElement	fConfigurationElement The configuration element from which to create the annotation image provider.

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

Method Summary
public boolean	contributesToHeader() Returns whether the annotation type contributes to the header of the overview ruler.
public IAnnotationImageProvider	getAnnotationImageProvider() Returns the annotation image provider.
public Object	getAnnotationType() Returns the annotation type.
protected boolean	getBooleanValue(Object attribute) Returns the value of the given attribute as boolean.
public String	getColorPreferenceKey() Returns the preference key for the presentation color.
public RGB	getColorPreferenceValue() Returns the default presentation color.
public String	getHighlightPreferenceKey() Returns the preference key for highlighting inside text.
public boolean	getHighlightPreferenceValue() Returns the default value for highlighting inside text.
public 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.
public String	getIsGoToNextNavigationTargetKey() Returns the preference key for go to next navigation enablement.
public String	getIsGoToPreviousNavigationTargetKey() Returns the preference key for go to previous navigation enablement.
public String	getMarkerType() Returns the marker type.
public String	getOverviewRulerPreferenceKey() Returns the preference key for the visibility in the overview ruler.
public boolean	getOverviewRulerPreferenceValue() Returns the default visibility in the overview ruler.
public String	getPreferenceLabel() Returns the presentation string for this annotation type.
public int	getPresentationLayer() Returns the presentation layer.
public ImageDescriptor	getQuickFixImageDescriptor() Returns the Quick Fix image descriptor for the image to be drawn in the vertical ruler.
public int	getSeverity() Returns the marker severity.
public 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.
public String	getSymbolicImageName() Returns the symbolic name of the image to be drawn in the vertical ruler.
public String	getTextPreferenceKey() Returns the preference key for the visibility inside text.
public boolean	getTextPreferenceValue() Returns the default visibility inside text.
public String	getTextStylePreferenceKey() Returns the preference key for the decoration style used when the annotation is shown in text.
public String	getTextStyleValue() Returns the value for the decoration style used when the annotation is shown in text.
public Object	getValue(Object attribute) Returns the value of the given attribute.
public String	getVerticalRulerPreferenceKey() Returns the preference key for the visibility in the vertical ruler.
public boolean	getVerticalRulerPreferenceValue() Returns the default visibility in the vertical ruler.
public boolean	hasValue(Object attribute) Returns whether the given attribute is defined.
public boolean	isGoToNextNavigationTarget() Returns the default value for go to next navigation enablement.
public boolean	isGoToPreviousNavigationTarget() Returns the default value for go to previous navigation enablement.
public boolean	isIncludeOnPreferencePage() Returns the property of the receiver of whether it should be included on the default annotation preference page.
public boolean	isPreferenceKey(String key) Returns whether the given string is a preference key.
public boolean	isShowInNextPrevDropdownToolbarAction() Returns the default value for the visibility in the next/previous drop down toolbar action.
public void	merge(AnnotationPreference preference) Merges the values of the given preference into this preference.
public void	setAnnotationImageProvider(IAnnotationImageProvider provider) Sets the annotation image provider who provides images for annotations of the specified annotation type.
public void	setAnnotationImageProviderData(IConfigurationElement configurationElement, String annotationImageProviderAttribute) Sets the data needed to create the annotation image provider.
public void	setAnnotationType(Object annotationType) Sets the annotation type.
public void	setColorPreferenceKey(String colorKey) Sets the preference key for the presentation color.
public void	setColorPreferenceValue(RGB colorValue) Sets the default presentation color.
public void	setContributesToHeader(boolean contributesToHeader) Sets whether the annotation type contributes to the overview ruler's header.
public void	setHighlightPreferenceKey(String highlightKey) Sets the preference key for highlighting inside text.
public void	setHighlightPreferenceValue(boolean highlightValue) Sets the default value for highlighting inside text.
public void	setImageDescriptor(ImageDescriptor descriptor) Sets the image descriptor for the image to be drawn in the vertical ruler.
public void	setIncludeOnPreferencePage(boolean includeOnPreferencePage) Sets the property of this annotation preference whether it should be included on the default annotation preference page.
public void	setIsGoToNextNavigationTarget(boolean isGoToNextNavigationTarget) Sets the default value for go to next navigation enablement.
public void	setIsGoToNextNavigationTargetKey(String isGoToNextNavigationTargetKey) Sets the preference key for go to next navigation enablement.
public void	setIsGoToPreviousNavigationTarget(boolean isGoToPreviousNavigationTarget) Sets the default value for go to previous navigation enablement.
public void	setIsGoToPreviousNavigationTargetKey(String isGoToPreviousNavigationTargetKey) Sets the preference key for go to previous navigation enablement.
public void	setMarkerType(String markerType) Sets the marker type.
public void	setOverviewRulerPreferenceKey(String overviewRulerKey) Sets the preference key for the visibility in the overview ruler.
public void	setOverviewRulerPreferenceValue(boolean overviewRulerValue) Sets the default visibility in the overview ruler.
public void	setPreferenceLabel(String label) Sets the presentation label of this annotation type.
public void	setPresentationLayer(int presentationLayer) Sets the presentation layer.
public void	setQuickFixImageDescriptor(ImageDescriptor descriptor) Sets the Quick Fix image descriptor for the image to be drawn in the vertical ruler.
public void	setSeverity(int severity) Sets the marker severity.
public void	setShowInNextPrevDropdownToolbarAction(boolean showInNextPrevDropdownToolbarAction) Sets the default value for the visibility in the next/previous drop down toolbar action.
public void	setShowInNextPrevDropdownToolbarActionKey(String showInNextPrevDropdownToolbarActionKey) Sets the preference key for the visibility in the next/previous drop down toolbar action.
public void	setSymbolicImageName(String symbolicImageName) Sets the symbolic name of the image to be drawn in the vertical ruler.
public void	setTextPreferenceKey(String textKey) Sets the preference key for the visibility of squiggles inside text.
public void	setTextPreferenceValue(boolean textValue) Sets the default visibility inside text.
public void	setTextStylePreferenceKey(String key) Sets the preference key for the text style property.
public void	setTextStyleValue(String value) Sets the value for the text style property.
protected void	setValue(Object attribute, Object 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, boolean value) Sets the given value for the given attribute.
public void	setVerticalRulerPreferenceKey(String verticalRulerKey) Sets the preference key for the visibility in the vertical ruler.
public void	setVerticalRulerPreferenceValue(boolean verticalRulerValue) Sets the default visibility in the vertical ruler.

Field Detail

ATTRIBUTES
final protected static Object[] ATTRIBUTES(Code)
	Array of all supported attributes. since: 3.0

COLOR_PREFERENCE_KEY
final protected static Object COLOR_PREFERENCE_KEY(Code)
	The preference key for the presentation color. since: 3.0

COLOR_PREFERENCE_VALUE
final protected static Object COLOR_PREFERENCE_VALUE(Code)
	The presentation color. since: 3.0

HEADER_VALUE
final protected static Object HEADER_VALUE(Code)
	Indicates whether the annotation type contributed to the overview ruler's header. since: 3.0

HIGHLIGHT_PREFERENCE_KEY
final protected static Object HIGHLIGHT_PREFERENCE_KEY(Code)
	The preference key for highlighting inside text. since: 3.0

HIGHLIGHT_PREFERENCE_VALUE
final protected static Object HIGHLIGHT_PREFERENCE_VALUE(Code)
	The value for highlighting inside text. since: 3.0

IMAGE_DESCRIPTOR
final protected static Object IMAGE_DESCRIPTOR(Code)
	The image to be used for drawing in the vertical ruler. since: 3.0

IMAGE_PROVIDER
final protected static Object IMAGE_PROVIDER(Code)
	The annotation image provider. since: 3.0

INCLUDE_ON_PREFERENCE_PAGE
final protected static Object INCLUDE_ON_PREFERENCE_PAGE(Code)
	The value for the includeOnPreferencePage property. since: 3.0

IS_GO_TO_NEXT_TARGET_KEY
final protected static Object IS_GO_TO_NEXT_TARGET_KEY(Code)
	The preference key for go to next navigation enablement. since: 3.0

IS_GO_TO_NEXT_TARGET_VALUE
final protected static Object IS_GO_TO_NEXT_TARGET_VALUE(Code)
	The value for go to next navigation enablement. since: 3.0

IS_GO_TO_PREVIOUS_TARGET_KEY
final protected static Object IS_GO_TO_PREVIOUS_TARGET_KEY(Code)
	The preference key for go to previous navigation enablement. since: 3.0

IS_GO_TO_PREVIOUS_TARGET_VALUE
final protected static Object IS_GO_TO_PREVIOUS_TARGET_VALUE(Code)
	The value for go to previous navigation enablement. since: 3.0

OVERVIEW_RULER_PREFERENCE_KEY
final protected static Object OVERVIEW_RULER_PREFERENCE_KEY(Code)
	The preference key for the visibility in the overview ruler. since: 3.0

OVERVIEW_RULER_PREFERENCE_VALUE
final protected static Object OVERVIEW_RULER_PREFERENCE_VALUE(Code)
	The visibility in the overview ruler. since: 3.0

PREFERENCE_LABEL
final protected static Object PREFERENCE_LABEL(Code)
	The preference label. since: 3.0

PRESENTATION_LAYER
final protected static Object PRESENTATION_LAYER(Code)
	The presentation layer. since: 3.0

QUICK_FIX_IMAGE_DESCRIPTOR
final protected static Object QUICK_FIX_IMAGE_DESCRIPTOR(Code)
	The Quick Fix image to be used for drawing in the vertical ruler. since: 3.2

SHOW_IN_NAVIGATION_DROPDOWN_KEY
final protected static Object SHOW_IN_NAVIGATION_DROPDOWN_KEY(Code)
	The preference key for the visibility in the next/previous drop down toolbar action. since: 3.0

SHOW_IN_NAVIGATION_DROPDOWN_VALUE
final protected static Object SHOW_IN_NAVIGATION_DROPDOWN_VALUE(Code)
	The value for the visibility in the next/previous drop down toolbar action. since: 3.0

STYLE_BOX
final public static String STYLE_BOX(Code)
	Constant defining box decoration for the show in text style preference. since: 3.0

STYLE_DASHED_BOX
final public static String STYLE_DASHED_BOX(Code)
	Constant defining dashed box decoration for the show in text style preference. since: 3.3

STYLE_IBEAM
final public static String STYLE_IBEAM(Code)
	Constant defining i-beam decoration for the show in text style preference. since: 3.0

STYLE_NONE
final public static String STYLE_NONE(Code)
	Constant defining no decoration for the show in text style preference. since: 3.0

STYLE_SQUIGGLES
final public static String STYLE_SQUIGGLES(Code)
	Constant defining squiggly decoration for the show in text style preference. since: 3.0

STYLE_UNDERLINE
final public static String STYLE_UNDERLINE(Code)
	Constant defining underline decoration for the show in text style preference. since: 3.0

SYMBOLIC_IMAGE_NAME
final protected static Object SYMBOLIC_IMAGE_NAME(Code)
	The symbolic name of the image to be drawn in the vertical ruler. since: 3.0

TEXT_PREFERENCE_KEY
final protected static Object TEXT_PREFERENCE_KEY(Code)
	The preference key for the visibility inside text. since: 3.0

TEXT_PREFERENCE_VALUE
final protected static Object TEXT_PREFERENCE_VALUE(Code)
	The visibility inside text. since: 3.0

TEXT_STYLE_PREFERENCE_KEY
final protected static Object TEXT_STYLE_PREFERENCE_KEY(Code)
	The preference key for the decoration style. since: 3.0

TEXT_STYLE_PREFERENCE_VALUE
final protected static Object TEXT_STYLE_PREFERENCE_VALUE(Code)
	The value for the text decoration style. since: 3.0

VERTICAL_RULER_PREFERENCE_KEY
final protected static Object VERTICAL_RULER_PREFERENCE_KEY(Code)
	The preference key for the visibility in the vertical ruler. since: 3.0

VERTICAL_RULER_PREFERENCE_VALUE
final protected static Object VERTICAL_RULER_PREFERENCE_VALUE(Code)
	The visibility in the vertical ruler. since: 3.0

fAnnotationImageProvider
public IAnnotationImageProvider fAnnotationImageProvider(Code)
	The annotation image provider. since: 3.0

fAnnotationImageProviderAttribute
public String fAnnotationImageProviderAttribute(Code)
	The name of the attribute used to load the annotation image provider from the configuration element. since: 3.0

fConfigurationElement
public IConfigurationElement fConfigurationElement(Code)
	The configuration element from which to create the annotation image provider. since: 3.0

Constructor Detail

AnnotationPreference
public AnnotationPreference()(Code)
	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)(Code)
	Creates a new annotation preference for the given annotation type. Parameters: annotationType - the annotation type Parameters: colorKey - the preference key for the presentation color Parameters: textKey - the preference key for the visibility inside text Parameters: overviewRulerKey - the preference key for the visibility in theoverview ruler Parameters: presentationLayer - the presentation layer

Method Detail

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

getAnnotationImageProvider
public IAnnotationImageProvider getAnnotationImageProvider()(Code)
	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. the annotation image provider since: 3.0

getAnnotationType
public Object getAnnotationType()(Code)
	Returns the annotation type. Should not be null in a completely set up instance. the annotation type, `null` if the receiver has notbeen initialized yet

getBooleanValue
protected boolean getBooleanValue(Object attribute)(Code)
	Returns the value of the given attribute as boolean. Parameters: attribute - the attribute the attribute value since: 3.0

getColorPreferenceKey
public String getColorPreferenceKey()(Code)
	Returns the preference key for the presentation color. the preference key for the presentation color or `null`if none is set

getColorPreferenceValue
public RGB getColorPreferenceValue()(Code)
	Returns the default presentation color. the default presentation color or `null` if none isset

getHighlightPreferenceKey
public String getHighlightPreferenceKey()(Code)
	Returns the preference key for highlighting inside text. the preference key for highlighting inside text or `null`if none is set since: 3.0

getHighlightPreferenceValue
public boolean getHighlightPreferenceValue()(Code)
	Returns the default value for highlighting inside text. the default value for highlighting inside text since: 3.0

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

getIntegerValue
protected int getIntegerValue(Object attribute)(Code)
	Returns the value of the given attribute as integer. Parameters: attribute - the attribute the attribute value since: 3.0

getIsGoToNextNavigationTargetKey
public String getIsGoToNextNavigationTargetKey()(Code)
	Returns the preference key for go to next navigation enablement. the preference key or `null` if the key is undefined since: 3.0

getIsGoToPreviousNavigationTargetKey
public String getIsGoToPreviousNavigationTargetKey()(Code)
	Returns the preference key for go to previous navigation enablement. the preference key or `null` if the key is undefined since: 3.0

getMarkerType
public String getMarkerType()(Code)
	Returns the marker type. the marker type, or `null` if none is set

getOverviewRulerPreferenceKey
public String getOverviewRulerPreferenceKey()(Code)
	Returns the preference key for the visibility in the overview ruler. the preference key for the visibility in the overview ruler or`null` if none is set

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

getPreferenceLabel
public String getPreferenceLabel()(Code)
	Returns the presentation string for this annotation type. the presentation string for this annotation type or `null`if none is set

getPresentationLayer
public int getPresentationLayer()(Code)
	Returns the presentation layer. the presentation layer

getQuickFixImageDescriptor
public ImageDescriptor getQuickFixImageDescriptor()(Code)
	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`. the image descriptor or `null` since: 3.2

getSeverity
public int getSeverity()(Code)
	Returns the marker severity. the marker severity

getShowInNextPrevDropdownToolbarActionKey
public String getShowInNextPrevDropdownToolbarActionKey()(Code)
	Returns the preference key for the visibility in the next/previous drop down toolbar action. the preference key or `null` if the key is undefined since: 3.0

getStringValue
protected String getStringValue(Object attribute)(Code)
	Returns the value of the given attribute as string. Parameters: attribute - the attribute the attribute value since: 3.0

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

getTextPreferenceKey
public String getTextPreferenceKey()(Code)
	Returns the preference key for the visibility inside text. the preference key for the visibility inside text or `null`if none is set

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

getTextStylePreferenceKey
public String getTextStylePreferenceKey()(Code)
	Returns the preference key for the decoration style used when the annotation is shown in text. the preference key for the decoration style or `null` if the key is undefined since: 3.0

getTextStyleValue
public String getTextStyleValue()(Code)
	Returns the value for the decoration style used when the annotation is shown in text. the value for the decoration style or `null` if the key is undefined since: 3.0

getValue
public Object getValue(Object attribute)(Code)
	Returns the value of the given attribute. Parameters: attribute - the attribute the attribute value since: 3.0

getVerticalRulerPreferenceKey
public String getVerticalRulerPreferenceKey()(Code)
	Returns the preference key for the visibility in the vertical ruler. the preference key for the visibility in the vertical ruler or`null` if none is set since: 3.0

getVerticalRulerPreferenceValue
public boolean getVerticalRulerPreferenceValue()(Code)
	Returns the default visibility in the vertical ruler. the default visibility in the vertical ruler since: 3.0

hasValue
public boolean hasValue(Object attribute)(Code)
	Returns whether the given attribute is defined. Parameters: attribute - the attribute `true` if the attribute has a value `false` otherwise since: 3.0

isGoToNextNavigationTarget
public boolean isGoToNextNavigationTarget()(Code)
	Returns the default value for go to next navigation enablement. `true` if enabled by default since: 3.0

isGoToPreviousNavigationTarget
public boolean isGoToPreviousNavigationTarget()(Code)
	Returns the default value for go to previous navigation enablement. `true` if enabled by default since: 3.0

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

isPreferenceKey
public boolean isPreferenceKey(String key)(Code)
	Returns whether the given string is a preference key. Parameters: key - the string to test `true` if the string is a preference key

isShowInNextPrevDropdownToolbarAction
public boolean isShowInNextPrevDropdownToolbarAction()(Code)
	Returns the default value for the visibility in the next/previous drop down toolbar action. `true` if enabled by default since: 3.0

merge
public void merge(AnnotationPreference preference)(Code)
	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

setAnnotationImageProvider
public void setAnnotationImageProvider(IAnnotationImageProvider provider)(Code)
	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)(Code)
	Sets the data needed to create the annotation image provider. Parameters: configurationElement - the configuration element Parameters: annotationImageProviderAttribute - the attribute of theconfiguration element since: 3.0

setAnnotationType
public void setAnnotationType(Object annotationType)(Code)
	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

setColorPreferenceKey
public void setColorPreferenceKey(String colorKey)(Code)
	Sets the preference key for the presentation color. Parameters: colorKey - the preference key

setColorPreferenceValue
public void setColorPreferenceValue(RGB colorValue)(Code)
	Sets the default presentation color. Parameters: colorValue - the default color

setContributesToHeader
public void setContributesToHeader(boolean contributesToHeader)(Code)
	Sets whether the annotation type contributes to the overview ruler's header. Parameters: contributesToHeader - `true` if in header, `false` otherwise

setHighlightPreferenceKey
public void setHighlightPreferenceKey(String highlightKey)(Code)
	Sets the preference key for highlighting inside text. Parameters: highlightKey - the preference key since: 3.0

setHighlightPreferenceValue
public void setHighlightPreferenceValue(boolean highlightValue)(Code)
	Sets the default value for highlighting inside text. Parameters: highlightValue - `true` if highlighted in text by default, `false` otherwise since: 3.0

setImageDescriptor
public void setImageDescriptor(ImageDescriptor descriptor)(Code)
	Sets the image descriptor for the image to be drawn in the vertical ruler. Parameters: descriptor - the image descriptor since: 3.0

setIncludeOnPreferencePage
public void setIncludeOnPreferencePage(boolean includeOnPreferencePage)(Code)
	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

setIsGoToNextNavigationTarget
public void setIsGoToNextNavigationTarget(boolean isGoToNextNavigationTarget)(Code)
	Sets the default value for go to next navigation enablement. Parameters: isGoToNextNavigationTarget - `true` if enabled by default since: 3.0

setIsGoToNextNavigationTargetKey
public void setIsGoToNextNavigationTargetKey(String isGoToNextNavigationTargetKey)(Code)
	Sets the preference key for go to next navigation enablement. Parameters: isGoToNextNavigationTargetKey - `true` if enabled by default since: 3.0

setIsGoToPreviousNavigationTarget
public void setIsGoToPreviousNavigationTarget(boolean isGoToPreviousNavigationTarget)(Code)
	Sets the default value for go to previous navigation enablement. Parameters: isGoToPreviousNavigationTarget - `true` if enabled by default since: 3.0

setIsGoToPreviousNavigationTargetKey
public void setIsGoToPreviousNavigationTargetKey(String isGoToPreviousNavigationTargetKey)(Code)
	Sets the preference key for go to previous navigation enablement. Parameters: isGoToPreviousNavigationTargetKey - the preference key since: 3.0

setMarkerType
public void setMarkerType(String markerType)(Code)
	Sets the marker type. Parameters: markerType - the marker type

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

setOverviewRulerPreferenceValue
public void setOverviewRulerPreferenceValue(boolean overviewRulerValue)(Code)
	Sets the default visibility in the overview ruler. Parameters: overviewRulerValue - `true` if visible by default, `false` otherwise

setPreferenceLabel
public void setPreferenceLabel(String label)(Code)
	Sets the presentation label of this annotation type. Parameters: label - the presentation label

setPresentationLayer
public void setPresentationLayer(int presentationLayer)(Code)
	Sets the presentation layer. Parameters: presentationLayer - the presentation layer

setQuickFixImageDescriptor
public void setQuickFixImageDescriptor(ImageDescriptor descriptor)(Code)
	Sets the Quick Fix image descriptor for the image to be drawn in the vertical ruler. Parameters: descriptor - the image descriptor since: 3.2

setSeverity
public void setSeverity(int severity)(Code)
	Sets the marker severity. Parameters: severity - the marker severity

setShowInNextPrevDropdownToolbarAction
public void setShowInNextPrevDropdownToolbarAction(boolean showInNextPrevDropdownToolbarAction)(Code)
	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

setShowInNextPrevDropdownToolbarActionKey
public void setShowInNextPrevDropdownToolbarActionKey(String showInNextPrevDropdownToolbarActionKey)(Code)
	Sets the preference key for the visibility in the next/previous drop down toolbar action. Parameters: showInNextPrevDropdownToolbarActionKey - the preference key since: 3.0

setSymbolicImageName
public void setSymbolicImageName(String symbolicImageName)(Code)
	Sets the symbolic name of the image to be drawn in the vertical ruler. Parameters: symbolicImageName - the symbolic image name since: 3.0

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

setTextPreferenceValue
public void setTextPreferenceValue(boolean textValue)(Code)
	Sets the default visibility inside text. Parameters: textValue - `true` if visible by default, `false` otherwise

setTextStylePreferenceKey
public void setTextStylePreferenceKey(String key)(Code)
	Sets the preference key for the text style property. Parameters: key - the new key since: 3.0

setTextStyleValue
public void setTextStyleValue(String value)(Code)
	Sets the value for the text style property. Parameters: value - the new text decoration style since: 3.0

setValue
protected void setValue(Object attribute, Object value)(Code)
	Sets the given value for the given attribute. Parameters: attribute - the attribute Parameters: value - the attribute value since: 3.0

setValue
protected void setValue(Object attribute, int value)(Code)
	Sets the given value for the given attribute. Parameters: attribute - the attribute Parameters: value - the attribute value since: 3.0

setValue
protected void setValue(Object attribute, boolean value)(Code)
	Sets the given value for the given attribute. Parameters: attribute - the attribute Parameters: value - the attribute value since: 3.0

setVerticalRulerPreferenceKey
public void setVerticalRulerPreferenceKey(String verticalRulerKey)(Code)
	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)(Code)
	Sets the default visibility in the vertical ruler. Parameters: verticalRulerValue - `true` if visible by default, `false` otherwise since: 3.0

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.