/* $Id: WizStepTextField.java 17818 2010-01-12 18:39:46Z linus $

  *****************************************************************************

  * Copyright (c) 2009 Contributors - see below

  * All rights reserved. This program and the accompanying materials

  * are made available under the terms of the Eclipse Public License v1.0

  * which accompanies this distribution, and is available at

  * http://www.eclipse.org/legal/epl-v10.html

  *

  * Contributors:

  *    mvw

  *****************************************************************************

  *

  * Some portions of this file was previously release using the BSD License:

  */

 // Copyright (c) 1996-2007 The Regents of the University of California. All

 // Rights Reserved. Permission to use, copy, modify, and distribute this

 // software and its documentation without fee, and without a written

 // agreement is hereby granted, provided that the above copyright notice

 // and this paragraph appear in all copies.  This software program and

 // documentation are copyrighted by The Regents of the University of

 // California. The software program and documentation are supplied "AS

 // IS", without any accompanying services from The Regents. The Regents

 // does not warrant that the operation of the program will be

 // uninterrupted or error-free. The end-user understands that the program

 // was developed for research purposes and is advised not to rely

 // exclusively on the program for any reason.  IN NO EVENT SHALL THE

 // UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,

 // SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,

 // ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF

 // THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF

 // SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY

 // WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF

 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE

 // PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF

 // CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,

 // UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

 package org.argouml.cognitive.ui;

 import java.awt.GridBagConstraints;

 import java.awt.GridBagLayout;

 import javax.swing.JLabel;

 import javax.swing.JTextArea;

 import javax.swing.JTextField;

 import javax.swing.border.EtchedBorder;

 import org.argouml.cognitive.critics.Wizard;

 import org.argouml.i18n.Translator;

 import org.argouml.swingext.SpacerPanel;

 /**

  * A non-modal wizard step that shows instructions and prompts

  * the user to enter a string.

  *

  * @see org.argouml.cognitive.Critic

  * @see org.argouml.cognitive.critics.Wizard

  */

 public class WizStepTextField extends WizStep {

     private JTextArea instructions = new JTextArea();

     private JLabel label = new JLabel(Translator.localize("label.value"));

     private JTextField field = new JTextField(20);

     /**

      * The constructor. Since this constructor does not set the necessary

      * instructions, textfield label and default value, it is private.

      */

     private WizStepTextField() {

         instructions.setEditable(false);

         instructions.setWrapStyleWord(true);

         instructions.setBorder(null);

         instructions.setBackground(getMainPanel().getBackground());

         getMainPanel().setBorder(new EtchedBorder());

         GridBagLayout gb = new GridBagLayout();

         getMainPanel().setLayout(gb);

         GridBagConstraints c = new GridBagConstraints();

         c.ipadx = 3; c.ipady = 3;

         c.weightx = 0.0; c.weighty = 0.0;

         c.anchor = GridBagConstraints.EAST;

         // TODO: should have an image of a wizard or some logo

         JLabel image = new JLabel("");

         //image.setMargin(new Insets(0, 0, 0, 0));

         image.setIcon(getWizardIcon());

         image.setBorder(null);

         c.gridx = 0;

         c.gridheight = 4;

         c.gridy = 0;

         gb.setConstraints(image, c);

         getMainPanel().add(image);

         c.weightx = 1.0;

         c.gridx = 2;

         c.gridheight = 1;

         c.gridwidth = 3;

         c.gridy = 0;

         c.fill = GridBagConstraints.HORIZONTAL;

         gb.setConstraints(instructions, c);

         getMainPanel().add(instructions);

         c.gridx = 1;

         c.gridy = 1;

         c.weightx = 0.0;

         c.gridwidth = 1;

         c.fill = GridBagConstraints.NONE;

         SpacerPanel spacer = new SpacerPanel();

         gb.setConstraints(spacer, c);

         getMainPanel().add(spacer);

         c.gridx = 2;

         c.gridy = 2;

         c.weightx = 0.0;

         c.gridwidth = 1;

         gb.setConstraints(label, c);

         getMainPanel().add(label);

         c.weightx = 1.0;

         c.fill = GridBagConstraints.HORIZONTAL;

         c.gridx = 3;

         c.gridy = 2;

         gb.setConstraints(field, c);

         getMainPanel().add(field);

         //     c.gridx = 1;

         //     c.gridy = 3;

         //     c.gridheight = GridBagConstraints.REMAINDER;

         //     SpacerPanel spacer2 = new SpacerPanel();

         //     gb.setConstraints(spacer2, c);

         //     _mainPanel.add(spacer2);

         field.getDocument().addDocumentListener(this);

     }

     /**

      * The constructor.

      *

      * @param w the wizard (ignored)

      * @param instr the instructions

      * @param lab the label for the textfield

      * @param val the initial value for the textfield

      */

     public WizStepTextField(Wizard w, String instr, String lab, String val) {

         this();

         // store wizard?

         instructions.setText(instr);

         label.setText(lab);

         field.setText(val);

     }

     /**

      * @return the resulting text

      */

     public String getText() { return field.getText(); }

     /**

      * The UID.

      */

     private static final long serialVersionUID = -4245718254267840545L;

 } /* end class WizStepTextField */