Eclipse Platform
Release 3.0

org.eclipse.ui.texteditor
Class AbstractDecoratedTextEditorPreferenceConstants

java.lang.Object
  extended byorg.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants

public class AbstractDecoratedTextEditorPreferenceConstants
extends Object

Preference constants used in the extended text editor preference store.

Since:
3.0

Field Summary
static String EDITOR_CURRENT_LINE
          A named preference that controls whether the current line highlighting is turned on or off (value "currentLine").
static String EDITOR_CURRENT_LINE_COLOR
          A named preference that holds the color used to highlight the current line (value "currentLineColor").
static String EDITOR_LINE_NUMBER_RULER
          A named preference that controls if the line number ruler is shown in the UI (value "lineNumberRuler").
static String EDITOR_LINE_NUMBER_RULER_COLOR
          A named preference that holds the color used to render line numbers inside the line number ruler (value "lineNumberColor").
static String EDITOR_OVERVIEW_RULER
          A named preference that controls if the overview ruler is shown in the UI (value "overviewRuler").
static String EDITOR_PRINT_MARGIN
          A named preference that controls whether the print margin is turned on or off (value "printMargin").
static String EDITOR_PRINT_MARGIN_COLOR
          A named preference that holds the color used to render the print margin (value "printMarginColor").
static String EDITOR_PRINT_MARGIN_COLUMN
          Print margin column (value "printMarginColumn").
static String EDITOR_SELECTION_BACKGROUND_COLOR
          A named preference that holds the color used as the text selection background.
static String EDITOR_SELECTION_BACKGROUND_DEFAULT_COLOR
          A named preference that describes if the system default selection background color is used as the text selection background.
static String EDITOR_SELECTION_FOREGROUND_COLOR
          A named preference that holds the color used as the text selection foreground.
static String EDITOR_SELECTION_FOREGROUND_DEFAULT_COLOR
          A named preference that describes if the system default selection foreground color is used as the text selection foreground.
static String EDITOR_TAB_WIDTH
          A named preference that holds the number of spaces used per tab in the text editor.
static String EDITOR_UNKNOWN_INDICATION
          Deprecated. as of 3.0 there are no UNKNOWN annotations any more
static String EDITOR_UNKNOWN_INDICATION_COLOR
          Deprecated. As of 3.0, there are no UNKNOWN annotations any more
static String EDITOR_UNKNOWN_INDICATION_IN_OVERVIEW_RULER
          Deprecated. As of 3.0, there are no UNKNOWN annotations any more
static String EDITOR_USE_CUSTOM_CARETS
          A named preference that controls whether custom carets are used in the editor or not.
static String EDITOR_WIDE_CARET
          A named preference that controls whether carets are drawn wide or not.
static String QUICK_DIFF_ALWAYS_ON
          A named preference that controls whether quick diff colors are shown on the line number bar.
static String QUICK_DIFF_CHARACTER_MODE
          A named preference that controls the default quick diff reference provider.
static String QUICK_DIFF_DEFAULT_PROVIDER
          A named preference that controls the default quick diff reference provider.
static String USE_ANNOTATIONS_PREFERENCE_PAGE
          A named preference that controls whether this plug-in's Annotations preference page is used to configure annotations.
static String USE_QUICK_DIFF_PREFERENCE_PAGE
          A named preference that controls whether this plug-in's Quick Diff preference page is used to configure Quick Diff.
 
Method Summary
static void initializeDefaultValues(IPreferenceStore store)
          Initializes the given preference store with the default values.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EDITOR_CURRENT_LINE

public static final String EDITOR_CURRENT_LINE
A named preference that controls whether the current line highlighting is turned on or off (value "currentLine").

The preference value is of type Boolean.

See Also:
Constant Field Values

EDITOR_CURRENT_LINE_COLOR

public static final String EDITOR_CURRENT_LINE_COLOR
A named preference that holds the color used to highlight the current line (value "currentLineColor").

The preference value is of type String. A RGB color value encoded as a string using class PreferenceConverter.

See Also:
StringConverter, PreferenceConverter, Constant Field Values

EDITOR_TAB_WIDTH

public static final String EDITOR_TAB_WIDTH
A named preference that holds the number of spaces used per tab in the text editor.

Value is of type int: positive int value specifying the number of spaces per tab.

See Also:
Constant Field Values

EDITOR_PRINT_MARGIN

public static final String EDITOR_PRINT_MARGIN
A named preference that controls whether the print margin is turned on or off (value "printMargin").

The preference value is of type Boolean.

See Also:
Constant Field Values

EDITOR_PRINT_MARGIN_COLOR

public static final String EDITOR_PRINT_MARGIN_COLOR
A named preference that holds the color used to render the print margin (value "printMarginColor").

The preference value is of type String. A RGB color value encoded as a string using class PreferenceConverter.

See Also:
StringConverter, PreferenceConverter, Constant Field Values

EDITOR_PRINT_MARGIN_COLUMN

public static final String EDITOR_PRINT_MARGIN_COLUMN
Print margin column (value "printMarginColumn").

The preference value is of type int.

See Also:
Constant Field Values

EDITOR_UNKNOWN_INDICATION

public static final String EDITOR_UNKNOWN_INDICATION
Deprecated. as of 3.0 there are no UNKNOWN annotations any more

A named preference that controls whether the editor shows unknown indicators in text (squiggly lines). (value "othersIndication").

The preference value is of type Boolean.

See Also:
Constant Field Values

EDITOR_UNKNOWN_INDICATION_COLOR

public static final String EDITOR_UNKNOWN_INDICATION_COLOR
Deprecated. As of 3.0, there are no UNKNOWN annotations any more

A named preference that holds the color used to render unknown indicators (value "othersIndicationColor").

The preference value is of type String. A RGB color value encoded as a string using class PreferenceConverter.

See Also:
EDITOR_UNKNOWN_INDICATION, StringConverter, PreferenceConverter, Constant Field Values

EDITOR_UNKNOWN_INDICATION_IN_OVERVIEW_RULER

public static final String EDITOR_UNKNOWN_INDICATION_IN_OVERVIEW_RULER
Deprecated. As of 3.0, there are no UNKNOWN annotations any more

A named preference that controls whether the overview ruler shows unknown indicators (value "othersIndicationInOverviewRuler").

The preference value is of type Boolean.

See Also:
Constant Field Values

EDITOR_OVERVIEW_RULER

public static final String EDITOR_OVERVIEW_RULER
A named preference that controls if the overview ruler is shown in the UI (value "overviewRuler").

The preference value is of type Boolean.

See Also:
Constant Field Values

EDITOR_LINE_NUMBER_RULER

public static final String EDITOR_LINE_NUMBER_RULER
A named preference that controls if the line number ruler is shown in the UI (value "lineNumberRuler").

The preference value is of type Boolean.

See Also:
Constant Field Values

EDITOR_LINE_NUMBER_RULER_COLOR

public static final String EDITOR_LINE_NUMBER_RULER_COLOR
A named preference that holds the color used to render line numbers inside the line number ruler (value "lineNumberColor").

The preference value is of type String. A RGB color value encoded as a string using class PreferenceConverter.

See Also:
StringConverter, PreferenceConverter, EDITOR_LINE_NUMBER_RULER, Constant Field Values

USE_ANNOTATIONS_PREFERENCE_PAGE

public static final String USE_ANNOTATIONS_PREFERENCE_PAGE
A named preference that controls whether this plug-in's Annotations preference page is used to configure annotations.

Value is of type boolean.

See Also:
Constant Field Values

USE_QUICK_DIFF_PREFERENCE_PAGE

public static final String USE_QUICK_DIFF_PREFERENCE_PAGE
A named preference that controls whether this plug-in's Quick Diff preference page is used to configure Quick Diff.

Value is of type boolean.

See Also:
Constant Field Values

QUICK_DIFF_ALWAYS_ON

public static final String QUICK_DIFF_ALWAYS_ON
A named preference that controls whether quick diff colors are shown on the line number bar.

Value is of type boolean.

See Also:
Constant Field Values

QUICK_DIFF_DEFAULT_PROVIDER

public static final String QUICK_DIFF_DEFAULT_PROVIDER
A named preference that controls the default quick diff reference provider.

Value is of type String.

See Also:
Constant Field Values

QUICK_DIFF_CHARACTER_MODE

public static final String QUICK_DIFF_CHARACTER_MODE
A named preference that controls the default quick diff reference provider.

Value is of type String.

See Also:
Constant Field Values

EDITOR_USE_CUSTOM_CARETS

public static final String EDITOR_USE_CUSTOM_CARETS
A named preference that controls whether custom carets are used in the editor or not.

Value is of type Boolean. If false, only the default caret is used in the editor.

See Also:
Constant Field Values

EDITOR_WIDE_CARET

public static final String EDITOR_WIDE_CARET
A named preference that controls whether carets are drawn wide or not.

Value is of type Boolean. If true, the caret is twice as wide as the default caret.

See Also:
Constant Field Values

EDITOR_SELECTION_FOREGROUND_COLOR

public static final String EDITOR_SELECTION_FOREGROUND_COLOR
A named preference that holds the color used as the text selection foreground. This value has no effect if the system default color is used.

Value is of type String. A RGB color value encoded as a string using class PreferenceConverter

See Also:
StringConverter, PreferenceConverter, Constant Field Values

EDITOR_SELECTION_FOREGROUND_DEFAULT_COLOR

public static final String EDITOR_SELECTION_FOREGROUND_DEFAULT_COLOR
A named preference that describes if the system default selection foreground color is used as the text selection foreground.

Value is of type Boolean.

See Also:
Constant Field Values

EDITOR_SELECTION_BACKGROUND_COLOR

public static final String EDITOR_SELECTION_BACKGROUND_COLOR
A named preference that holds the color used as the text selection background. This value has no effect if the system default color is used.

Value is of type String. A RGB color value encoded as a string using class PreferenceConverter

See Also:
StringConverter, PreferenceConverter, Constant Field Values

EDITOR_SELECTION_BACKGROUND_DEFAULT_COLOR

public static final String EDITOR_SELECTION_BACKGROUND_DEFAULT_COLOR
A named preference that describes if the system default selection background color is used as the text selection background.

Value is of type Boolean.

See Also:
Constant Field Values
Method Detail

initializeDefaultValues

public static void initializeDefaultValues(IPreferenceStore store)
Initializes the given preference store with the default values.

Parameters:
store - the preference store to be initialized

Eclipse Platform
Release 3.0

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.