alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

What this is

This file is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Other links

The source code

// $Header: /home/cvs/jakarta-jmeter/src/core/org/apache/jmeter/gui/util/TextAreaTableCellEditor.java,v 1.7 2004/02/14 03:34:29 sebb Exp $
/*
 * Copyright 2001-2004 The Apache Software Foundation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
*/

package org.apache.jmeter.gui.util;

import java.awt.Component;
import java.awt.event.ActionEvent;
import java.awt.event.FocusEvent;
import java.awt.event.FocusListener;
import java.awt.event.ItemEvent;
import java.awt.event.MouseEvent;
import java.io.Serializable;
import java.util.EventObject;

import javax.swing.AbstractCellEditor;
import javax.swing.JScrollPane;
import javax.swing.JTable;
import javax.swing.JTextArea;
import javax.swing.JTree;
import javax.swing.table.TableCellEditor;
import javax.swing.tree.TreeCellEditor;

/**
 * @author mstover
 * @version $Revision: 1.7 $
 */
public class TextAreaTableCellEditor
    extends AbstractCellEditor
    implements TableCellEditor, TreeCellEditor
{
    //
    //Instance Variables
    //

    /** The Swing component being edited. */
    protected JTextArea editorComponent;
    
    /**
     * The delegate class which handles all methods sent from the
     * CellEditor.
     */
    protected EditorDelegate delegate;
    
    /**
     * An integer specifying the number of clicks needed to start editing.
     * Even if clickCountToStart is defined as zero, it
     * will not initiate until a click occurs.
     */
    protected int clickCountToStart = 1;

    //
    //Constructors
    //

    /**
     * Constructs a TableCellEditor that uses a text field.
     */
    public TextAreaTableCellEditor()
    {
        editorComponent = new JTextArea();
        editorComponent.setRows(3);
        this.clickCountToStart = 2;
        delegate = new EditorDelegate()
        {
            public void setValue(Object value)
            {
                editorComponent.setText(
                    (value != null) ? value.toString() : "");
            }

            public Object getCellEditorValue()
            {
                return editorComponent.getText();
            }
        };
        editorComponent.addFocusListener(delegate);
    }

    /**
     * Returns a reference to the editor component.
     *
     * @return the editor Component
     */
    public Component getComponent()
    {
        return editorComponent;
    }

    //
    //Modifying
    //

    /**
     * Specifies the number of clicks needed to start editing.
     *
     * @param count  an int specifying the number of clicks needed to start
     *               editing
     * @see #getClickCountToStart
     */
    public void setClickCountToStart(int count)
    {
        clickCountToStart = count;
    }

    /**
     * Returns the number of clicks needed to start editing.
     * @return the number of clicks needed to start editing
     */
    public int getClickCountToStart()
    {
        return clickCountToStart;
    }

    //
    //Override the implementations of the superclass, forwarding all methods 
    //from the CellEditor interface to our delegate. 
    //

    /**
     * Forwards the message from the CellEditor to
     * the delegate.
     * @see EditorDelegate#getCellEditorValue
     */
    public Object getCellEditorValue()
    {
        return delegate.getCellEditorValue();
    }

    /**
     * Forwards the message from the CellEditor to
     * the delegate.
     * @see EditorDelegate#isCellEditable(EventObject)
     */
    public boolean isCellEditable(EventObject anEvent)
    {
        return delegate.isCellEditable(anEvent);
    }

    /**
     * Forwards the message from the CellEditor to
     * the delegate.
     * @see EditorDelegate#shouldSelectCell(EventObject)
     */
    public boolean shouldSelectCell(EventObject anEvent)
    {
        return delegate.shouldSelectCell(anEvent);
    }

    /**
     * Forwards the message from the CellEditor to
     * the delegate.
     * @see EditorDelegate#stopCellEditing
     */
    public boolean stopCellEditing()
    {
        return delegate.stopCellEditing();
    }

    /**
     * Forwards the message from the CellEditor to
     * the delegate.
     * @see EditorDelegate#cancelCellEditing
     */
    public void cancelCellEditing()
    {
        delegate.cancelCellEditing();
    }

    //
    //Implementing the TreeCellEditor Interface
    //

    /** Implements the TreeCellEditor interface. */
    public Component getTreeCellEditorComponent(
        JTree tree,
        Object value,
        boolean isSelected,
        boolean expanded,
        boolean leaf,
        int row)
    {
        String stringValue =
            tree.convertValueToText(
                value,
                isSelected,
                expanded,
                leaf,
                row,
                false);

        delegate.setValue(stringValue);
        return new JScrollPane(editorComponent);
    }

    //
    //Implementing the CellEditor Interface
    //
    /** Implements the TableCellEditor interface. */
    public Component getTableCellEditorComponent(
        JTable table,
        Object value,
        boolean isSelected,
        int row,
        int column)
    {
        delegate.setValue(value);
        return new JScrollPane(editorComponent);
    }

    //
    //Protected EditorDelegate class
    //

    /**
     * The protected EditorDelegate class.
     */
    protected class EditorDelegate implements FocusListener, Serializable
    {
        /**  The value of this cell. */
        protected Object value;

        /**
         * Returns the value of this cell. 
         * @return the value of this cell
         */
        public Object getCellEditorValue()
        {
            return value;
        }

        /**
         * Sets the value of this cell. 
         * @param value the new value of this cell
         */
        public void setValue(Object value)
        {
            this.value = value;
        }

        /**
         * Returns true if anEvent is not a
         * MouseEvent.  Otherwise, it returns true
         * if the necessary number of clicks have occurred, and
         * returns false otherwise.
         *
         * @param   anEvent         the event
         * @return  true  if cell is ready for editing, false otherwise
         * @see #setClickCountToStart
         * @see #shouldSelectCell
         */
        public boolean isCellEditable(EventObject anEvent)
        {
            if (anEvent instanceof MouseEvent)
            {
                return ((MouseEvent) anEvent).getClickCount()
                    >= clickCountToStart;
            }
            return true;
        }

        /**
         * Returns true to indicate that the editing cell may
         * be selected.
         *
         * @param   anEvent         the event
         * @return  true 
         * @see #isCellEditable
         */
        public boolean shouldSelectCell(EventObject anEvent)
        {
            return true;
        }

        /**
         * Returns true to indicate that editing has begun.
         *
         * @param anEvent          the event
         */
        public boolean startCellEditing(EventObject anEvent)
        {
            return true;
        }

        /**
         * Stops editing and
         * returns true to indicate that editing has stopped.
         * This method calls fireEditingStopped.
         *
         * @return  true 
         */
        public boolean stopCellEditing()
        {
            fireEditingStopped();
            return true;
        }

        /**
         * Cancels editing.  This method calls fireEditingCanceled.
         */
        public void cancelCellEditing()
        {
            fireEditingCanceled();
        }

        /**
         * When an action is performed, editing is ended.
         * @param e the action event
         * @see #stopCellEditing
         */
        public void actionPerformed(ActionEvent e)
        {
            TextAreaTableCellEditor.this.stopCellEditing();
        }

        /**
         * When an item's state changes, editing is ended.
         * @param e the action event
         * @see #stopCellEditing
         */
        public void itemStateChanged(ItemEvent e)
        {
            TextAreaTableCellEditor.this.stopCellEditing();
        }
        public void focusLost(FocusEvent ev)
        {
            TextAreaTableCellEditor.this.stopCellEditing();
        }

        public void focusGained(FocusEvent ev)
        {
        }
    }
}
... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.