textkeyeditor.java

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

/**
 * ========================================
 * 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.
 *
 * ------------------------------
 * TextKeyEditor.java
 * ------------------------------
 * (C)opyright 2003, by Thomas Morgner and Contributors.
 *
 * Original Author:  Thomas Morgner;
 * Contributor(s):   David Gilbert (for Simba Management Limited);
 *
 * $Id: TextKeyEditor.java,v 1.5 2003/11/07 18:33:52 taqua Exp $
 *
 * Changes 
 * -------------------------
 * 31-Aug-2003 : Initial version
 *  
 */

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

import java.awt.BorderLayout;
import java.awt.Dimension;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JTextField;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;

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

/**
 * The text key editor is used to edit a free form text.
 * 
 * @author Thomas Morgner
 */
public class TextKeyEditor extends AbstractKeyEditor
{
  /**
   * An handler class that validates the content whenever a change
   * in the text document occurs.
   *  
   * @author Thomas Morgner
   */
  private class DocumentChangeHandler implements DocumentListener
  {
    /**
     * Default Constructor. 
     */
    public DocumentChangeHandler()
    {
    }

    /**
     * Gives notification that an attribute or set of attributes changed.
     *
     * @param e the document event
     */
    public void changedUpdate(final DocumentEvent e)
    {
      validateContent();
    }

    /**
     * Gives notification that a portion of the document has been
     * removed.  The range is given in terms of what the view last
     * saw (that is, before updating sticky positions).
     *
     * @param e the document event
     */
    public void removeUpdate(final DocumentEvent e)
    {
      validateContent();
    }

    /**
     * Gives notification that there was an insert into the document.  The
     * range given by the DocumentEvent bounds the freshly inserted region.
     *
     * @param e the document event
     */
    public void insertUpdate(final DocumentEvent e)
    {
      validateContent();
    }
  }

  /** The editor component for the key content. */
  private final JTextField content;
  /** the label that names the content. */
  private final JLabel entryLabel;
  /** a carrier component that acts as content pane. */
  private final JPanel entryLabelCarrier;

  /**
   * Creates a new text key editor for the given configuration and description
   * entry. The given display name will be used as label text.
   * 
   * @param config the report configuration from where to read the configuration
   * values.
   * @param entry the entry description supplies the meta data.
   * @param displayName the label content.
   */
  public TextKeyEditor(final ReportConfiguration config, 
                       final ConfigDescriptionEntry entry, 
                       final String displayName)
  {
    super(config, entry);

    final JPanel contentPane = new JPanel();
    contentPane.setLayout(new BorderLayout(5,0));
    entryLabel = new JLabel (displayName);
    entryLabel.setToolTipText(entry.getDescription());

    entryLabelCarrier = new JPanel();
    entryLabelCarrier.setLayout(new BorderLayout());
    entryLabelCarrier.add(entryLabel);
    contentPane.add (entryLabelCarrier, BorderLayout.WEST);

    content = new JTextField();
    content.getDocument().addDocumentListener(new DocumentChangeHandler());

    contentPane.add (content, BorderLayout.CENTER);
    setContentPane(contentPane);
    reset();
  }

  /**
   * This method validates the content of the text field. In this implementation
   * no validation is done and all text is accepted.
   *
   */
  public void validateContent ()
  {
    setValidInput(true);
  }

  /**
   * Resets the value to the defaults from the report configuration. 
   * @see org.jfree.report.modules.gui.config.editor.KeyEditor#reset()
   */
  public void reset()
  {
    content.setText(loadValue());
  }

  /**
   * Stores the input as new value for the report configuration. This method
   * does nothing, if the content is not valid. 
   * @see org.jfree.report.modules.gui.config.editor.KeyEditor#store()
   */
  public void store()
  {
    if (isValidInput())
    {
      if (isEnabled())
      {
        storeValue(content.getText());
      }
      else
      {
        deleteValue();
      }
    }
  }

  /**
   * Returns the content from the input field.
   * @return the input field text.
   */
  public String getContent()
  {
    return content.getText();
  }

  /**
   * Sets whether or not this component is enabled.
   * A component which is enabled may respond to user input,
   * while a component which is not enabled cannot respond to
   * user input.  Some components may alter their visual
   * representation when they are disabled in order to
   * provide feedback to the user that they cannot take input.
   *
   * @see java.awt.Component#isEnabled
   * @param enabled defines, whether this editor will be enabled.
   */
  public void setEnabled(final boolean enabled)
  {
    super.setEnabled(enabled);
    content.setEnabled(enabled);
  }

  /**
   * Defines the preferred width of the label. 
   * @see org.jfree.report.modules.gui.config.editor.KeyEditor#setLabelWidth(int)
   * 
   * @param width the new preferred width.
   */
  public void setLabelWidth(final int width)
  {
    final Dimension prefSize = entryLabel.getPreferredSize();
    entryLabelCarrier.setPreferredSize(new Dimension(width, prefSize.height));
  }

  /**
   * Returns the preferred width of the label. 
   * @see org.jfree.report.modules.gui.config.editor.KeyEditor#getLabelWidth()
   * 
   * @return the preferred width.
   */
  public int getLabelWidth()
  {
    final Dimension prefSize = entryLabel.getPreferredSize();
    if (prefSize != null)
    {
      return prefSize.width;
    }
    return 0;
  }
}