View Javadoc

1   /***
2    * Redistribution and use of this software and associated documentation
3    * ("Software"), with or without modification, are permitted provided
4    * that the following conditions are met:
5    *
6    * 1. Redistributions of source code must retain copyright
7    *    statements and notices.  Redistributions must also contain a
8    *    copy of this document.
9    *
10   * 2. Redistributions in binary form must reproduce the
11   *    above copyright notice, this list of conditions and the
12   *    following disclaimer in the documentation and/or other
13   *    materials provided with the distribution.
14   *
15   * 3. The name "Exolab" must not be used to endorse or promote
16   *    products derived from this Software without prior written
17   *    permission of Exoffice Technologies.  For written permission,
18   *    please contact info@exolab.org.
19   *
20   * 4. Products derived from this Software may not be called "Exolab"
21   *    nor may "Exolab" appear in their names without prior written
22   *    permission of Exoffice Technologies. Exolab is a registered
23   *    trademark of Exoffice Technologies.
24   *
25   * 5. Due credit should be given to the Exolab Project
26   *    (http://www.exolab.org/).
27   *
28   * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29   * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30   * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
32   * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33   * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39   * OF THE POSSIBILITY OF SUCH DAMAGE.
40   *
41   * Copyright 2000 (C) Exoffice Technologies Inc. All Rights Reserved.
42   *
43   * $Id: BaseDialog.java,v 1.1 2004/11/26 01:51:15 tanderson Exp $
44   *
45   * Date         Author  Changes
46   * $Date	    jimm    Created
47   */
48  
49  package org.exolab.jms.tools.admin;
50  
51  import java.awt.event.WindowEvent;
52  
53  import javax.swing.JDialog;
54  import javax.swing.JFrame;
55  import javax.swing.JOptionPane;
56  import javax.swing.JTextField;
57  
58  
59  /***
60   * A simple dialog to collect information for creating queue/topics and
61   * consumers.
62   *
63   * <P>For consumers only a name is needed.
64   *
65   * <P>For queue/topics a name and a simple radio button to select if this
66   * queue/topic is a Queue or a topic.
67   *
68   *
69   * @version     $Revision: 1.1 $ $Date: 2004/11/26 01:51:15 $
70   * @author      <a href="mailto:mourikis@exolab.org">Jim Mourikis</a>
71   * @see         AdminMgr
72   */
73  abstract public class BaseDialog extends JDialog {
74  
75      // The name chosen for this object
76      protected String name_;
77  
78      // shared gui fields
79      protected JTextField displayText;
80  
81      // The two possible states of theis dialog.
82      final static public int CANCELED = 1;
83      final static public int CONFIRMED = 2;
84  
85      // The command status used to shutdown this window.
86      protected int status_;
87  
88  
89      /***
90       * Creates new form BaseDialog
91       *
92       * @param parent The parent form.
93       */
94      BaseDialog(JFrame parent) {
95          super(parent, true);
96          initComponents();
97          pack();
98      }
99  
100     /***
101      * Create all the gui components that comprise this form, and setup all
102      * action handlers.
103      */
104     protected abstract void initComponents();
105 
106     /***
107      *	Closes the dialog
108      *
109      * @param evt the window event that triggered this call.
110      *
111      */
112     protected void closeDialog(WindowEvent evt) {
113         setVisible(false);
114         dispose();
115     }
116 
117     /***
118      * Whether this dialog was confirmed or canceled.
119      *
120      * @return boolena true if the OK button was pressed.
121      *
122      */
123     public boolean isConfirmed() {
124         return status_ == CONFIRMED;
125     }
126 
127     /***
128      * Get the name selected for this queue/topic or consumer.
129      *
130      * @return String The name entered by the user
131      */
132     public String getName() {
133         return name_;
134     }
135 
136     /***
137      * The OK button was pressed. Get the name and confirm its not null.
138      * if it is null or empty display an error dialog.
139      *
140      * if a name was entered, get and store the name and the queue or topic
141      * selection, close the dialog and record that OK was pressed.
142      *
143      */
144     protected void confirm() {
145         name_ = displayText.getText();
146 
147         if (name_ == null || name_.equals("")) {
148             JOptionPane.showMessageDialog
149                 (this, "A name must be suplied", "Create Error",
150                     JOptionPane.ERROR_MESSAGE);
151         } else {
152             status_ = CONFIRMED;
153             setVisible(false);
154             dispose();
155         }
156     }
157 
158     /***
159      * The cancel button was pressed. Close the GUI, and recored that cancel
160      * was pressed.
161      *
162      */
163     protected void cancel() {
164         status_ = CANCELED;
165         setVisible(false);
166         dispose();
167     }
168 
169 } // End BaseDialog