Source for org.jfree.ui.tabbedui.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.5 2007/11/02 17:50:37 taqua 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: import javax.swing.JComponent;
  47: import javax.swing.JMenu;
  48: 
  49: /**
  50:  * A root editor reprensents a tab in a TabbedUI.
  51:  *
  52:  * @author Thomas Morgner
  53:  */
  54: public interface RootEditor {
  55: 
  56:     /**
  57:      * Sets the editor active or inactive.
  58:      * 
  59:      * @param b  a boolean.
  60:      */
  61:     public void setActive(boolean b);
  62:   
  63:     /**
  64:      * Returns the active or inactive status of the editor.
  65:      * 
  66:      * @return A boolean.
  67:      */
  68:     public boolean isActive();
  69: 
  70:     /**
  71:      * Returns the editor name.
  72:      * 
  73:      * @return The editor name.
  74:      */
  75:     public String getEditorName();
  76: 
  77:     /**
  78:      * Returns the menus.
  79:      * 
  80:      * @return The menus.
  81:      */
  82:     public JMenu[] getMenus();
  83:     
  84:     /**
  85:      * Returns the toolbar.
  86:      * 
  87:      * @return The toolbar.
  88:      */
  89:     public JComponent getToolbar();
  90: 
  91:     /**
  92:      * Returns the main panel.
  93:      * 
  94:      * @return The main panel.
  95:      */
  96:     public JComponent getMainPanel();
  97: 
  98:     /**
  99:      * Checks, whether this root editor is enabled.
 100:      *
 101:      * @return true, if the editor is enabled, false otherwise.
 102:      */
 103:     public boolean isEnabled();
 104: 
 105:     /**
 106:      * Adds a property change listener.
 107:      * 
 108:      * @param property  the property name.
 109:      * @param l  the listener.
 110:      */
 111:     public void addPropertyChangeListener(String property, PropertyChangeListener l);
 112:     
 113:     /**
 114:      * Removes a property change listener.
 115:      * 
 116:      * @param property  the property name.
 117:      * @param l  the listener.
 118:      */
 119:     public void removePropertyChangeListener(String property, PropertyChangeListener l);
 120: 
 121:     /**
 122:      * Adds a property change listener.
 123:      * 
 124:      * @param l  the listener.
 125:      */
 126:     public void addPropertyChangeListener(PropertyChangeListener l);
 127:     
 128:     /**
 129:      * Removes a property change listener.
 130:      * 
 131:      * @param l  the listener.
 132:      */
 133:     public void removePropertyChangeListener(PropertyChangeListener l);
 134: 
 135: }