Eclipse JDT
2.0

org.eclipse.jdt.ui
Class PreferenceConstants

java.lang.Object
  |
  +--org.eclipse.jdt.ui.PreferenceConstants

public class PreferenceConstants
extends Object

Preference constants used in the JDT-UI preference store. Clients should only read the JDT-UI preference store using these values. Clients are not allowed to modify the preference store programmatically.

Since:
2.0

Field Summary
static String APPEARANCE_COMPRESS_PACKAGE_NAMES
          A named preference that controls if package name compression is turned on or off.
static String APPEARANCE_METHOD_RETURNTYPE
          A named preference that controls return type rendering of methods in the UI.
static String APPEARANCE_OVERRIDE_INDICATOR
          A named preference that controls if override indicators are rendered in the UI.
static String APPEARANCE_PKG_NAME_PATTERN_FOR_PKG_VIEW
          A named preference that defines the pattern used for package name compression.
static String BROWSING_LINK_VIEW_TO_EDITOR
          A named preference that controls if the Java Browsing views are linked to the active editor.
static String BROWSING_STACK_VERTICALLY
          A named preference that controls the layout of the Java Browsing views vertically.
static String CODEASSIST_AUTOACTIVATION
          A named preference that controls if the Java code assist gets auto activated.
static String CODEASSIST_AUTOACTIVATION_DELAY
          A name preference that holds the auto activation delay time in milli seconds.
static String CODEASSIST_AUTOACTIVATION_TRIGGERS_JAVA
          A named preference that holds the characters that auto activate code assist in Java code.
static String CODEASSIST_AUTOACTIVATION_TRIGGERS_JAVADOC
          A named preference that holds the characters that auto activate code assist in Javadoc.
static String CODEASSIST_CASE_SENSITIVITY
          A named preference that controls whether code assist proposals filtering is case sensitive or not.
static String CODEASSIST_FILL_ARGUMENT_NAMES
          A named preference that controls if argument names are filled in when a method is selected from as list of code assist proposal.
static String CODEASSIST_ORDER_PROPOSALS
          A named preference that defines if code assist proposals are sorted in alphabetical order.
static String CODEASSIST_PARAMETERS_BACKGROUND
          A named preference that holds the background color used for parameter hints.
static String CODEASSIST_PARAMETERS_FOREGROUND
          A named preference that holds the foreground color used for parameter hints.
static String CODEASSIST_PROPOSALS_BACKGROUND
          A named preference that holds the background color used in the code assist selection dialog.
static String CODEASSIST_PROPOSALS_FOREGROUND
          A named preference that holds the foreground color used in the code assist selection dialog.
static String CODEASSIST_SHOW_VISIBLE_PROPOSALS
          A named preference that controls if code assist contains only visible proposals.
static String CODEGEN__FILE_COMMENTS
          A named preference that controls if a file comment gets added to newly created files.
static String CODEGEN__JAVADOC_STUBS
          A name preference that controls if a JavaDoc stub gets added to newly created types and methods.
static String CODEGEN__NON_JAVADOC_COMMENTS
          A named preference that controls if a non-javadoc comment gets added to methods generated via the "Override Methods" operation.
static String CODEGEN_GETTERSETTER_PREFIX
          A named preference that holds a list of prefixes to be removed from a local variable to compute setter and gettter names.
static String CODEGEN_GETTERSETTER_SUFFIX
          A named preference that holds a list of suffixes to be removed from a local variable to compute setter and getter names.
static String CODEGEN_USE_GETTERSETTER_PREFIX
          A named preference that controls if prefix removal during setter/getter generation is turned on or off.
static String CODEGEN_USE_GETTERSETTER_SUFFIX
          A named preference that controls if suffix removal during setter/getter generation is turned on or off.
static String DOUBLE_CLICK
          A named preference that controls the behaviour when double clicking on a container in the packages view.
static String DOUBLE_CLICK_EXPANDS
          A string value used by the named preference DOUBLE_CLICK.
static String DOUBLE_CLICK_GOES_INTO
          A string value used by the named preference DOUBLE_CLICK.
static String EDITOR_BACKGROUND_COLOR
          A named preference that holds the color used as the text background.
static String EDITOR_BACKGROUND_DEFAULT_COLOR
          A named preference that holds the default color used as the text background.
static String EDITOR_CORRECTION_INDICATION
          A named preference that controls if correction indicators are shown in the UI.
static String EDITOR_CURRENT_LINE
          A named preference that controls whether the current line highlighting is turned on or off.
static String EDITOR_CURRENT_LINE_COLOR
          A named preference that holds the color used to highlight the current line.
static String EDITOR_EVALUTE_TEMPORARY_PROBLEMS
          A named preference that controls if temporary problems are evaluated and shown in the UI.
static String EDITOR_FIND_SCOPE_COLOR
          A named preference that holds the color used for the find/replace scope.
static String EDITOR_FOREGROUND_COLOR
          A named preference that holds the color used as the text foreground.
static String EDITOR_FOREGROUND_DEFAULT_COLOR
          A named preference that holds the default color used as text foreground.
static String EDITOR_JAVA_DEFAULT_BOLD
          A named preference that controls whether Java default text is rendered in bold.
static String EDITOR_JAVA_DEFAULT_COLOR
          A named preference that holds the color used to render java default text.
static String EDITOR_JAVA_KEYWORD_BOLD
          A named preference that controls whether keywords are rendered in bold.
static String EDITOR_JAVA_KEYWORD_COLOR
          A named preference that holds the color used to render java keywords.
static String EDITOR_JAVADOC_DEFAULT_BOLD
          A named preference that controls whether javadoc default text is rendered in bold.
static String EDITOR_JAVADOC_DEFAULT_COLOR
          A named preference that holds the color used to render javadoc default text.
static String EDITOR_JAVADOC_KEYWORD_BOLD
          A named preference that controls whether javadoc keywords are rendered in bold.
static String EDITOR_JAVADOC_KEYWORD_COLOR
          A named preference that holds the color used to render javadoc keywords.
static String EDITOR_JAVADOC_LINKS_BOLD
          A named preference that controls whether javadoc links are rendered in bold.
static String EDITOR_JAVADOC_LINKS_COLOR
          A named preference that holds the color used to render javadoc links.
static String EDITOR_JAVADOC_TAG_BOLD
          A named preference that controls whether javadoc tags are rendered in bold.
static String EDITOR_JAVADOC_TAG_COLOR
          A named preference that holds the color used to render javadoc tags.
static String EDITOR_LINE_NUMBER_RULER
          A named preference that controls if the line number ruler is shown in the UI.
static String EDITOR_LINE_NUMBER_RULER_COLOR
          A named preference that holds the color used to render line numbers inside the line number ruler.
static String EDITOR_LINKED_POSITION_COLOR
          A named preference that holds the color used to render linked positions inside code templates.
static String EDITOR_MATCHING_BRACKETS
          A named preference that controls whether bracket matching highlighting is turned on or off.
static String EDITOR_MATCHING_BRACKETS_COLOR
          A named preference that holds the color used to highlight matching brackets.
static String EDITOR_MULTI_LINE_COMMENT_BOLD
          A named preference that controls whether multi line comments are rendered in bold.
static String EDITOR_MULTI_LINE_COMMENT_COLOR
          A named preference that holds the color used to render multi line comments.
static String EDITOR_OVERVIEW_RULER
          A named preference that controls if the overview ruler is shown in the UI.
static String EDITOR_PRINT_MARGIN
          A named preference that controls whether the print margin is turned on or off.
static String EDITOR_PRINT_MARGIN_COLOR
          A named preference that holds the color used to render the print margin.
static String EDITOR_PRINT_MARGIN_COLUMN
          Print margin column.
static String EDITOR_PROBLEM_INDICATION
          A named preference that controls whether the editor shows problem indicators in text (squiggly lines).
static String EDITOR_PROBLEM_INDICATION_COLOR
          A named preference that holds the color used to render problem indicators.
static String EDITOR_SHOW_HOVER
          A named preference that controls whether hover tooltips in the editor are turned on or off.
static String EDITOR_SHOW_SEGMENTS
          A named preference that controls if segmented view (show selected element only) is turned on or off.
static String EDITOR_SINGLE_LINE_COMMENT_BOLD
          A named preference that controls whether sinle line comments are rendered in bold.
static String EDITOR_SINGLE_LINE_COMMENT_COLOR
          A named preference that holds the color used to render single line comments.
static String EDITOR_SPACES_FOR_TABS
          A named preference that specifies if the editor uses spaces for tabs.
static String EDITOR_STRING_BOLD
          A named preference that controls whether string constants are rendered in bold.
static String EDITOR_STRING_COLOR
          A named preference that holds the color used to render string constants.
static String EDITOR_TAB_WIDTH
          A named preference that holds the number of spaces used per tab in the editor.
static String JAVADOC_COMMAND
          A named preference that holds the path of the Javadoc command used by the Javadoc creation wizard.
static String LINK_PACKAGES_TO_EDITOR
          A named preference that controls whether the package explorer's selection is linked to the active editor.
static String LINK_TYPEHIERARCHY_TO_EDITOR
          A named preference that controls whether the hierarchy view's selection is linked to the active editor.
static String NEWPROJECT_JRELIBRARY_INDEX
          A named preferences that specifies the current active JRE library.
static String NEWPROJECT_JRELIBRARY_LIST
          A named preference that holds a list of possible JRE libraries used by the New Java Project wizard.
static String OPEN_TYPE_HIERARCHY
          A named preference that controls if a new type hierarchy gets opened in a new type hierarchy perspective or inside the type hierarchy view part.
static String OPEN_TYPE_HIERARCHY_IN_PERSPECTIVE
          A string value used by the named preference OPEN_TYPE_HIERARCHY.
static String OPEN_TYPE_HIERARCHY_IN_VIEW_PART
          A string value used by the named preference OPEN_TYPE_HIERARCHY.
static String ORGIMPORTS_IGNORELOWERCASE
          A named preferences that controls if types that start with a lower case letters get added by the "Organize Import" operation.
static String ORGIMPORTS_IMPORTORDER
          A named preference that holds a list of comma separated package names.
static String ORGIMPORTS_ONDEMANDTHRESHOLD
          A named preference that specifies the number of imports added before a star-import declaration is used.
static String REFACTOR_ERROR_PAGE_SEVERITY_THRESHOLD
          A named preference that controls the behaviour of the refactoring wizard for showing the error page.
static String REFACTOR_ERROR_SEVERITY
          A string value used by the named preference REFACTOR_ERROR_PAGE_SEVERITY_THRESHOLD.
static String REFACTOR_FATAL_SEVERITY
          A string value used by the named preference REFACTOR_ERROR_PAGE_SEVERITY_THRESHOLD.
static String REFACTOR_INFO_SEVERITY
          A string value used by the named preference REFACTOR_ERROR_PAGE_SEVERITY_THRESHOLD.
static String REFACTOR_OK_SEVERITY
          A string value used by the named preference REFACTOR_ERROR_PAGE_SEVERITY_THRESHOLD.
static String REFACTOR_SAVE_ALL_EDITORS
          A named preference thet controls whether all dirty editors are automatically saved before a refactoring is executed.
static String REFACTOR_WARNING_SEVERITY
          A string value used by the named preference REFACTOR_ERROR_PAGE_SEVERITY_THRESHOLD.
static String SHOW_CU_CHILDREN
          A named preference that speficies whether children of a compilation unit are shown in the package explorer.
static String SRCBIN_BINNAME
          A named preference that specifies the output folder name used when creating a new Java project.
static String SRCBIN_FOLDERS_IN_NEWPROJ
          A named preference that controls whether new projects are generated using source and output folder.
static String SRCBIN_SRCNAME
          A named preference that specifies the source folder name used when creating a new Java project.
static String UPDATE_JAVA_VIEWS
          A named preference that controls whether Java views update their presentation while editing or when saving the content of an editor.
static String UPDATE_ON_SAVE
          A string value used by the named preference UPDATE_JAVA_VIEWS
static String UPDATE_WHILE_EDITING
          A string value used by the named preference UPDATE_JAVA_VIEWS
 
Method Summary
static IClasspathEntry[] decodeJRELibraryClasspathEntries(String encodedLibrary)
          Decodes an encoded JRE library and returns its classpath entries.
static String decodeJRELibraryDescription(String encodedLibrary)
          Decodes an encoded JRE library and returns its description string.
static String encodeJRELibrary(String description, IClasspathEntry[] entries)
          Encodes a JRE library to be used in the named preference NEWPROJECT_JRELIBRARY_LIST.
static IClasspathEntry[] getDefaultJRELibrary()
          Returns the current configuration for the JRE to be used as default in new Java projects.
 IPreferenceStore getPreferenceStore()
          Returns the JDT-UI preference store.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

APPEARANCE_METHOD_RETURNTYPE

public static final String APPEARANCE_METHOD_RETURNTYPE
A named preference that controls return type rendering of methods in the UI.

Value is of type Boolean: if true return types are rendered

See Also:
Constant Field Values

APPEARANCE_OVERRIDE_INDICATOR

public static final String APPEARANCE_OVERRIDE_INDICATOR
A named preference that controls if override indicators are rendered in the UI.

Value is of type Boolean: if true override indicators are rendered

See Also:
Constant Field Values

APPEARANCE_PKG_NAME_PATTERN_FOR_PKG_VIEW

public static final String APPEARANCE_PKG_NAME_PATTERN_FOR_PKG_VIEW
A named preference that defines the pattern used for package name compression.

Value is of type String. For example foe the given package name 'org.eclipse.jdt' pattern '.' will compress it to '..jdt', '1~' to 'o~.e~.jdt'.

See Also:
Constant Field Values

APPEARANCE_COMPRESS_PACKAGE_NAMES

public static final String APPEARANCE_COMPRESS_PACKAGE_NAMES
A named preference that controls if package name compression is turned on or off.

Value is of type Boolean.

See Also:
APPEARANCE_PKG_NAME_PATTERN_FOR_PKG_VIEW, Constant Field Values

CODEGEN_USE_GETTERSETTER_PREFIX

public static final String CODEGEN_USE_GETTERSETTER_PREFIX
A named preference that controls if prefix removal during setter/getter generation is turned on or off.

Value is of type Boolean.

See Also:
Constant Field Values

CODEGEN_GETTERSETTER_PREFIX

public static final String CODEGEN_GETTERSETTER_PREFIX
A named preference that holds a list of prefixes to be removed from a local variable to compute setter and gettter names.

Value is of type String: comma separated list of prefixed

See Also:
CODEGEN_USE_GETTERSETTER_PREFIX, Constant Field Values

CODEGEN_USE_GETTERSETTER_SUFFIX

public static final String CODEGEN_USE_GETTERSETTER_SUFFIX
A named preference that controls if suffix removal during setter/getter generation is turned on or off.

Value is of type Boolean.

See Also:
Constant Field Values

CODEGEN_GETTERSETTER_SUFFIX

public static final String CODEGEN_GETTERSETTER_SUFFIX
A named preference that holds a list of suffixes to be removed from a local variable to compute setter and getter names.

Value is of type String: comma separated list of suffixes

See Also:
CODEGEN_USE_GETTERSETTER_SUFFIX, Constant Field Values

CODEGEN__JAVADOC_STUBS

public static final String CODEGEN__JAVADOC_STUBS
A name preference that controls if a JavaDoc stub gets added to newly created types and methods.

Value is of type Boolean.

See Also:
Constant Field Values

CODEGEN__NON_JAVADOC_COMMENTS

public static final String CODEGEN__NON_JAVADOC_COMMENTS
A named preference that controls if a non-javadoc comment gets added to methods generated via the "Override Methods" operation.

Value is of type Boolean.

See Also:
Constant Field Values

CODEGEN__FILE_COMMENTS

public static final String CODEGEN__FILE_COMMENTS
A named preference that controls if a file comment gets added to newly created files.

Value is of type Boolean.

See Also:
Constant Field Values

ORGIMPORTS_IMPORTORDER

public static final String ORGIMPORTS_IMPORTORDER
A named preference that holds a list of comma separated package names. The list specifies the import order used by the "Organize Imports" opeation.

Value is of type String: comma separated list of package names

See Also:
Constant Field Values

ORGIMPORTS_ONDEMANDTHRESHOLD

public static final String ORGIMPORTS_ONDEMANDTHRESHOLD
A named preference that specifies the number of imports added before a star-import declaration is used.

Value is of type Int: positive value specifing the number of non star-import is used

See Also:
Constant Field Values

ORGIMPORTS_IGNORELOWERCASE

public static final String ORGIMPORTS_IGNORELOWERCASE
A named preferences that controls if types that start with a lower case letters get added by the "Organize Import" operation.

Value is of type Boolean.

See Also:
Constant Field Values

SHOW_CU_CHILDREN

public static final String SHOW_CU_CHILDREN
A named preference that speficies whether children of a compilation unit are shown in the package explorer.

Value is of type Boolean.

See Also:
Constant Field Values

LINK_PACKAGES_TO_EDITOR

public static final String LINK_PACKAGES_TO_EDITOR
A named preference that controls whether the package explorer's selection is linked to the active editor.

Value is of type Boolean.

See Also:
Constant Field Values

LINK_TYPEHIERARCHY_TO_EDITOR

public static final String LINK_TYPEHIERARCHY_TO_EDITOR
A named preference that controls whether the hierarchy view's selection is linked to the active editor.

Value is of type Boolean.

See Also:
Constant Field Values

SRCBIN_FOLDERS_IN_NEWPROJ

public static final String SRCBIN_FOLDERS_IN_NEWPROJ
A named preference that controls whether new projects are generated using source and output folder.

Value is of type Boolean. if true new projects are created with a source and output folder. If false source and output folder equals to the project.

See Also:
Constant Field Values

SRCBIN_SRCNAME

public static final String SRCBIN_SRCNAME
A named preference that specifies the source folder name used when creating a new Java project. Value is inactive if SRCBIN_FOLDERS_IN_NEWPROJ is set to false.

Value is of type String.

See Also:
SRCBIN_FOLDERS_IN_NEWPROJ, Constant Field Values

SRCBIN_BINNAME

public static final String SRCBIN_BINNAME
A named preference that specifies the output folder name used when creating a new Java project. Value is inactive if SRCBIN_FOLDERS_IN_NEWPROJ is set to false.

Value is of type String.

See Also:
SRCBIN_FOLDERS_IN_NEWPROJ, Constant Field Values

NEWPROJECT_JRELIBRARY_LIST

public static final String NEWPROJECT_JRELIBRARY_LIST
A named preference that holds a list of possible JRE libraries used by the New Java Project wizard. An library consists of a description and an arbitrary number of IClasspathEntrys, that will represent the JRE on the new project's classpath.

Value is of type String: a semicolon separated list of encoded JRE libraries. NEWPROJECT_JRELIBRARY_INDEX defines the currently used library. Clients should use the method encodeJRELibrary to encode a JRE library into a string and the methods decodeJRELibraryDescription(String) and decodeJRELibraryClasspathEntries(String) to decode the description and the array of classpath entries from an encoded string.

See Also:
NEWPROJECT_JRELIBRARY_INDEX, encodeJRELibrary(String, IClasspathEntry[]), decodeJRELibraryDescription(String), decodeJRELibraryClasspathEntries(String), Constant Field Values

NEWPROJECT_JRELIBRARY_INDEX

public static final String NEWPROJECT_JRELIBRARY_INDEX
A named preferences that specifies the current active JRE library.

Value is of type Int: an index into the list of possible JRE libraries.

See Also:
NEWPROJECT_JRELIBRARY_LIST, Constant Field Values

OPEN_TYPE_HIERARCHY

public static final String OPEN_TYPE_HIERARCHY
A named preference that controls if a new type hierarchy gets opened in a new type hierarchy perspective or inside the type hierarchy view part.

Value is of type String: possible values are OPEN_TYPE_HIERARCHY_IN_PERSPECTIVE or OPEN_TYPE_HIERARCHY_IN_VIEW_PART.

See Also:
OPEN_TYPE_HIERARCHY_IN_PERSPECTIVE, OPEN_TYPE_HIERARCHY_IN_VIEW_PART, Constant Field Values

OPEN_TYPE_HIERARCHY_IN_PERSPECTIVE

public static final String OPEN_TYPE_HIERARCHY_IN_PERSPECTIVE
A string value used by the named preference OPEN_TYPE_HIERARCHY.

See Also:
OPEN_TYPE_HIERARCHY, Constant Field Values

OPEN_TYPE_HIERARCHY_IN_VIEW_PART

public static final String OPEN_TYPE_HIERARCHY_IN_VIEW_PART
A string value used by the named preference OPEN_TYPE_HIERARCHY.

See Also:
OPEN_TYPE_HIERARCHY, Constant Field Values

DOUBLE_CLICK

public static final String DOUBLE_CLICK
A named preference that controls the behaviour when double clicking on a container in the packages view.

Value is of type String: possible values are DOUBLE_CLICK_GOES_INTO or DOUBLE_CLICK_EXPANDS.

See Also:
DOUBLE_CLICK_EXPANDS, DOUBLE_CLICK_GOES_INTO, Constant Field Values

DOUBLE_CLICK_GOES_INTO

public static final String DOUBLE_CLICK_GOES_INTO
A string value used by the named preference DOUBLE_CLICK.

See Also:
DOUBLE_CLICK, Constant Field Values

DOUBLE_CLICK_EXPANDS

public static final String DOUBLE_CLICK_EXPANDS
A string value used by the named preference DOUBLE_CLICK.

See Also:
DOUBLE_CLICK, Constant Field Values

UPDATE_JAVA_VIEWS

public static final String UPDATE_JAVA_VIEWS
A named preference that controls whether Java views update their presentation while editing or when saving the content of an editor.

Value is of type String: possible values are UPDATE_ON_SAVE or UPDATE_WHILE_EDITING.

See Also:
UPDATE_ON_SAVE, UPDATE_WHILE_EDITING, Constant Field Values

UPDATE_ON_SAVE

public static final String UPDATE_ON_SAVE
A string value used by the named preference UPDATE_JAVA_VIEWS

See Also:
UPDATE_JAVA_VIEWS, Constant Field Values

UPDATE_WHILE_EDITING

public static final String UPDATE_WHILE_EDITING
A string value used by the named preference UPDATE_JAVA_VIEWS

See Also:
UPDATE_JAVA_VIEWS, Constant Field Values

JAVADOC_COMMAND

public static final String JAVADOC_COMMAND
A named preference that holds the path of the Javadoc command used by the Javadoc creation wizard.

Value is of type String.

See Also:
Constant Field Values

EDITOR_MATCHING_BRACKETS

public static final String EDITOR_MATCHING_BRACKETS
A named preference that controls whether bracket matching highlighting is turned on or off.

Value is of type Boolean.

See Also:
Constant Field Values

EDITOR_MATCHING_BRACKETS_COLOR

public static final String EDITOR_MATCHING_BRACKETS_COLOR
A named preference that holds the color used to highlight matching brackets.

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

See Also:
StringConverter, PreferenceConverter, Constant Field Values

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 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 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

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

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 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. Int value.

See Also:
Constant Field Values

EDITOR_FIND_SCOPE_COLOR

public static final String EDITOR_FIND_SCOPE_COLOR
A named preference that holds the color used for the find/replace scope.

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

See Also:
StringConverter, PreferenceConverter, Constant Field Values

EDITOR_SPACES_FOR_TABS

public static final String EDITOR_SPACES_FOR_TABS
A named preference that specifies if the editor uses spaces for tabs.

Value is of type Boolean. If truespaces instead of tabs are used in the editor. If false the editor inserts a tab character when pressing the tab key.

See Also:
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 editor.

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

See Also:
Constant Field Values

EDITOR_PROBLEM_INDICATION

public static final String EDITOR_PROBLEM_INDICATION
A named preference that controls whether the editor shows problem indicators in text (squiggly lines).

Value is of type Boolean.

See Also:
Constant Field Values

EDITOR_PROBLEM_INDICATION_COLOR

public static final String EDITOR_PROBLEM_INDICATION_COLOR
A named preference that holds the color used to render problem indicators.

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

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

EDITOR_CORRECTION_INDICATION

public static final String EDITOR_CORRECTION_INDICATION
A named preference that controls if correction indicators are shown in the UI.

Value is of type Boolean.

See Also:
Constant Field Values

EDITOR_EVALUTE_TEMPORARY_PROBLEMS

public static final String EDITOR_EVALUTE_TEMPORARY_PROBLEMS
A named preference that controls if temporary problems are evaluated and shown in the UI.

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 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 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 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

EDITOR_LINKED_POSITION_COLOR

public static final String EDITOR_LINKED_POSITION_COLOR
A named preference that holds the color used to render linked positions inside code templates.

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

See Also:
StringConverter, PreferenceConverter, Constant Field Values

EDITOR_FOREGROUND_COLOR

public static final String EDITOR_FOREGROUND_COLOR
A named preference that holds the color used as the text foreground.

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

See Also:
StringConverter, PreferenceConverter, Constant Field Values

EDITOR_FOREGROUND_DEFAULT_COLOR

public static final String EDITOR_FOREGROUND_DEFAULT_COLOR
A named preference that holds the default color used as text foreground.

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

See Also:
StringConverter, PreferenceConverter, Constant Field Values

EDITOR_BACKGROUND_COLOR

public static final String EDITOR_BACKGROUND_COLOR
A named preference that holds the color used as the text background.

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

See Also:
StringConverter, PreferenceConverter, Constant Field Values

EDITOR_BACKGROUND_DEFAULT_COLOR

public static final String EDITOR_BACKGROUND_DEFAULT_COLOR
A named preference that holds the default color used as the text background.

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

See Also:
StringConverter, PreferenceConverter, Constant Field Values

EDITOR_MULTI_LINE_COMMENT_COLOR

public static final String EDITOR_MULTI_LINE_COMMENT_COLOR
A named preference that holds the color used to render multi line comments.

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

See Also:
StringConverter, PreferenceConverter, Constant Field Values

EDITOR_MULTI_LINE_COMMENT_BOLD

public static final String EDITOR_MULTI_LINE_COMMENT_BOLD
A named preference that controls whether multi line comments are rendered in bold.

Value is of type Boolean. If true multi line comments are rendered in bold. If false the are rendered using no font style attribute.

See Also:
Constant Field Values

EDITOR_SINGLE_LINE_COMMENT_COLOR

public static final String EDITOR_SINGLE_LINE_COMMENT_COLOR
A named preference that holds the color used to render single line comments.

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

See Also:
StringConverter, PreferenceConverter, Constant Field Values

EDITOR_SINGLE_LINE_COMMENT_BOLD

public static final String EDITOR_SINGLE_LINE_COMMENT_BOLD
A named preference that controls whether sinle line comments are rendered in bold.

Value is of type Boolean. If true single line comments are rendered in bold. If false the are rendered using no font style attribute.

See Also:
Constant Field Values

EDITOR_JAVA_KEYWORD_COLOR

public static final String EDITOR_JAVA_KEYWORD_COLOR
A named preference that holds the color used to render java keywords.

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

See Also:
StringConverter, PreferenceConverter, Constant Field Values

EDITOR_JAVA_KEYWORD_BOLD

public static final String EDITOR_JAVA_KEYWORD_BOLD
A named preference that controls whether keywords are rendered in bold.

Value is of type Boolean.

See Also:
Constant Field Values

EDITOR_STRING_COLOR

public static final String EDITOR_STRING_COLOR
A named preference that holds the color used to render string constants.

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

See Also:
StringConverter, PreferenceConverter, Constant Field Values

EDITOR_STRING_BOLD

public static final String EDITOR_STRING_BOLD
A named preference that controls whether string constants are rendered in bold.

Value is of type Boolean.

See Also:
Constant Field Values

EDITOR_JAVA_DEFAULT_COLOR

public static final String EDITOR_JAVA_DEFAULT_COLOR
A named preference that holds the color used to render java default text.

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

See Also:
StringConverter, PreferenceConverter, Constant Field Values

EDITOR_JAVA_DEFAULT_BOLD

public static final String EDITOR_JAVA_DEFAULT_BOLD
A named preference that controls whether Java default text is rendered in bold.

Value is of type Boolean.

See Also:
Constant Field Values

EDITOR_JAVADOC_KEYWORD_COLOR

public static final String EDITOR_JAVADOC_KEYWORD_COLOR
A named preference that holds the color used to render javadoc keywords.

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

See Also:
StringConverter, PreferenceConverter, Constant Field Values

EDITOR_JAVADOC_KEYWORD_BOLD

public static final String EDITOR_JAVADOC_KEYWORD_BOLD
A named preference that controls whether javadoc keywords are rendered in bold.

Value is of type Boolean.

See Also:
Constant Field Values

EDITOR_JAVADOC_TAG_COLOR

public static final String EDITOR_JAVADOC_TAG_COLOR
A named preference that holds the color used to render javadoc tags.

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

See Also:
StringConverter, PreferenceConverter, Constant Field Values

EDITOR_JAVADOC_TAG_BOLD

public static final String EDITOR_JAVADOC_TAG_BOLD
A named preference that controls whether javadoc tags are rendered in bold.

Value is of type Boolean.

See Also:
Constant Field Values

EDITOR_JAVADOC_LINKS_COLOR

public static final String EDITOR_JAVADOC_LINKS_COLOR
A named preference that holds the color used to render javadoc links.

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

See Also:
StringConverter, PreferenceConverter, Constant Field Values

EDITOR_JAVADOC_LINKS_BOLD

public static final String EDITOR_JAVADOC_LINKS_BOLD
A named preference that controls whether javadoc links are rendered in bold.

Value is of type Boolean.

See Also:
Constant Field Values

EDITOR_JAVADOC_DEFAULT_COLOR

public static final String EDITOR_JAVADOC_DEFAULT_COLOR
A named preference that holds the color used to render javadoc default text.

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

See Also:
StringConverter, PreferenceConverter, Constant Field Values

EDITOR_JAVADOC_DEFAULT_BOLD

public static final String EDITOR_JAVADOC_DEFAULT_BOLD
A named preference that controls whether javadoc default text is rendered in bold.

Value is of type Boolean.

See Also:
Constant Field Values

EDITOR_SHOW_HOVER

public static final String EDITOR_SHOW_HOVER
A named preference that controls whether hover tooltips in the editor are turned on or off.

Value is of type Boolean.

See Also:
Constant Field Values

EDITOR_SHOW_SEGMENTS

public static final String EDITOR_SHOW_SEGMENTS
A named preference that controls if segmented view (show selected element only) is turned on or off.

Value is of type Boolean.

See Also:
Constant Field Values

CODEASSIST_AUTOACTIVATION

public static final String CODEASSIST_AUTOACTIVATION
A named preference that controls if the Java code assist gets auto activated.

Value is of type Boolean.

See Also:
Constant Field Values

CODEASSIST_AUTOACTIVATION_DELAY

public static final String CODEASSIST_AUTOACTIVATION_DELAY
A name preference that holds the auto activation delay time in milli seconds.

Value is of type Int.

See Also:
Constant Field Values

CODEASSIST_SHOW_VISIBLE_PROPOSALS

public static final String CODEASSIST_SHOW_VISIBLE_PROPOSALS
A named preference that controls if code assist contains only visible proposals.

Value is of type Boolean. if true code assist only contains visible members. If false all members are included.

See Also:
Constant Field Values

CODEASSIST_CASE_SENSITIVITY

public static final String CODEASSIST_CASE_SENSITIVITY
A named preference that controls whether code assist proposals filtering is case sensitive or not.

Value is of type Boolean.

See Also:
Constant Field Values

CODEASSIST_ORDER_PROPOSALS

public static final String CODEASSIST_ORDER_PROPOSALS
A named preference that defines if code assist proposals are sorted in alphabetical order.

Value is of type Boolean. If true that are sorted in alphabetical order. If false that are unsorted.

See Also:
Constant Field Values

CODEASSIST_FILL_ARGUMENT_NAMES

public static final String CODEASSIST_FILL_ARGUMENT_NAMES
A named preference that controls if argument names are filled in when a method is selected from as list of code assist proposal.

Value is of type Boolean.

See Also:
Constant Field Values

CODEASSIST_AUTOACTIVATION_TRIGGERS_JAVA

public static final String CODEASSIST_AUTOACTIVATION_TRIGGERS_JAVA
A named preference that holds the characters that auto activate code assist in Java code.

Value is of type Sring. All characters that trigger auto code assist in Java code.

See Also:
Constant Field Values

CODEASSIST_AUTOACTIVATION_TRIGGERS_JAVADOC

public static final String CODEASSIST_AUTOACTIVATION_TRIGGERS_JAVADOC
A named preference that holds the characters that auto activate code assist in Javadoc.

Value is of type Sring. All characters that trigger auto code assist in Javadoc.

See Also:
Constant Field Values

CODEASSIST_PROPOSALS_BACKGROUND

public static final String CODEASSIST_PROPOSALS_BACKGROUND
A named preference that holds the background color used in the code assist selection dialog.

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

See Also:
StringConverter, PreferenceConverter, Constant Field Values

CODEASSIST_PROPOSALS_FOREGROUND

public static final String CODEASSIST_PROPOSALS_FOREGROUND
A named preference that holds the foreground color used in the code assist selection dialog.

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

See Also:
StringConverter, PreferenceConverter, Constant Field Values

CODEASSIST_PARAMETERS_BACKGROUND

public static final String CODEASSIST_PARAMETERS_BACKGROUND
A named preference that holds the background color used for parameter hints.

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

See Also:
StringConverter, PreferenceConverter, Constant Field Values

CODEASSIST_PARAMETERS_FOREGROUND

public static final String CODEASSIST_PARAMETERS_FOREGROUND
A named preference that holds the foreground color used for parameter hints.

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

See Also:
StringConverter, PreferenceConverter, Constant Field Values

REFACTOR_ERROR_PAGE_SEVERITY_THRESHOLD

public static final String REFACTOR_ERROR_PAGE_SEVERITY_THRESHOLD
A named preference that controls the behaviour of the refactoring wizard for showing the error page.

Value is of type String. Valid values are: REFACTOR_FATAL_SEVERITY, REFACTOR_ERROR_SEVERITY, REFACTOR_WARNING_SEVERITY REFACTOR_INFO_SEVERITY, REFACTOR_OK_SEVERITY.

See Also:
REFACTOR_FATAL_SEVERITY, REFACTOR_ERROR_SEVERITY, REFACTOR_WARNING_SEVERITY, REFACTOR_INFO_SEVERITY, REFACTOR_OK_SEVERITY, Constant Field Values

REFACTOR_FATAL_SEVERITY

public static final String REFACTOR_FATAL_SEVERITY
A string value used by the named preference REFACTOR_ERROR_PAGE_SEVERITY_THRESHOLD.

See Also:
REFACTOR_ERROR_PAGE_SEVERITY_THRESHOLD, Constant Field Values

REFACTOR_ERROR_SEVERITY

public static final String REFACTOR_ERROR_SEVERITY
A string value used by the named preference REFACTOR_ERROR_PAGE_SEVERITY_THRESHOLD.

See Also:
REFACTOR_ERROR_PAGE_SEVERITY_THRESHOLD, Constant Field Values

REFACTOR_WARNING_SEVERITY

public static final String REFACTOR_WARNING_SEVERITY
A string value used by the named preference REFACTOR_ERROR_PAGE_SEVERITY_THRESHOLD.

See Also:
REFACTOR_ERROR_PAGE_SEVERITY_THRESHOLD, Constant Field Values

REFACTOR_INFO_SEVERITY

public static final String REFACTOR_INFO_SEVERITY
A string value used by the named preference REFACTOR_ERROR_PAGE_SEVERITY_THRESHOLD.

See Also:
REFACTOR_ERROR_PAGE_SEVERITY_THRESHOLD, Constant Field Values

REFACTOR_OK_SEVERITY

public static final String REFACTOR_OK_SEVERITY
A string value used by the named preference REFACTOR_ERROR_PAGE_SEVERITY_THRESHOLD.

See Also:
REFACTOR_ERROR_PAGE_SEVERITY_THRESHOLD, Constant Field Values

REFACTOR_SAVE_ALL_EDITORS

public static final String REFACTOR_SAVE_ALL_EDITORS
A named preference thet controls whether all dirty editors are automatically saved before a refactoring is executed.

Value is of type Boolean.

See Also:
Constant Field Values

BROWSING_LINK_VIEW_TO_EDITOR

public static final String BROWSING_LINK_VIEW_TO_EDITOR
A named preference that controls if the Java Browsing views are linked to the active editor.

Value is of type Boolean.

See Also:
LINK_PACKAGES_TO_EDITOR, Constant Field Values

BROWSING_STACK_VERTICALLY

public static final String BROWSING_STACK_VERTICALLY
A named preference that controls the layout of the Java Browsing views vertically. Boolean value.

Value is of type Boolean. If true the views are stacked vertical. If false they are stacked horizontal.

See Also:
Constant Field Values
Method Detail

getPreferenceStore

public IPreferenceStore getPreferenceStore()
Returns the JDT-UI preference store.

Returns:
the JDT-UI preference store

encodeJRELibrary

public static String encodeJRELibrary(String description,
                                      IClasspathEntry[] entries)
Encodes a JRE library to be used in the named preference NEWPROJECT_JRELIBRARY_LIST.

Parameters:
description - a string value describing the JRE library. The description is used to indentify the JDR library in the UI
entries - an array of classpath entries to be encoded
Returns:
the encoded string.

decodeJRELibraryDescription

public static String decodeJRELibraryDescription(String encodedLibrary)
Decodes an encoded JRE library and returns its description string.

Returns:
the description of an encoded JRE library
See Also:
encodeJRELibrary(String, IClasspathEntry[])

decodeJRELibraryClasspathEntries

public static IClasspathEntry[] decodeJRELibraryClasspathEntries(String encodedLibrary)
Decodes an encoded JRE library and returns its classpath entries.

Returns:
the array of classpath entries of an encoded JRE library.
See Also:
encodeJRELibrary(String, IClasspathEntry[])

getDefaultJRELibrary

public static IClasspathEntry[] getDefaultJRELibrary()
Returns the current configuration for the JRE to be used as default in new Java projects. This is a convenience method to access the named preference NEWPROJECT_JRELIBRARY_LIST with the index defined by NEWPROJECT_JRELIBRARY_INDEX.

Returns:
the current default set of classpath entries
See Also:
NEWPROJECT_JRELIBRARY_LIST, NEWPROJECT_JRELIBRARY_INDEX

Eclipse JDT
2.0

Copyright (c) IBM Corp. and others 2000, 2002. All Rights Reserved.