IContentAssistantExtension


1   /*******************************************************************************
2    * Copyright (c) 2000, 2005 IBM Corporation and others.
3    * All rights reserved. This program and the accompanying materials
4    * are made available under the terms of the Eclipse Public License v1.0
5    * which accompanies this distribution, and is available at
6    * http://www.eclipse.org/legal/epl-v10.html
7    *
8    * Contributors:
9    *     IBM Corporation - initial API and implementation
10   *******************************************************************************/
11  package org.eclipse.jface.text.contentassist;
12  
13  
14  /**
15   * Extends {@link org.eclipse.jface.text.contentassist.IContentAssistant}
16   * with the following functions:
17   * <ul>
18   *  <li>handle documents with multiple partitions</li>
19   *  <li>insertion of common completion prefixes</li>
20   * </ul>
21   *
22   * @since 3.0
23   */
24  public interface IContentAssistantExtension {
25  
26      /**
27       * Returns the document partitioning this content assistant is using.
28       *
29       * @return the document partitioning this content assistant is using
30       */
31      String   getDocumentPartitioning();
32  
33      /**
34       * Inserts the common prefix of the available completions. If no common
35       * prefix can be computed it is identical to
36       * {@link IContentAssistant#showPossibleCompletions()}.
37       *
38       * @return an optional error message if no proposals can be computed
39       */
40      String   completePrefix();
41  }
42

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags