| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html lang="en"> |
| <head> |
| <meta name="copyright" content="Copyright (c) IBM Corporation and others 2009, 2013. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page."/> |
| <link rel="STYLESHEET" href="../../book.css" charset="ISO-8859-1" type="text/css"/> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/> |
| <title>Accessibility features in textual editors</title> |
| <script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"> </script> |
| </head> |
| |
| <body> |
| |
| <h1>Accessibility features in textual editors</h1> |
| <p>Textual editors in Eclipse can be configured to better fit the needs of people using Accessible Technology such as screen readers and magnifiers. This document describes the relevant options.</p> |
| |
| <h2>Code Folding</h2> |
| <p>Some editors offer code folding by default which can be confusing. Disabling this feature can help to better read the code. Search for "folding" in the <b>Preferences</b> dialog to find related options.</p> |
| |
| <h2>Accessing Annotations</h2> |
| <p>You can navigate to the next annotation by pressing <b>Ctrl+.</b> and to the previous one by pressing <b>Ctrl+,</b>. Out of the box not all available annotation types are included in that navigation, |
| for example, breakpoints are not part of it. Breakpoints and other annotation types can either be enabled via the <b>Next Annotation</b> toolbar button drop-down menu or by checking <b>Include in next/previous navigation</b> on the |
| <a class="command-link" href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.ui.editors.preferencePages.Annotations)")'> |
| <img src="PLUGINS_ROOT/org.eclipse.help/command_link.svg" alt="command link"/> |
| <strong>General > Editors > Text Editors > Annotations</strong></a> preference page.</p> |
| <p>Navigating to an annotation moves the text caret to the annotated line, and displays the annotation text in the status line. The next section explains how to read the status line under Windows.</p> |
| <p>Some annotation types, for example warnings and errors, can |
| be accessed by pressing <b>F2</b> after having navigated to one of them or setting the caret inside the annotation.</p> |
| |
| <h2><img src="../../images/win_only.png" alt="Windows only" border="0"/>Reading the status line with JAWS</h2> |
| <p>JAWS desktop users press <b>Insert+PageDown</b> to read the Eclipse status line and JAWS laptop users press <b>Caps Lock+PageDown</b>.</p> |
| |
| <h2>Accessing the Current Line Number</h2> |
| <p>You can get the current line number by pressing <b>Ctrl+L</b> or via <b>Navigate > Go To Line...</b>.</p> |
| |
| <h2>Hovers and Pop-up Windows</h2> |
| <p><b>F2</b> can be used to show and give focus to most hovers and pop-up windows in textual editors, like content assist proposals, content assist argument proposals, Quick Assists, Quick Fixes, errors and |
| warnings. This allows the screen reader to read its contents. The key sequence for the <b>Show Tooltip Description</b> command can be changed on the <a class="command-link" href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.ui.preferencePages.Keys)")'> |
| <img src="PLUGINS_ROOT/org.eclipse.help/command_link.svg" alt="command link"/> |
| <strong>General > Keys</strong></a> preference page.</p> |
| |
| <h2>Quick Diff Hover</h2> |
| <p>Like normal hovers can be shown by pressing <b>F2</b>, the quick diff and revision hovers that appear when hovering over the quick diff ruler on the left can also be shown by pressing a key sequence. |
| However, out of the box no key sequence is defined for that. Go to the <a class="command-link" href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.ui.preferencePages.Keys)")'> |
| <img src="PLUGINS_ROOT/org.eclipse.help/command_link.svg" alt="command link"/> |
| <strong>General > Keys</strong></a> preference page to assign a key sequence to the <b>Show Quick Diff Ruler Tooltip</b> command.</p> |
| |
| <h2>Annotation Hover</h2> |
| <p>Like normal hovers can be shown by pressing <b>F2</b>, the annotation hover that appears when hovering over the vertical ruler on the left can also be shown by pressing a key sequence. |
| However, out of the box no key sequence is defined for that. Go to the <a class="command-link" href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.ui.preferencePages.Keys)")'> |
| <img src="PLUGINS_ROOT/org.eclipse.help/command_link.svg" alt="command link"/> |
| <strong>General > Keys</strong></a> preference page to assign a key sequence to the <b>Show Ruler Annotation Tooltip</b> command.</p> |
| |
| <h2>Content Assist Auto Activation</h2> |
| <p>In order to prevent content assist to open automatically and hence maybe unexpectedly, it is recommended |
| to disable auto activation. In the SDK the options below are available. Other editors might offer similar |
| preferences.</p> |
| <ul> |
| <li>Deselect <b>Enable auto activation</b> on the <a class="command-link" href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.ant.ui.AntCodeAssistPreferencePage)")'> |
| <img src="PLUGINS_ROOT/org.eclipse.help/command_link.svg" alt="command link"/> <strong>Ant > Editor > Content Assist</strong></a> preference page</li> |
| |
| <li>Deselect <b>Enable auto activation</b> on the <a class="command-link" href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.jdt.ui.preferences.CodeAssistPreferencePage)")'> |
| <img src="PLUGINS_ROOT/org.eclipse.help/command_link.svg" alt="command link"/> <strong>Java > Editor > Content Assist</strong></a> preference page</li> |
| </ul> |
| |
| <h2>Reading Words in the Java Editor</h2> |
| <p>In order to get correct results when letting the screen reader read words in the Java editor it is recommended to |
| disable <b>Smart caret positioning in Java names</b> on the <a class="command-link" href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.jdt.ui.preferences.JavaEditorPreferencePage)")'> |
| <img src="PLUGINS_ROOT/org.eclipse.help/command_link.svg" alt="command link"/> <strong>Java > Editor</strong></a> preference page.</p> |
| |
| <h2>Reading Java Code in the Java Editor</h2> |
| <p>Some screen readers do not read punctuation by default, however it is useful to hear punctuation when reading code. |
| When using a Java Editor with a screen reader, you can do the following:</p> |
| <ul> |
| <li>JAWS:<br/> |
| <p>JAWS reads most punctuation out of the box, however it does not say commas. To change this:</p> |
| <ul><li><b>Utilities > Configuration Manager</b></li> |
| <li><b>Set Options > Customize Punctuation...</b></li> |
| <li>Select <b>comma</b> in the list, and change the setting from <b>All</b> to <b>Most</b></li> |
| <li><b>OK</b></li> |
| <li><b>File > Save</b> (to save the configuration)</li> |
| <li><b>File > Exit</b> (to exit the JAWS Configuration Manager)</li> |
| </ul></li> |
| <li>NVDA:<ul> |
| <li>NVDA menu (<b>Insert+n</b>) <b>> Preferences > Voice settings...</b>: enable <b>Speak all punctuation</b></li> |
| <li>NVDA menu (<b>Insert+n</b>) <b>> Save configuration</b></li> |
| </ul></li> |
| <li>Orca:<ul> |
| <li><b>Preferences > Speech > Punctuation level: All</b></li> |
| <li><b>OK</b></li> |
| </ul></li> |
| <li>VoiceOver:<br/> |
| <p>VoiceOver reads most punctuation out of the box, however it does not say commas. To change this:</p> |
| <ul><li><b>VoiceOver Utility</b></li> |
| <li><b>Verbosity</b> tab</li> |
| <li><b>Punctuation: All</b></li> |
| </ul></li> |
| <li>Window-Eyes:<ul> |
| <li><b>Global > Menu level</b>: <b>Advanced</b></li> |
| <li><b>Screen > Punctuation</b>: enable <b>Textual</b>, <b>Math</b>, and <b>Miscellaneous</b></li> |
| <li><b>File > Save</b></li> |
| </ul></li> |
| </ul> |
| |
| <p><img src="../../images/ngrelt.png" alt="Related tasks" border="0"/><br/> |
| <a href="accessmain.htm">Accessibility features in Eclipse</a><br/> |
| <a href="navigation.htm">Navigating the user interface by using the keyboard</a> |
| </p> |
| |
| <p><img src="../../images/ngrelr.png" alt="Related references" border="0"/><br/> |
| <a href="../../reference/ref-7.htm">Accessibility preference page</a><br/> |
| <a href="keyboardshortcuts.htm">Keys</a><br/> |
| <a href="fontsandcolors.htm">Font and color settings in Eclipse</a></p> |
| |
| </body> |
| </html> |
