KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > editor > TokenCategory


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;
21
22 /**
23 * Token category enables dividing the tokens into groups.
24 * Each token by default can be contained in zero or one group.
25 * If a coloring for the token can't be found and it has non-null
26 * token-group then the coloring for the group is attempted.
27 *
28 * @author Miloslav Metelka
29 * @version 1.00
30 */
31
32 public interface TokenCategory {
33
34     /** Get the name of the category. */
35     public String JavaDoc getName();
36
37     /** Get the optional numeric identification of this token-category. It can help
38     * to use the category in switch-case statements. It should default to a zero
39     * if no numeric-id should be used.
40     */
41     public int getNumericID();
42
43 }
44
Popular Tags