Examples of org.eclipse.jface.text.contentassist.IContentAssistant

org.eclipse.jface.text.contentassist.IContentAssistant

An IContentAssistant provides support on interactive content completion. The content assistant is a {@link org.eclipse.jface.text.ITextViewer} add-on. Itspurpose 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.

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.

In order to provide backward compatibility for clients of IContentAssistant, extension interfaces are used to provide a means of evolution. The following extension interfaces exist:

{@link org.eclipse.jface.text.contentassist.IContentAssistantExtension} since version 3.0 introducingthe following functions:
- handle documents with multiple partitions
- insertion of common completion prefixes
{@link org.eclipse.jface.text.contentassist.IContentAssistantExtension2} since version 3.2 introducingthe following functions:
- repeated invocation (cycling) mode
- completion listeners
- a local status line for the completion popup
- control over the behavior when no proposals are available
{@link org.eclipse.jface.text.contentassist.IContentAssistantExtension3} since version 3.2 introducingthe following function:
- a key-sequence to listen for in repeated invocation mode
{@link org.eclipse.jface.text.contentassist.IContentAssistantExtension4} since version 3.4 introducingthe following function:
- allows to get a handler for the given command identifier

The interface can be implemented by clients. By default, clients use {@link org.eclipse.jface.text.contentassist.ContentAssistant} as the standardimplementer of this interface.

@see org.eclipse.jface.text.ITextViewer @see org.eclipse.jface.text.contentassist.IContentAssistProcessor

    /**
     * Requests proposals in the last location of the given editor.
     */
    protected ICompletionProposal[] requestProposals(String mod1Contents, PyEdit editor) {
        editor.setSelection(mod1Contents.length(), 0);
        IContentAssistant contentAssistant = editor.getEditConfiguration().getContentAssistant(
                editor.getPySourceViewer());
        SimpleAssistProcessor processor = (SimpleAssistProcessor) contentAssistant
                .getContentAssistProcessor(IDocument.DEFAULT_CONTENT_TYPE);
        processor.doCycle(); //we want to show the default completions in this case (not the simple ones)
        ICompletionProposal[] props = processor.computeCompletionProposals(editor.getPySourceViewer(),
                mod1Contents.length());
        return props;


    XtextSourceViewerConfiguration configuration = configurationProvider
        .get();
    ISourceViewer sourceViewer = getSourceViewer(xtextDocument,
        configuration);
    IContentAssistant contentAssistant = configuration
        .getContentAssistant(sourceViewer);
    String contentType;
    try {
      contentType = xtextDocument.getContentType(cursorPosition);
    } catch (BadLocationException e) {
      return new ICompletionProposal[0];
    }
    IContentAssistProcessor processor = contentAssistant
        .getContentAssistProcessor(contentType);
    if (processor != null) {
      return processor.computeCompletionProposals(sourceViewer,
          cursorPosition);
    }

Examples of org.eclipse.jface.text.contentassist.IContentAssistant

Related Classes of org.eclipse.jface.text.contentassist.IContentAssistant