KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > rice > cs > drjava > model > definitions > DefinitionsEditorKit


1 /*BEGIN_COPYRIGHT_BLOCK
2  *
3  * This file is part of DrJava. Download the current version of this project from http://www.drjava.org/
4  * or http://sourceforge.net/projects/drjava/
5  *
6  * DrJava Open Source License
7  *
8  * Copyright (C) 2001-2005 JavaPLT group at Rice University (javaplt@rice.edu). All rights reserved.
9  *
10  * Developed by: Java Programming Languages Team, Rice University, http://www.cs.rice.edu/~javaplt/
11  *
12  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
13  * documentation files (the "Software"), to deal with the Software without restriction, including without limitation
14  * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
15  * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
16  *
17  * - Redistributions of source code must retain the above copyright notice, this list of conditions and the
18  * following disclaimers.
19  * - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
20  * following disclaimers in the documentation and/or other materials provided with the distribution.
21  * - Neither the names of DrJava, the JavaPLT, Rice University, nor the names of its contributors may be used to
22  * endorse or promote products derived from this Software without specific prior written permission.
23  * - Products derived from this software may not be called "DrJava" nor use the term "DrJava" as part of their
24  * names without prior written permission from the JavaPLT group. For permission, write to javaplt@rice.edu.
25  *
26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
27  * THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28  * CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
29  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
30  * WITH THE SOFTWARE.
31  *
32  *END_COPYRIGHT_BLOCK*/
33
34 package edu.rice.cs.drjava.model.definitions;
35
36
37 import javax.swing.text.*;
38 import edu.rice.cs.drjava.model.GlobalEventNotifier;
39 /**
40  * This is an editor kit for editing Java source files.
41  * It functions as the controller in the MVC arrangement.
42  * It implements a factory for new documents, and it also
43  * has a factory for Views (the things that render the document).
44  * @version $Id: DefinitionsEditorKit.java 4035 2006-11-17 15:19:13Z rcartwright $
45  */
46 public class DefinitionsEditorKit extends StyledEditorKit {
47
48   private GlobalEventNotifier _notifier;
49
50   /** Creates a new editor kit with the given listeners.
51    * @param notifier Keeps track of the listeners to the model
52    */
53   public DefinitionsEditorKit(GlobalEventNotifier notifier) { _notifier = notifier; }
54
55   private static ViewFactory _factory = new ViewFactory() {
56     public View create(Element elem) {
57       // The following line is for performance analysis only!
58 // return new WrappedPlainView(elem, true);
59 return new ColoringView(elem);
60     }
61   };
62
63   /** Creates a new DefinitionsDocument. This used to be named createDefaultDocument() so that the view
64    * (DefinitionsPane) would create a DefinitionsDocument by default when it was constructed. However,
65    * we already have an existing DefinitionsDocument we want to use when the DefinitionsPane is constructed,
66    * so this default one was being created and thrown away (very expensive). Ideally, we would have the
67    * DefinitionsPane use our existing document from the beginning, but the JEditorPane constructor does
68    * not take in a Document. The only possible approach would be to have this EditorKit return the desired
69    * existing document when the JEditorPane requests a new one, but since the EditorKit must be kept as a
70    * static field on DefinitionsPane since we can't set one until after JEditorPane's constructor is
71    * finished), there's no clean way to tell the EditorKit which document to return at which time. (It
72    * would require a large synchronization effort each time a DefinitionsPane is constructed.)
73    *
74    * As an easier alternative, we just let the DefaultEditorKit return a PlainDocument (much lighter weight),
75    * which can then be thrown away when the true DefinitionsDocument is assigned.
76    *
77    * Improvements to this approach are welcome... :)
78    */
79   public DefinitionsDocument createNewDocument() { return _createDefaultTypedDocument(); }
80
81   /** Creates a new DefinitionsDocument.
82    * @return a new DefinitionsDocument.
83    */
84   private DefinitionsDocument _createDefaultTypedDocument() { return new DefinitionsDocument(_notifier); }
85
86   /** Get the MIME content type of the document.
87    * @return "text/java"
88    */
89   public String JavaDoc getContentType() { return "text/java"; }
90
91   /** We want to use our ColoringView to render text, so here we return
92    * a factory that creates ColoringViews.
93    */
94   public final ViewFactory getViewFactory() { return _factory; }
95 }
96
97
98
99
100
Popular Tags