RootEditor


1   /* ========================================================================
2    * JCommon : a free general purpose class library for the Java(tm) platform
3    * ========================================================================
4    *
5    * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
6    * 
7    * Project Info:  http://www.jfree.org/jcommon/index.html
8    *
9    * This library is free software; you can redistribute it and/or modify it 
10   * under the terms of the GNU Lesser General Public License as published by 
11   * the Free Software Foundation; either version 2.1 of the License, or 
12   * (at your option) any later version.
13   *
14   * This library is distributed in the hope that it will be useful, but 
15   * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
16   * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
17   * License for more details.
18   *
19   * You should have received a copy of the GNU Lesser General Public
20   * License along with this library; if not, write to the Free Software
21   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
22   * USA.  
23   *
24   * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
25   * in the United States and other countries.]
26   * 
27   * ---------------
28   * RootEditor.java
29   * ---------------
30   * (C) Copyright 2004, by Thomas Morgner and Contributors.
31   *
32   * Original Author:  Thomas Morgner;
33   * Contributor(s):   David Gilbert (for Object Refinery Limited);
34   *
35   * $Id: RootEditor.java,v 1.4 2005/10/18 13:23:37 mungady Exp $
36   *
37   * Changes
38   * -------
39   * 07-Jun-2004 : Added JCommon header (DG);
40   *
41   */
42  
43  package org.jfree.ui.tabbedui;
44  
45  import java.beans.PropertyChangeListener  ;
46  
47  import javax.swing.JComponent  ;
48  import javax.swing.JMenu  ;
49  
50  /**
51   * A root editor reprensents a tab in a TabbedUI.
52   *
53   * @author Thomas Morgner
54   */
55  public interface RootEditor {
56  
57      /**
58       * Sets the editor active or inactive.
59       * 
60       * @param b  a boolean.
61       */
62      public void setActive(boolean b);
63    
64      /**
65       * Returns the active or inactive status of the editor.
66       * 
67       * @return A boolean.
68       */
69      public boolean isActive();
70  
71      /**
72       * Returns the editor name.
73       * 
74       * @return The editor name.
75       */
76      public String   getEditorName();
77  
78      /**
79       * Returns the menus.
80       * 
81       * @return The menus.
82       */
83      public JMenu  [] getMenus();
84      
85      /**
86       * Returns the toolbar.
87       * 
88       * @return The toolbar.
89       */
90      public JComponent   getToolbar();
91  
92      /**
93       * Returns the main panel.
94       * 
95       * @return The main panel.
96       */
97      public JComponent   getMainPanel();
98  
99      /**
100      * Checks, whether this root editor is enabled.
101      *
102      * @return true, if the editor is enabled, false otherwise.
103      */
104     public boolean isEnabled();
105 
106     /**
107      * Adds a property change listener.
108      * 
109      * @param property  the property name.
110      * @param l  the listener.
111      */
112     public void addPropertyChangeListener(String   property, PropertyChangeListener   l);
113     
114     /**
115      * Removes a property change listener.
116      * 
117      * @param property  the property name.
118      * @param l  the listener.
119      */
120     public void removePropertyChangeListener(String   property, PropertyChangeListener   l);
121 
122     /**
123      * Adds a property change listener.
124      * 
125      * @param l  the listener.
126      */
127     public void addPropertyChangeListener(PropertyChangeListener   l);
128     
129     /**
130      * Removes a property change listener.
131      * 
132      * @param l  the listener.
133      */
134     public void removePropertyChangeListener(PropertyChangeListener   l);
135 
136 }
137
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags