diff options
Diffstat (limited to 'org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/IContentAssistant.java')
| -rw-r--r-- | org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/IContentAssistant.java | 85 |
1 files changed, 43 insertions, 42 deletions
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/IContentAssistant.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/IContentAssistant.java index 20cd25e394a..f6954cda69f 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/IContentAssistant.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/IContentAssistant.java @@ -17,59 +17,60 @@ import org.eclipse.jface.text.ITextViewer; /** - * An <code>IContentAssistant</code> provides support on interactive content completion. - * The content assistant is a {@link org.eclipse.jface.text.ITextViewer} add-on. Its - * purpose is to propose, display, and insert completions of the content - * of the text viewer's document at the viewer's cursor position. In addition - * to handle completions, a content assistant can also be requested to provide - * context information. Context information is shown in a tool tip like popup. - * As it is not always possible to determine the exact context at a given - * document offset, a content assistant displays the possible contexts and requests - * the user to choose the one whose information should be displayed. + * An <code>IContentAssistant</code> provides support on interactive content completion. The content + * assistant is a {@link org.eclipse.jface.text.ITextViewer} add-on. Its purpose is to propose, + * display, and insert completions of the content of the text viewer's document at the viewer's + * cursor position. In addition to handle completions, a content assistant can also be requested to + * provide context information. Context information is shown in a tool tip like popup. As it is not + * always possible to determine the exact context at a given document offset, a content assistant + * displays the possible contexts and requests the user to choose the one whose information should + * be displayed. * <p> - * A content assistant has a list of {@link org.eclipse.jface.text.contentassist.IContentAssistProcessor} - * objects each of which is registered for a particular document content - * type. The content assistant uses the processors to react on the request - * of completing documents or presenting context information. + * A content assistant has a list of + * {@link org.eclipse.jface.text.contentassist.IContentAssistProcessor} objects each of which is + * registered for a particular document content type. The content assistant uses the processors to + * react on the request of completing documents or presenting context information. * </p> * <p> - * In order to provide backward compatibility for clients of <code>IContentAssistant</code>, extension - * interfaces are used to provide a means of evolution. The following extension interfaces exist: + * In order to provide backward compatibility for clients of <code>IContentAssistant</code>, + * extension interfaces are used to provide a means of evolution. The following extension interfaces + * exist: + * </p> + * <ul> + * <li>{@link org.eclipse.jface.text.contentassist.IContentAssistantExtension} since version 3.0 + * introducing the following functions: * <ul> - * <li>{@link org.eclipse.jface.text.contentassist.IContentAssistantExtension} since version 3.0 introducing - * the following functions: - * <ul> - * <li>handle documents with multiple partitions</li> - * <li>insertion of common completion prefixes</li> - * </ul> + * <li>handle documents with multiple partitions</li> + * <li>insertion of common completion prefixes</li> + * </ul> * </li> - * <li>{@link org.eclipse.jface.text.contentassist.IContentAssistantExtension2} since version 3.2 introducing - * the following functions: - * <ul> - * <li>repeated invocation (cycling) mode</li> - * <li>completion listeners</li> - * <li>a local status line for the completion popup</li> - * <li>control over the behavior when no proposals are available</li> - * </ul> + * <li>{@link org.eclipse.jface.text.contentassist.IContentAssistantExtension2} since version 3.2 + * introducing the following functions: + * <ul> + * <li>repeated invocation (cycling) mode</li> + * <li>completion listeners</li> + * <li>a local status line for the completion popup</li> + * <li>control over the behavior when no proposals are available</li> + * </ul> * </li> - * <li>{@link org.eclipse.jface.text.contentassist.IContentAssistantExtension3} since version 3.2 introducing - * the following function: - * <ul> - * <li>a key-sequence to listen for in repeated invocation mode</li> - * </ul> + * <li>{@link org.eclipse.jface.text.contentassist.IContentAssistantExtension3} since version 3.2 + * introducing the following function: + * <ul> + * <li>a key-sequence to listen for in repeated invocation mode</li> + * </ul> * </li> - * <li>{@link org.eclipse.jface.text.contentassist.IContentAssistantExtension4} since version 3.4 introducing - * the following function: - * <ul> - * <li>allows to get a handler for the given command identifier</li> - * </ul> + * <li>{@link org.eclipse.jface.text.contentassist.IContentAssistantExtension4} since version 3.4 + * introducing the following function: + * <ul> + * <li>allows to get a handler for the given command identifier</li> + * </ul> * </li> * </ul> - * </p> + * * <p> * The interface can be implemented by clients. By default, clients use - * {@link org.eclipse.jface.text.contentassist.ContentAssistant} as the standard - * implementer of this interface. + * {@link org.eclipse.jface.text.contentassist.ContentAssistant} as the standard implementer of this + * interface. * </p> * * @see org.eclipse.jface.text.ITextViewer |