|
Eclipse Platform 2.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.eclipse.ui.texteditor.AnnotationPreference
An annotation preference provides all the information required for handing the preferences for the presentation of annotations of a specified type. The provided information covers:
IMarker
IMarker
Constructor Summary | |
AnnotationPreference()
Creates a new uninitialized 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. |
Object |
getAnnotationType()
Returns the annotation type. |
String |
getColorPreferenceKey()
Returns the preference key for the presentation color. |
RGB |
getColorPreferenceValue()
Returns the default presentation color. |
String |
getMarkerType()
Returns the marker type. |
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. |
int |
getSeverity()
Returns the marker severity. |
String |
getTextPreferenceKey()
Returns the preference key for the visibility inside text. |
boolean |
getTextPreferenceValue()
Returns the default visibility inside text. |
boolean |
isPreferenceKey(String key)
Returns whether the given string is a preference key. |
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 |
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 |
setSeverity(int severity)
Sets the marker serverity. |
void |
setTextPreferenceKey(String textKey)
Sets the preference key for the visibility inside text. |
void |
setTextPreferenceValue(boolean textValue)
Sets the default visibility inside text. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public AnnotationPreference()
public AnnotationPreference(Object annotationType, String colorKey, String textKey, String overviewRulerKey, int presentationLayer)
annotationType
- the annotation typecolorKey
- the preference key for the presentation colortextKey
- the preference key for the visibility inside textoverviewRulerKey
- the preference key for the visibility in the overview rulerpresentationLayer
- the presentation layerMethod Detail |
public boolean isPreferenceKey(String key)
key
- the string to testtrue
if the string is a preference keypublic Object getAnnotationType()
public String getMarkerType()
public String getColorPreferenceKey()
public RGB getColorPreferenceValue()
public String getPreferenceLabel()
public String getOverviewRulerPreferenceKey()
public boolean getOverviewRulerPreferenceValue()
public int getPresentationLayer()
public int getSeverity()
public String getTextPreferenceKey()
public boolean getTextPreferenceValue()
public boolean contributesToHeader()
true
if the annotation type contributes to the header of the overview rulerpublic void setAnnotationType(Object annotationType)
annotationType
- the annotation typepublic void setMarkerType(String markerType)
markerType
- the marker typepublic void setColorPreferenceKey(String colorKey)
colorKey
- the preference keypublic void setColorPreferenceValue(RGB colorValue)
colorValue
- the default colorpublic void setPreferenceLabel(String label)
label
- the presentation labelpublic void setOverviewRulerPreferenceKey(String overviewRulerKey)
overviewRulerKey
- the preference keypublic void setOverviewRulerPreferenceValue(boolean overviewRulerValue)
overviewRulerValue
- true
if visible by default, false
otherwisepublic void setPresentationLayer(int presentationLayer)
presentationLayer
- the presentation layerpublic void setSeverity(int severity)
severity
- the marker severitypublic void setTextPreferenceKey(String textKey)
overviewRulerKey
- the preference keypublic void setTextPreferenceValue(boolean textValue)
overviewRulerValue
- true
if visible by default, false
otherwisepublic void setContributesToHeader(boolean contributesToHeader)
contributesToHeader
- true
if in header, false
otherwise
|
Eclipse Platform 2.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |