FormatTokenPosition


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.editor.ext;
21  
22  import javax.swing.text.Position  ;
23  import org.netbeans.editor.TokenItem;
24  
25  /**
26  * Position consisting of the token-item
27  * and the offset inside it. The offset can range from zero to the
28  * last character in the token-text. The position right after
29  * the last character in the last token is expressed by token
30  * equal to null and offset equal to zero.
31  * The equality is defined as having the same offset in the same token.
32  * The token is compared just by equality operator.
33  *
34  * @author Miloslav Metelka
35  * @version 1.00
36  */
37  
38  public interface FormatTokenPosition {
39  
40      /** Get the token-item in which the position resides. */
41      public TokenItem getToken();
42  
43      /** Get the offset inside the token-item. */
44      public int getOffset();
45  
46      /** Get the bias of the position. Either Position.Bias.Forward
47       * or Position.Bias.Backward.
48       */
49      public Position.Bias   getBias();
50  
51  }
52
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags