Source for org.jfree.ui.tabbedui.RootPanel

   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:  * RootPanel.java
  29:  * --------------
  30:  * (C)opyright 2004, by Thomas Morgner and Contributors.
  31:  *
  32:  * Original Author:  Thomas Morgner;
  33:  * Contributor(s):   David Gilbert (for Object Refinery Limited);
  34:  *
  35:  * $Id: RootPanel.java,v 1.4 2005/10/18 13:23:37 mungady Exp $
  36:  *
  37:  * Changes
  38:  * -------------------------
  39:  * 16.02.2004 : Initial version
  40:  *
  41:  */
  42: 
  43: package org.jfree.ui.tabbedui;
  44: 
  45: import javax.swing.JComponent;
  46: 
  47: /**
  48:  * A root panel is a panel implementation of an root editor.
  49:  *
  50:  * @author Thomas Morgner
  51:  */
  52: public abstract class RootPanel extends JComponent implements RootEditor {
  53: 
  54:     /**a flag indicating whether this editor is the currently active editor. */
  55:     private boolean active;
  56: 
  57:     /**
  58:      * Default constructor.
  59:      */
  60:     public RootPanel() {
  61:         // nothing required.
  62:     }
  63: 
  64:     /**
  65:      * Returns a flag that indicates whether the panel is active or not.
  66:      * 
  67:      * @return A flag.
  68:      */
  69:     public final boolean isActive() {
  70:         return this.active;
  71:     }
  72: 
  73:     /**
  74:      * Called when the panel is activated.
  75:      */
  76:     protected void panelActivated()
  77:     {
  78:     }
  79: 
  80:     /**
  81:      * Called when the panel is deactivated.
  82:      */
  83:     protected void panelDeactivated()
  84:     {
  85:     }
  86: 
  87:     /**
  88:      * Sets the status of the panel to active or inactive.
  89:      * 
  90:      * @param active  the flag.
  91:      */
  92:     public final void setActive(final boolean active) {
  93:         if (this.active == active) {
  94:             return;
  95:         }
  96:         this.active = active;
  97:         if (active) {
  98:             panelActivated();
  99:         } 
 100:         else {
 101:             panelDeactivated();
 102:         }
 103:     }
 104: 
 105:     /**
 106:      * Returns the main panel. Returns the self reference, as this panel
 107:      * implements all necessary methods.
 108:      *
 109:      * @return The main panel.
 110:      */
 111:     public JComponent getMainPanel() {
 112:         return this;
 113:     }
 114: 
 115:     /**
 116:      * Returns the toolbar. This default implementation return null, to indicate
 117:      * that no toolbar is used.
 118:      *
 119:      * @return The toolbar.
 120:      */
 121:     public JComponent getToolbar() {
 122:         return null;
 123:     }
 124: 
 125: 
 126: }