EditorImplementationProvider


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;
21  
22  import java.util.ResourceBundle  ;
23  import javax.swing.Action  ;
24  import javax.swing.text.JTextComponent  ;
25  
26  /** This is provider of implementation. This package (org.netbeans.editor) 
27   * represent editor core which can be used independently on the rest of NetBeans.
28   * However this core needs access to higher level functionality like access
29   * to localized bundles, access to settings storage, etc. which can be implemented
30   * differently by the applications which uses this editor core. For this purpose
31   * was created this abstract class and it can be extended with any other methods which
32   * are more and more often required by core editor. Example implementation
33   * of this provider can be found in org.netbeans.modules.editor package
34   * 
35   * @author David Konecny
36   * @since 10/2001
37   */
38  public interface EditorImplementationProvider {
39  
40      /** Returns ResourceBundle for the given class.*/
41      public ResourceBundle   getResourceBundle(String   localizer);
42  
43      /** This is temporary method which allows core editor to access
44       * glyph gutter action. These actions are then used when user clicks
45       * on glyph gutter. In next version this should be removed and redesigned
46       * as suggested in issue #16762 */
47      public Action  [] getGlyphGutterActions(JTextComponent   target);
48  
49      /** Activates the given component or one of its ancestors.
50       * @return whether the component or one of its ancestors was succesfuly activated
51       * */
52      public boolean activateComponent(JTextComponent   c);
53  }
54
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags