AbbrevExpander


1   /*
2    * The contents of this file are subject to the terms of the Common Development
3    * and Distribution License (the License). You may not use this file except in
4    * compliance with the License.
5    *
6    * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7    * or http://www.netbeans.org/cddl.txt.
8    *
9    * When distributing Covered Code, include this CDDL Header Notice in each file
10   * and include the License file at http://www.netbeans.org/cddl.txt.
11   * If applicable, add the following below the CDDL Header, with the fields
12   * enclosed by brackets [] replaced by your own identifying information:
13   * "Portions Copyrighted [year] [name of copyright owner]"
14   *
15   * The Original Software is NetBeans. The Initial Developer of the Original
16   * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17   * Microsystems, Inc. All Rights Reserved.
18   */
19  
20  package org.netbeans.lib.editor.codetemplates;
21  
22  import javax.swing.text.JTextComponent  ;
23  
24  /**
25   * Abbreviation expander attempts to expand the present typed abbreviation
26   * in the document.
27   *
28   * @author Miloslav Metelka
29   * @version 1.00
30   */
31  
32  public interface AbbrevExpander {
33  
34      /**
35       * Attempt to expand the given abbreviation.
36       * <br/>
37       *
38       * @param component non-null text component in which the abbreviation
39       *  is being typed.
40       * @param abbrevStartOffset &gt;=0 offset where the abbreviation starts
41       *  in the document.
42       * @param abbrev non-null abbreviation that was typed in the text and could
43       *  possibly be expanded.
44       * @return true if the abbreviation was expanded successfully or false
45       *  if the abbreviation was not expanded.
46       */
47      boolean expand(JTextComponent   component, int abbrevStartOffset, CharSequence   abbrevText);
48  
49  }
50
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags