abstractkeyeditor.java

来自「swing编写的库存管理程序。毕业设计类」· Java 代码 · 共 253 行

/**
 * ========================================
 * JFreeReport : a free Java report library
 * ========================================
 *
 * Project Info:  http://www.jfree.org/jfreereport/index.html
 * Project Lead:  Thomas Morgner ([e-mail]);
 *
 * (C) Copyright 2000-2003, by Simba Management Limited and Contributors.
 *
 * This library is free software; you can redistribute it and/or modify it under the terms
 * of the GNU Lesser General Public License as published by the Free Software Foundation;
 * either version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this
 * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * ------------------------------
 * AbstractKeyEditor.java
 * ------------------------------
 * (C)opyright 2003, by Thomas Morgner and Contributors.
 *
 * Original Author:  Thomas Morgner;
 * Contributor(s):   David Gilbert (for Simba Management Limited);
 *
 * $Id: AbstractKeyEditor.java,v 1.5 2003/11/07 18:33:51 taqua Exp $
 *
 * Changes 
 * -------------------------
 * 31-Aug-2003 : Initial version
 *  
 */

package org.jfree.report.modules.gui.config.editor;

import java.awt.BorderLayout;
import java.util.ResourceBundle;
import javax.swing.Icon;
import javax.swing.JComponent;
import javax.swing.JLabel;
import javax.swing.JPanel;

import org.jfree.report.modules.gui.config.model.ConfigDescriptionEntry;
import org.jfree.report.modules.gui.config.resources.ConfigResources;
import org.jfree.report.util.ImageUtils;
import org.jfree.report.util.ReportConfiguration;

/**
 * This key editor class is the base class for all key editor components.
 * It provides common services usable for most key editor implementation. 
 * 
 * @author Thomas Morgner
 */
public abstract class AbstractKeyEditor extends JComponent implements KeyEditor
{
  /** The name of the resource bundle implementation used to translate texts. */
  private static final String RESOURCE_BUNDLE =
      ConfigResources.class.getName();
  /** A constant for the "validInput" property name. */
  public static final String VALID_INPUT_PROPERTY = "validInput";

  /** The error icon used for the key editors. */
  private static Icon errorIcon;
  /** The empty icon used for the key editors. */
  private static Icon emptyIcon;

  /** The report configuration that provides the values for this editor. */
  private final ReportConfiguration config;
  /** The config description entry that provides the definition for this key. */
  private final ConfigDescriptionEntry entry;
  /** A flag indicating whether the input is valid. */
  private boolean validInput;
  /** A label that holds the error indicator icons. */
  private final JLabel stateLabel;
  /** the resource bundle instance used to translate the text. */
  private final ResourceBundle resources;

  /**
   * Creates a new key editor for the given report configuration and key
   * entry. 
   * 
   * @param config the report configuration that supplies the value for the editor
   * @param entry the entry description provides the meta data for the edited key.
   */
  public AbstractKeyEditor (final ReportConfiguration config, final ConfigDescriptionEntry entry)
  {
    this.resources = ResourceBundle.getBundle(RESOURCE_BUNDLE);
    this.setLayout(new BorderLayout());
    this.config = config;
    this.entry = entry;
    stateLabel = new JLabel(getEmptyIcon());
  }

  /**
   * Returns the empty icon for this an all derived editors.
   * 
   * @return the empty icon.
   */
  protected Icon getEmptyIcon ()
  {
    if (emptyIcon == null)
    {
      final Icon errorIcon = getErrorIcon();
      final int width = errorIcon.getIconWidth();
      final int height = errorIcon.getIconHeight();
      emptyIcon = ImageUtils.createTransparentIcon(width, height);
    }
    return emptyIcon;
  }

  /**
   * Returns the error icon for this an all derived editors.
   * 
   * @return the error icon.
   */
  protected Icon getErrorIcon ()
  {
    if (errorIcon == null)
    {
      errorIcon = (Icon) resources.getObject("default-editor.error-icon");
    }
    return errorIcon;
  }

  /**
   * Defines the content pane for this editor. 
   * 
   * @param contentPane the new content pane
   */
  protected void setContentPane(final JPanel contentPane)
  {
    removeAll();
    add (contentPane, BorderLayout.CENTER);
    add (stateLabel, BorderLayout.EAST);
  }

  /**
   * Returns the report configuration instance used for this editor.
   * 
   * @return the report configuration instance of this editor.
   */
  public ReportConfiguration getConfig()
  {
    return config;
  }

  /**
   * Returns the config description entry of this editor. 
   * 
   * @return the config description entry.
   */
  public ConfigDescriptionEntry getEntry()
  {
    return entry;
  }

  /**
   * Loads the value from the configuration.
   * 
   * @return the value of the edited key from the configuration.
   */
  protected String loadValue ()
  {
    return config.getConfigProperty(entry.getKeyName());
  }
  
  /**
   * Stores the value to the configuration.
   * 
   * @param o the new value for the key of the editor.
   */
  protected void storeValue (final String o)
  {
    config.setConfigProperty(entry.getKeyName(), o);
  }

  /**
   * Removes the value from the configuration; the configuration
   * will fall back to the default value from the global configuration.
   * <p>  
   * Deleting the value triggers the <code>isDefined</code> property.
   */
  protected void deleteValue ()
  {
    config.setConfigProperty(entry.getKeyName(), null);
  }

  /**
   * Returns true, if the component validated the entered values, false
   * otherwise.
   * 
   * @return true, if the input is valid, false otherwise.
   */
  public boolean isValidInput()
  {
    return validInput;
  }

  /**
   * Defines, whether the input is valid. This should be called after
   * the value of the component changed.
   *  
   * @param validInput true, if the input should be considered valid,
   * false otherwise.
   */
  protected void setValidInput(final boolean validInput)
  {
    if (this.validInput != validInput)
    {
      final boolean oldValue = this.validInput;
      this.validInput = validInput;
      firePropertyChange(VALID_INPUT_PROPERTY, oldValue, validInput);
      if (this.validInput == false)
      {
        stateLabel.setIcon(getErrorIcon());
      }
      else
      {
        stateLabel.setIcon(getEmptyIcon());
      }
    }
  }

  /**
   * Checks, whether the local key has a defined value in the local
   * report configuration.   
   * @see org.jfree.report.modules.gui.config.editor.KeyEditor#isDefined()
   * 
   * @return true, if the key is defined, false otherwise.
   */
  public boolean isDefined ()
  {
    return config.isLocallyDefined(entry.getKeyName());
  }

  /**
   * Returns the editor component; this implementation returns the "this"
   * reference. 
   * @see org.jfree.report.modules.gui.config.editor.KeyEditor#getComponent()
   * 
   * @return a reference to this object.
   */
  public JComponent getComponent()
  {
    return this;
  }
}