util.paramhandler.ParamInputField.java Source code

Java tutorial

Introduction

Here is the source code for util.paramhandler.ParamInputField.java

Source

/*
 * CapturePlugin by Andreas Hessel (Vidrec@gmx.de), Bodo Tasche
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * CVS information:
 *  $RCSfile$
 *   $Source$
 *     $Date: 2010-08-26 22:01:52 +0200 (Thu, 26 Aug 2010) $
 *   $Author: ds10 $
 * $Revision: 6720 $
 */
package util.paramhandler;

import java.awt.Window;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.FocusListener;
import java.awt.event.KeyAdapter;
import java.awt.event.KeyEvent;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

import javax.swing.JButton;
import javax.swing.JComboBox;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTextArea;
import javax.swing.ScrollPaneConstants;
import javax.swing.SwingUtilities;
import javax.swing.text.BadLocationException;

import util.ui.Localizer;
import util.ui.UiUtilities;

import com.jgoodies.forms.layout.CellConstraints;
import com.jgoodies.forms.layout.FormLayout;

/**
 * This Class represents a Default-Input-Field for Parameters
 * it contains a Help and a Check-Button
 * 
 * @author bodum
 *
 */
public class ParamInputField extends JPanel {

    /** Translator */
    private static final Localizer mLocalizer = Localizer.getLocalizerFor(ParamInputField.class);

    /** Text-Area for the Parameters in the EMail-Body*/
    private JTextArea mParamText;

    /** The Library to use for Check/Help-Dialog */
    private ParamLibrary mParamLibrary;

    /**
     * Create the InputField
     * @param text Text to show in the InputField
     */
    public ParamInputField(String text) {
        this(text, false);
    }

    /**
     * Create the InputField
     * @param text Text to show in the InputField
     * @param singleLine set True, if Input-Field should be a Single-Line
     */
    public ParamInputField(String text, boolean singleLine) {
        this(new ParamLibrary(), text, singleLine);
    }

    /**
     * Create the InputField
     * @param library Library to use in the Check/Help Dialogs
     * @param text Text to show in the InputField
     */
    public ParamInputField(ParamLibrary library, String text) {
        this(library, text, false);
    }

    /**
     * Create the InputField
     * @param library Library to use in the Check/Help Dialogs
     * @param text Text to show in the InputField
     * @param singleLine set True, if Input-Field should be a Single-Line
     */
    public ParamInputField(ParamLibrary library, String text, boolean singleLine) {
        mParamLibrary = library;
        if (mParamLibrary == null) {
            mParamLibrary = new ParamLibrary();
        }
        createGui(text, singleLine);
    }

    /**
     * Create the GUI
     * @param text Text to use in the InputField
     * @param singleLine set True, if Input-Field should be a Single-Line
     */
    private void createGui(String text, boolean singleLine) {
        FormLayout layout = new FormLayout("fill:pref:grow, 3dlu, default, 3dlu, default, 3dlu, default",
                "fill:pref:grow, 3dlu, default");
        setLayout(layout);

        CellConstraints cc = new CellConstraints();

        mParamText = new JTextArea();
        mParamText.setText(text);

        if (singleLine) {
            mParamText.addKeyListener(new KeyAdapter() {

                public void keyPressed(KeyEvent ke) {
                    if (ke.getKeyCode() == KeyEvent.VK_ENTER) {
                        ke.consume();
                    }
                }
            });

            JScrollPane scroll = new JScrollPane(mParamText, ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED,
                    ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER);

            add(scroll, cc.xyw(1, 1, layout.getColumnCount()));
        } else {
            mParamText.setLineWrap(true);
            add(new JScrollPane(mParamText), cc.xyw(1, 1, layout.getColumnCount()));
        }

        ArrayList<String> items = new ArrayList<String>();
        items.add(mLocalizer.msg("insert", "Insert"));
        List<String> functions = Arrays.asList(mParamLibrary.getPossibleFunctions());
        Collections.sort(functions);
        for (String function : functions) {
            items.add(function + "()");
        }
        List<String> keys = Arrays.asList(mParamLibrary.getPossibleKeys());
        Collections.sort(keys);
        for (String key : keys) {
            items.add(key);
        }
        final JComboBox insert = new JComboBox(items.toArray(new String[items.size()]));
        add(insert, cc.xy(layout.getColumnCount() - 4, 3));
        insert.addActionListener(new ActionListener() {

            @Override
            public void actionPerformed(ActionEvent e) {
                if (insert.getSelectedIndex() > 0) {
                    // find out whether to insert with braces or not
                    boolean inFunction = false;
                    String newText = insert.getSelectedItem().toString();
                    int selStart = mParamText.getSelectionStart();
                    if (selStart > 0) {
                        try {
                            if (mParamText.getText(selStart - 1, 1).equals("(")) {
                                inFunction = true;
                            }
                        } catch (BadLocationException e1) {
                            e1.printStackTrace();
                        }
                    }
                    int selEnd = mParamText.getSelectionEnd();
                    if (selEnd < mParamText.getText().length()) {
                        try {
                            if (mParamText.getText(selEnd + 1, 1).equals(")")) {
                                inFunction = true;
                            }
                        } catch (BadLocationException e1) {
                            e1.printStackTrace();
                        }
                    }
                    if (!inFunction) {
                        newText = "{" + newText + "}";
                    }
                    mParamText.insert(newText, selStart);
                    // reposition cursor if this was a function itself
                    int lastBrace = newText.lastIndexOf(')');
                    if (lastBrace > 0) {
                        if (newText.length() - lastBrace <= 2) {
                            mParamText.setCaretPosition(
                                    mParamText.getSelectionStart() - (newText.length() - lastBrace));
                        }
                    }

                    mParamText.requestFocus();
                }
            }
        });

        JButton check = new JButton(mLocalizer.msg("check", "Check"));
        check.addActionListener(new ActionListener() {

            public void actionPerformed(ActionEvent arg0) {
                Window bestparent = UiUtilities.getBestDialogParent(ParamInputField.this);
                ParamCheckDialog dialog = new ParamCheckDialog(bestparent, mParamLibrary, mParamText.getText());
                dialog.setVisible(true);
            }

        });

        add(check, cc.xy(layout.getColumnCount() - 2, 3));

        JButton help = new JButton(Localizer.getLocalization(Localizer.I18N_HELP));
        help.addActionListener(new ActionListener() {

            public void actionPerformed(ActionEvent arg0) {
                Window bestparent = UiUtilities.getBestDialogParent(ParamInputField.this);
                ParamHelpDialog dialog = new ParamHelpDialog(bestparent, mParamLibrary);
                dialog.setVisible(true);
            }

        });

        add(help, cc.xy(layout.getColumnCount(), 3));
    }

    /**
     * Get the Text in the InputField
     * @return Text in the InputField
     */
    public String getText() {
        return mParamText.getText();
    }

    /**
     * Set the Text in the InputField
     * @param text new Text in the InputField
     */
    public void setText(String text) {
        mParamText.setText(text);
    }

    /**
     * Returns the Text in the InputField
     * @return Text in the InputField
     */
    public String toString() {
        return getText();
    }

    public void addFocusListener(FocusListener listener) {
        mParamText.addFocusListener(listener);
    }
}