KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > util > explorer > swing > gui > api > DialogBox


1 /*====================================================================
2
3 Objectweb Explorer Framework
4 Copyright (C) 2000-2004 INRIA - USTL - LIFL - GOAL
5 Contact: openccm@objectweb.org
6
7 This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Lesser General Public
9 License as published by the Free Software Foundation; either
10 version 2.1 of the License, or any later version.
11
12 This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Lesser General Public License for more details.
16
17 You should have received a copy of the GNU Lesser General Public
18 License along with this library; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 USA
21
22 Initial developer(s): Jerome Moroy, Philippe Merle.
23 Contributor(s): ______________________________________.
24
25 ====================================================================*/
26
27 package org.objectweb.util.explorer.swing.gui.api;
28
29 /** The Java API's imports */
30 import javax.swing.JDialog JavaDoc;
31
32 /**
33  * Allows to add some elements into a dialog frame.
34  *
35  * @author <a HREF="mailto:Jerome.Moroy@lifl.fr">Jerome Moroy</a>
36  *
37  * @version 0.1
38  */
39 public interface DialogBox {
40
41     /**
42      * Adds an element into the current JDialog without being concerned about the display.
43      * @param box The element to add.
44      */
45     public void addElementBox(ElementBox box);
46     
47     /**
48      * Returns the JDialog contains by the DialogBox.
49      * @return The JDialog contains by the DialogBox.
50      */
51     public JDialog JavaDoc getJDialog();
52     
53     /**
54      * Shows the dialog box.
55      */
56     public void show();
57     
58     /**
59      * Hides the dialog box.
60      */
61     public void hide();
62     
63     /**
64      * Fixes the action to use for the validate button
65      * @param action The action to use.
66      */
67     public void setValidateAction(DialogAction action);
68
69     /**
70      * Fixes the label of the validate button (default value is "OK").
71      * @param label The label of the validate button
72      */
73     public void setValidateLabel(String JavaDoc label);
74     
75     /**
76      * Fixes the action to use for the cancel button
77      * @param action The action to use.
78      */
79     public void setCancelAction(DialogAction action);
80     
81     /**
82      * Fixes the label of the cancel button (default value is "Cancel").
83      * @param label The label of the cancel button
84      */
85     public void setCancelLabel(String JavaDoc label);
86
87     /**
88      * Validates all the elements contains by the JDialog.
89      * @return The corresponding ValidateReport.
90      */
91     public ValidateReport validateDialog();
92
93 }
Popular Tags