KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > spi > editor > fold > FoldManagerFactory


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.spi.editor.fold;
21
22 /**
23  * This factory interface allows to produce {@link FoldManager}
24  * instance for the given fold.
25  * <br>
26  * It is intended for xml layer registration
27  * into the following folder in the system FS:
28  * <pre>
29  * Editors/&lt;mime-type&gt;/FoldManager
30  * </pre>
31  * For example java fold manager factories should be registered in
32  * <pre>
33  * Editors/text/x-java/FoldManager
34  * </pre>
35  *
36  * <p>
37  * The factories present in the folder can be sorted by using standard
38  * <a HREF="@org-openide-modules@/org/openide/modules/doc-files/api.html#how-layer">
39  * Layer Ordering</a>.
40  * <br>
41  * The fold manager of factory A registered prior factory B produces
42  * folds with higher priority than those from fold manager of factory B.
43  * <br>
44  * If two folds would overlap the one with higher priority
45  * will be visible - see {@link FoldManager} for more details.
46  *
47  * @author Miloslav Metelka
48  * @version 1.00
49  */
50
51 public interface FoldManagerFactory {
52     
53     /**
54      * Create fold manager instance.
55      */
56     public FoldManager createFoldManager();
57     
58 }
59
Popular Tags