blob: c7085e7d7a79bba58c84ba07adb5e57455778cc5 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>
Java editor
</title>
<link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css">
</head>
<body>
<h1>
Java editor
</h1>
<p>
The following Java editor preferences can be set on this page:
</p>
<ul>
<li>
Appearance
</li>
<li>
Syntax
</li>
<li>
Code Assist
</li>
<li>
Problem Indication
</li>
</ul>
<h2 class="Head">
Appearance
</h2>
<p>
<strong>Appearance</strong> specifies the Java editor's appearance.
</p>
<table border="1" cellspacing="0" cellpadding="5" width="100%">
<caption>
Appearance
</caption>
<thead>
<tr>
<th>
<p>
Option
</p>
</th>
<th>
<p>
Description
</p>
</th>
<th>
<p>
Default
</p>
</th>
</tr>
</thead>
<tbody>
<tr>
<td valign="top">
<p>
<strong>Displayed tab width</strong>
</p>
</td>
<td valign="top">
<p>
Specifies how wide tabs are displayed in units of spaces.
</p>
</td>
<td valign="top">
<p>
4
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<strong>Print margin column</strong>
</p>
</td>
<td valign="top">
<p>
Specifies the column after which the print margin is displayed.
</p>
<p>
To display the print margin, enable the option <strong>Show print margin</strong>, the preference <strong>Appearance color options</strong> specifies the color of
the print margin.
</p>
</td>
<td valign="top">
<p>
80
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<strong>Synchronize outline selection on cursor move</strong>
</p>
</td>
<td valign="top">
<p>
If enabled, the Outline view always selects the Java element enclosing the cursor in the Java editor.
</p>
</td>
<td valign="top">
<p>
Off
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<strong>Show overview ruler</strong>
</p>
</td>
<td valign="top">
<p>
If enabled, the overview ruler on the right border of the Java editor is displayed and shows problems of the whole visible document.
</p>
</td>
<td valign="top">
<p>
On
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<strong>Show line numbers</strong>
</p>
</td>
<td valign="top">
<p>
If enabled, the vertical ruler on the left border of the Java editor displays line numbers of the visible document.
</p>
<p>
The color of line numbers is specified with <strong>Appearance color options</strong>.
</p>
</td>
<td valign="top">
<p>
Off
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<strong>Highlight matching brackets</strong>
</p>
</td>
<td valign="top">
<p>
If enabled, whenever the cursor is next to a parenthesis, bracket or curly braces, its opening or closing counter part is highlighted.
</p>
<p>
The color of the bracket highlight is specified with <strong>Appearance color options</strong>.
</p>
</td>
<td valign="top">
<p>
On
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<strong>Highlight current line</strong>
</p>
</td>
<td valign="top">
<p>
If enabled, the background of the current line of the cursor is highlighted.
</p>
<p>
The color of the current line background is specified with <strong>Appearance color options</strong>.
</p>
</td>
<td valign="top">
<p>
On
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<strong>Show print margin</strong>
</p>
</td>
<td valign="top">
<p>
If enabled, the print margin is displayed.
</p>
<p>
The preferences <strong>Print margin column</strong> and <strong>Appearance color options</strong> determine the position and color of the print margin.
</p>
</td>
<td valign="top">
<p>
Off
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<strong>Appearance color options</strong>
</p>
</td>
<td valign="top">
<p>
The colors of various Java editor appearance features are specified here.
</p>
<dl>
<dt>
Line number foreground
</dt>
<dd>
The color of line numbers.
</dd>
<dt>
Matching brackets highlight
</dt>
<dd>
The color of brackets highlight.
</dd>
<dt>
Current line highlight
</dt>
<dd>
The color of current line highlight.
</dd>
<dt>
Print margin
</dt>
<dd>
The color of the print margin.
</dd>
<dt>
Find scope
</dt>
<dd>
The color of find scope.
</dd>
<dt>
Linked position
</dt>
<dd>
The color of linked positions used in code assist.
</dd>
<dt>
Link
</dt>
<dd>
The color of a link.
</dd>
</dl>
</td>
<td valign="top">
<p>
default colors
</p>
</td>
</tr>
</tbody>
</table>
<h2 class="Head">
Syntax
</h2>
<p>
<strong>Syntax</strong> specifies how Java source code is rendered.
</p>
<table border="1" cellspacing="0" cellpadding="5" width="100%">
<caption>
Syntax
</caption>
<thead>
<tr>
<th>
<p>
Option
</p>
</th>
<th>
<p>
Description
</p>
</th>
<th>
<p>
Default
</p>
</th>
</tr>
</thead>
<tbody>
<tr>
<td valign="top">
<p>
<strong>Background color</strong>
</p>
</td>
<td valign="top">
<dl>
<dt>
System default:
</dt>
<dd>
The default background color given by the operating system.
</dd>
<dt>
Custom:
</dt>
<dd>
A user defined background color.
</dd>
</dl>
</td>
<td valign="top">
<p>
System default
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<strong>Foreground</strong>
</p>
</td>
<td valign="top">
<p>
The following Java source fragments can be rendered with different color and style:
</p>
<dl>
<dt>
Multi-line comment
</dt>
<dd>
Comments of the form '/* ... */'
</dd>
<dt>
Single-line comment
</dt>
<dd>
Comments starting with '//'
</dd>
<dt>
Keywords
</dt>
<dd>
All Java keywords.
</dd>
<dt>
Strings
</dt>
<dd>
Java strings and characters, surrounded by single and double quotes
</dd>
<dt>
Others
</dt>
<dd>
Default Java source code
</dd>
<dt>
Task tags
</dt>
<dd>
Task tags in comments
</dd>
<dt>
Javadoc keywords
</dt>
<dd>
Keywords used in Javadoc, starting with '@'
</dd>
<dt>
Javadoc HTML tags
</dt>
<dd>
HTML tags used in Javadoc s
</dd>
<dt>
Javadoc links
</dt>
<dd>
{@link reference} tag
</dd>
<dt>
Javadoc others
</dt>
<dd>
Default Javadoc text
</dd>
</dl>
</td>
<td valign="top">
<p>
default colors and styles
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<strong>Preview</strong>
</p>
</td>
<td valign="top">
<p>
Displays the preview of a Java source code respecting the current colors and styles.
</p>
</td>
<td valign="top">
<p>
n/a
</p>
</td>
</tr>
</tbody>
</table>
<h2 class="Head">
Code assist
</h2>
<p>
<strong>Code Assist</strong> specifies the behaviour and appearance of code assist.
</p>
<table border="1" cellspacing="0" cellpadding="5" width="100%">
<caption>
Code Assist
</caption>
<thead>
<tr>
<th>
<p>
Option
</p>
</th>
<th>
<p>
Description
</p>
</th>
<th>
<p>
Default
</p>
</th>
</tr>
</thead>
<tbody>
<tr>
<td valign="top">
<p>
<strong>Completion inserts/Completion overwrites</strong>
</p>
</td>
<td valign="top">
<p>
If <strong>Completion inserts</strong> is on, the completion text is inserted at the caret position,
so it never overwrites any existing text.
<br>
If <strong>Completion overwrites</strong> is on, the completion text replaces the characters
following the caret position until the end of the word.
</p>
</td>
<td valign="top">
<p>
Completion inserts
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<strong>Insert single proposals automatically</strong>
</p>
</td>
<td valign="top">
<p>
If enabled, code assist will choose and insert automatically single proposals.
</p>
</td>
<td valign="top">
<p>
On
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<strong>Show only proposals visible in the invocation context</strong>
</p>
</td>
<td valign="top">
<p>
If enabled, the Java element proposals are limited by the rules of visibility. For example, private field proposals of other classes would not be displayed.
</p>
</td>
<td valign="top">
<p>
On
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<strong>Present proposals in alphabetical order</strong>
</p>
</td>
<td valign="top">
<p>
If enabled, the proposals are sorted in alphabetical order.
</p>
</td>
<td valign="top">
<p>
Off
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<strong>Automatically add import instead of qualified name</strong>
</p>
</td>
<td valign="top">
<p>
If enabled, type proposals which are in other packages will invoke the addition of the corresponding import declaration. Otherwise, the type will be inserted fully
qualified.
</p>
</td>
<td valign="top">
<p>
On
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<strong>Fill argument names on method completion</strong>
</p>
</td>
<td valign="top">
<p>
If enabled, choosing a method proposal will additionally insert the method's argument names as specified in its declaration.
</p>
</td>
<td valign="top">
<p>
Off
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<strong>Enable auto activation</strong>
</p>
</td>
<td valign="top">
<p>
If enabled, code assist can be invoked automatically.
</p>
<p>
The condition for automatic invocation is specified with the preferences <strong>Auto activation delay</strong>, <strong>Auto activation triggers for Java</strong>
and <strong>Auto activation triggers for Javadoc</strong>.
</p>
</td>
<td valign="top">
<p>
On
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<strong>Auto activation delay</strong>
</p>
</td>
<td valign="top">
<p>
If the time starting when an auto activation trigger character is encountered until a new character is typed exceeds the auto activation delay, code assist is
invoked.
</p>
</td>
<td valign="top">
500
</td>
</tr>
<tr>
<td valign="top">
<p>
<strong>Auto activation triggers for Java</strong>
</p>
</td>
<td valign="top">
<p>
If one of the trigger characters is typed inside Java source code (but not inside a Javadoc comment) and no other character is typed before the auto activation delay
times out, the code assist is invoked.
</p>
</td>
<td valign="top">
<p>
'.'
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<strong>Auto activation triggers for Javadoc</strong>
</p>
</td>
<td valign="top">
<p>
If one of the trigger characters is typed inside a Java doc and no other character is typed before the auto activation delay times out, the code assist is invoked.
</p>
</td>
<td valign="top">
<p>
'@'
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<strong>Code assist color options</strong>
</p>
</td>
<td valign="top">
<p>
The colors used for the following code assist UI elements:
</p>
<dl>
<dt>Completion proposal background</dt>
<dd>The background color of the completion proposal window</dd>
<dt>Completion proposal foreground</dt>
<dd>The foreground color of the completion proposal window</dd>
<dt>Method parameter background</dt>
<dd>The background color of the parameter window</dd>
<dt>Method parameter foreground</dt>
<dd>The foreground color of the parameter window</dd>
<dt>Completion overwrite background</dt>
<dd>The background color of the completion overwrite window</dd>
<dt>Completion overwrite foreground</dt>
<dd>The foreground color of the completion overwrite window</dd>
</dl>
</td>
<td valign="top">
<p>
default colors
</p>
</td>
</tr>
</tbody>
</table>
<h2 class="Head">
Annotations
</h2>
<p>
<strong>Annotations</strong> specifies when and how annotations are displayed.
</p>
<table border="1" cellspacing="0" cellpadding="5" width="100%">
<caption>
Annotations
</caption>
<thead>
<tr>
<th>
<p>
Option
</p>
</th>
<th>
<p>
Description
</p>
</th>
<th>
<p>
Default
</p>
</th>
</tr>
</thead>
<tbody>
<tr>
<td valign="top">
<p>
<strong>Analyze annotations while typing</strong>
</p>
</td>
<td valign="top">
<p>
If enabled, annotations are updated as the user types.
Otherwise, annotations aren't updated until the Java file is compiled.
</p>
</td>
<td valign="top">
<p>
On
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<strong>Indicate annotations solvable with Quick Fix in vertical ruler</strong>
</p>
</td>
<td valign="top">
<p>
Displays a light bulb on the vertical ruler on the left border of the Java editor for every annotation solvable with Quick Fix.
</p>
</td>
<td valign="top">
<p>
On
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<strong>Annotation presentation</strong>
</p>
</td>
<td valign="top">
<p>
For every type of annotation you can specify
<ul>
<li>whether the annotation is shown in text, or in the overview ruler, or in both</li>
<li>in what color the annotation is rendered</li>
</ul>
</p>
</td>
<td valign="top">
<p>
&nbsp;
</p>
</td>
</tr>
</tbody>
</table>
<p>
<img src="../images/ngrelc.gif" alt="Related concepts" border="0" height="27" width="159">
</p>
<p>
<a href="../concepts/concepts-7.htm">Java Editor</a>
</p>
<p>
<img src="../images/ngrelt.gif" alt="Related tasks" border="0" height="27" width="159">
</p>
<p>
<a href="../tasks/tasks-54.htm">Using the Java editor</a>
</p>
<p>
<a href="../reference/ref-java-editor.htm">Java editor</a> <a href="../reference/ref-17.htm">Code Formatter preferences</a> <a href=
"../reference/ref-view-outline.htm">Outline view for Java</a> <a href="../reference/ref-143.htm">Java Content Assist</a> <a href=
"../reference/ref-java-editor-quickfix.htm">Quick Fix</a>
</p>
<a href="../hglegal2003.htm"><img src="../images/ngibmcpy2003.gif" alt="Copyright (c) 2000, 2003 IBM Corporation and others. All Rights Reserved." border="0" width="324" height="14"></a>
</body>
</html>